verdaccio/website/docs/ui-components.md

id	title
ui-components	UI Components

If you need a more advanced user interface, the option might be use the UI components that provides a set of reusable React components just to plug and play. The UI components are compatible with v5.x and ahead.

To install install the dependency in a local project.

:::caution

The UI components are in experimental mode, currently used to build the main user interface @verdaccio/ui-theme, If you are willing to use it feedback is welcome.

:::

npm i -D @verdaccio/ui-components@6-next

Browser all available components at https://ui-components.verdaccio.org/

How to use it

There are a set of tools can be used in order to build your own user interface:

• components: Independent components to use to build different layouts, all components are based on MUI (Material UI).
• providers: Providers are useful components that uses the React Context, for instance, the VersionProvider connects the Redux store with independent components. The AppConfigurationProvider is able to read the
• store: The Redux store powered by Rematch, could be used with the global object __VERDACCIO_BASENAME_UI_OPTIONS that verdaccio uses to provide the UI configuration.
• theme: The ThemeProvider is an abstraction of the material-ui theme provider.
• sections: A group of components to setup quickly sections of the application, like the sidebar, header of footer.
• layouts: Are the combination of one or more sections ready to use.
• hooks: A collection of useful React hooks.

The combination of them depend of your needs, it could be used to inject custom components, routes or addition of new pages or components.

Requirements

The list of mandatory libraries need it to using with ui components.

• React >17
• Material UI >5.x
• Redux >4.x
• Emotion >11
• i18next >20.x
• TypeScript is optional

Examples

import React from 'react';
import { Route, Router, Switch } from 'react-router-dom';
import { Provider } from 'react-redux';
import {
  Home,
  store,
  Loading,
  NotFound,
  Route as Routes,
  TranslatorProvider,
  VersionProvider,
  loadable,
} from '@verdaccio/ui-components';

// to enable webpack code splitting
const VersionPage = loadable(() => import('../pages/Version'));

const App: React.FC = () => {
  // configuration from config.yaml
  const { configOptions } = useConfig();
  const listLanguages = [{lng: 'en-US', icon: <someSVGIcon>, menuKey: 'lng.english'}];
  return (
      <Provider store={store}>
        <AppConfigurationProvider>
          <ThemeProvider>
            <TranslatorProvider i18n={i18n} listLanguages={listLanguages} onMount={() => {}}>
              <Suspense fallback={<Loading />}>
                <Router history={history}>
                  <Header HeaderInfoDialog={CustomInfoDialog} />
                    <Switch>
                      <Route exact={true} path={Routes.ROOT}>
                        <Home />
                      </Route>
                      <Route exact={true} path={Routes.SCOPE_PACKAGE}>
                        <VersionProvider>
                          <VersionPage />
                        </VersionProvider>
                      </Route>
                    </Switch>
                </Router>
                {configOptions.showFooter && <Footer />}
              </Suspense>
            </TranslatorProvider>
          </ThemeProvider>
        </AppConfigurationProvider>
      </Provider>
  );
};