@verdaccio/ui-components
Namespaces
Enumerations
Classes
Component Functions
- ActionBar
- AppConfigurationProvider
- Author
- CopyClipboard
- Dependencies
- Deprecated
- Detail
- Developers
- Distribution
- Engines
- Footer
- Forbidden
- FundButton
- Header
- HeaderInfoDialog
- Heading
- Help
- Home
- Install
- Keywords
- Label
- Link
- LinkExternal
- Loading
- LoginDialog
- Logo
- MenuItem
- NotFound
- Package
- PackageList
- PersistenceSettingProvider
- Person
- RawViewer
- Readme
- SideBar
- SideBarTitle
- StyleBaseline
- TextField
- ThemeProvider
- UpLinks
- VersionLayout
- Versions
- copyToClipBoardUtility
- getCLIChangePassword
- getCLISBerryYamlRegistry
- getCLISetConfigRegistry
- getCLISetRegistry
- isTokenExpire
- useConfig
- useCustomTheme
- useLanguage
- useVersion
Provider Functions
HOC Functions
Hooks Functions
Type Aliases
Dispatch
Ƭ Dispatch: RematchDispatch<RootModel>
Defined in
packages/ui-components/src/store/store.ts:14
FontWeight
Ƭ FontWeight: keyof typeof fontWeight
Defined in
packages/ui-components/src/Theme/theme.ts:74
LanguageItem
Ƭ LanguageItem: Object
Type declaration
| Name | Type |
|---|---|
icon | any |
lng | string |
menuKey | string |
Defined in
packages/ui-components/src/providers/TranslatorProvider/TranslatorProvider.tsx:13
LoginBody
Ƭ LoginBody: { error?: LoginError } & LoginResponse
Defined in
packages/ui-components/src/store/models/login.ts:25
LoginError
Ƭ LoginError: Object
Type declaration
| Name | Type |
|---|---|
description | string |
type | string |
Defined in
packages/ui-components/src/store/models/login.ts:15
LoginResponse
Ƭ LoginResponse: Object
Type declaration
| Name | Type |
|---|---|
token | string | null |
username | string | null |
Defined in
packages/ui-components/src/store/models/login.ts:20
RootState
Ƭ RootState: RematchRootState<RootModel, FullModel>
Defined in
packages/ui-components/src/store/store.ts:15
Theme
Ƭ Theme: MuiTheme & CustomTheme
Defined in
packages/ui-components/src/Theme/theme.ts:101
Variables
Search
• Search: ComponentClass<Pick<RouteComponentProps<{}, StaticContext, LocationState>, never>, any> & WithRouterStatics<FC<RouteComponentProps<{}, StaticContext, LocationState>>>
Defined in
packages/ui-components/src/components/Search/Search.tsx:164
api
• api: API
Defined in
packages/ui-components/src/store/api.ts:80
store
• Const store: RematchStore<RootModel, FullModel>
Defined in
packages/ui-components/src/store/store.ts:8
Component Functions
ActionBar
▸ ActionBar(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
AppConfigurationProvider
▸ AppConfigurationProvider(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
props.children | ReactElement<any, string | JSXElementConstructor<any>> | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Author
▸ Author(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
props.packageMeta | any | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
CopyClipboard
▸ CopyClipboard(«destructured»): Element
Parameters
| Name | Type |
|---|---|
«destructured» | Props |
Returns
Element
Defined in
packages/ui-components/src/components/CopyClipboard/CopyToClipBoard.tsx:32
Dependencies
▸ Dependencies(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
props.packageMeta | any | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Deprecated
▸ Deprecated(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Detail
▸ Detail(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Developers
▸ Developers(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Distribution
▸ Distribution(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
props.packageMeta | PackageMetaInterface | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Engines
▸ Engines(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Footer
▸ Footer(): Element
Returns
Element
Defined in
packages/ui-components/src/sections/Footer/Footer.tsx:18
Forbidden
▸ Forbidden(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
FundButton
▸ FundButton(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
props.packageMeta | any | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Header
▸ Header(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
HeaderInfoDialog
▸ HeaderInfoDialog(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Heading
▸ Heading(props): null | ReactElement<any, string | JSXElementConstructor<any>>
Parameters
| Name | Type |
|---|---|
props | Omit<Props, "ref"> & RefAttributes<HTMLHeadingElement> |
Returns
null | ReactElement<any, string | JSXElementConstructor<any>>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:636
Help
▸ Help(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Home
▸ Home(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Install
▸ Install(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Keywords
▸ Keywords(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
props.packageMeta | PackageMetaInterface | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Label
▸ Label(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Link
▸ Link(props): null | ReactElement<any, string | JSXElementConstructor<any>>
Parameters
| Name | Type |
|---|---|
props | Omit<any, "ref"> & RefAttributes<HTMLAnchorElement> |
Returns
null | ReactElement<any, string | JSXElementConstructor<any>>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:636
LinkExternal
▸ LinkExternal(props): null | ReactElement<any, string | JSXElementConstructor<any>>
Parameters
| Name | Type |
|---|---|
props | Omit<any, "ref"> & RefAttributes<HTMLAnchorElement> |
Returns
null | ReactElement<any, string | JSXElementConstructor<any>>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:636
Loading
▸ Loading(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
LoginDialog
▸ LoginDialog(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Logo
▸ Logo(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
MenuItem
▸ MenuItem(props): null | ReactElement<any, string | JSXElementConstructor<any>>
Parameters
| Name | Type |
|---|---|
props | Omit<Props, "ref"> & RefAttributes<MenuItemRef> |
Returns
null | ReactElement<any, string | JSXElementConstructor<any>>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:636
NotFound
▸ NotFound(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Package
▸ Package(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | PackageInterface | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
PackageList
▸ PackageList(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
PersistenceSettingProvider
▸ PersistenceSettingProvider(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
props.children | ReactElement<any, string | JSXElementConstructor<any>> | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Person
▸ Person(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
props.packageName | string | - |
props.person | Developer | - |
props.version | string | - |
props.withText? | boolean | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
RawViewer
▸ RawViewer(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Readme
▸ Readme(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
SideBar
▸ SideBar(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
SideBarTitle
▸ SideBarTitle(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
StyleBaseline
▸ StyleBaseline(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
TextField
▸ TextField(props): null | ReactElement<any, string | JSXElementConstructor<any>>
Parameters
| Name | Type |
|---|---|
props | Object |
Returns
null | ReactElement<any, string | JSXElementConstructor<any>>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:636
ThemeProvider
▸ ThemeProvider(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
props.children | any | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
UpLinks
▸ UpLinks(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
props.packageMeta | any | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
VersionLayout
▸ VersionLayout(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
Versions
▸ Versions(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Parameters
| Name | Type | Description |
|---|---|---|
props | Props | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
copyToClipBoardUtility
▸ copyToClipBoardUtility(str): (e: SyntheticEvent<HTMLElement, Event>) => void
Parameters
| Name | Type |
|---|---|
str | string |
Returns
fn
▸ (e): void
Parameters
| Name | Type |
|---|---|
e | SyntheticEvent<HTMLElement, Event> |
Returns
void
Defined in
packages/ui-components/src/components/CopyClipboard/utils.ts:4
getCLIChangePassword
▸ getCLIChangePassword(command, registryUrl): string
Parameters
| Name | Type |
|---|---|
command | string |
registryUrl | string |
Returns
string
Defined in
packages/ui-components/src/utils/cli-utils.ts:36
getCLISBerryYamlRegistry
▸ getCLISBerryYamlRegistry(scope, registryUrl): string
Parameters
| Name | Type |
|---|---|
scope | undefined | string |
registryUrl | string |
Returns
string
Defined in
packages/ui-components/src/utils/cli-utils.ts:40
getCLISetConfigRegistry
▸ getCLISetConfigRegistry(command, scope, registryUrl): string
Parameters
| Name | Type |
|---|---|
command | string |
scope | undefined | string |
registryUrl | string |
Returns
string
Defined in
packages/ui-components/src/utils/cli-utils.ts:23
getCLISetRegistry
▸ getCLISetRegistry(command, registryUrl): string
Parameters
| Name | Type |
|---|---|
command | string |
registryUrl | string |
Returns
string
Defined in
packages/ui-components/src/utils/cli-utils.ts:32
isTokenExpire
▸ isTokenExpire(token): boolean
Parameters
| Name | Type |
|---|---|
token | null | string |
Returns
boolean
Defined in
packages/ui-components/src/utils/token.ts:5
useConfig
▸ useConfig(): ConfigProviderProps
Returns
ConfigProviderProps
Defined in
packages/ui-components/src/providers/AppConfigurationProvider/AppConfigurationProvider.tsx:75
useCustomTheme
▸ useCustomTheme(): undefined | Props
Returns
undefined | Props
Defined in
packages/ui-components/src/Theme/ThemeProvider.tsx:42
useLanguage
▸ useLanguage(): TranslatorProviderProps
Returns
TranslatorProviderProps
Defined in
packages/ui-components/src/providers/TranslatorProvider/TranslatorProvider.tsx:54
useVersion
▸ useVersion(): Partial<DetailContextProps>
Returns
Partial<DetailContextProps>
Defined in
packages/ui-components/src/providers/VersionProvider/VersionProvider.tsx:92
Provider Functions
TranslatorProvider
▸ TranslatorProvider(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Translator provider
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
props.children | ReactElement<any, string | JSXElementConstructor<any>> | - |
props.i18n | i18n | - |
props.listLanguages | any | - |
props.onMount | () => {} | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
VersionProvider
▸ VersionProvider(props, deprecatedLegacyContext?): null | ReactElement<any, any>
Example
Once a component has been wrapped with VersionProvider, use the hook useVersion() to get an object with:
```jsx
function CustomComponent() {
const { packageMeta, packageName, packageVersion } = useVersion();
return <div />;
}
<Route path={Routes.PACKAGE}>
<VersionProvider>
<CustomComponent />
</VersionProvider>
</Route>;
```
On mount, the provider will fetch data from the store for specific package or version provided via router.
Parameters
| Name | Type | Description |
|---|---|---|
props | Object | - |
props.children | any | - |
deprecatedLegacyContext? | any | Deprecated See React Docs |
Returns
null | ReactElement<any, any>
Defined in
node_modules/@types/react/ts5.0/index.d.ts:1115
HOC Functions
loadable
▸ loadable(importCallback): (props: any) => Element
With the combination of a bundler, enable to code split a package.
Example
const VersionPage = loadable(() => import(/'../pages/Version'));
Parameters
| Name | Type |
|---|---|
importCallback | any |
Returns
fn
▸ (props): Element
Parameters
| Name | Type |
|---|---|
props | any |
Returns
Element
Defined in
packages/ui-components/src/utils/loadable.tsx:13
Hooks Functions
useLocalStorage
▸ useLocalStorage<V>(key, initialValue): any[]
Example
const [isDarkModeStorage, setIsDarkMode] = useLocalStorage('darkMode', isDarkModeDefault);
based on https://usehooks.com/useLocalStorage/
Type parameters
| Name |
|---|
V |
Parameters
| Name | Type |
|---|---|
key | string |
initialValue | V |
Returns
any[]
Defined in
packages/ui-components/src/hooks/useLocalStorage.ts:13
useOnClickOutside
▸ useOnClickOutside<R>(ref, handler): void
Example
based on https://usehooks.com/useOnClickOutside/
Type parameters
| Name | Type |
|---|---|
R | extends HTMLElement | HTMLDivElement | HTMLSpanElement | HTMLObjectElement | HTMLTimeElement | HTMLTitleElement | HTMLLinkElement | HTMLInputElement | HTMLAnchorElement | HTMLAreaElement | HTMLAudioElement | HTMLBaseElement | HTMLQuoteElement | HTMLBodyElement | HTMLBRElement | HTMLButtonElement | HTMLCanvasElement | HTMLTableColElement | HTMLDataElement | HTMLDataListElement | HTMLModElement | HTMLDetailsElement | HTMLDialogElement | HTMLDListElement | HTMLEmbedElement | HTMLFieldSetElement | HTMLFormElement | HTMLHeadingElement | HTMLHeadElement | HTMLHRElement | HTMLHtmlElement | HTMLIFrameElement | HTMLImageElement | HTMLLabelElement | HTMLLegendElement | HTMLLIElement | HTMLMapElement | HTMLMetaElement | HTMLMeterElement | HTMLOListElement | HTMLOptGroupElement | HTMLOptionElement | HTMLOutputElement | HTMLParagraphElement | HTMLPreElement | HTMLProgressElement | HTMLSlotElement | HTMLScriptElement | HTMLSelectElement | HTMLSourceElement | HTMLStyleElement | HTMLTableElement | HTMLTemplateElement | HTMLTableSectionElement | HTMLTableCellElement | HTMLTextAreaElement | HTMLTableRowElement | HTMLTrackElement | HTMLUListElement | HTMLVideoElement | HTMLTableCaptionElement | HTMLMenuElement | HTMLPictureElement |
Parameters
| Name | Type |
|---|---|
ref | RefObject<R> |
handler | (event: MouseEvent | TouchEvent) => void |
Returns
void