0.20.6 • Published 6 years ago

ui-component-lib2 v0.20.6

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

Code Style: Google

Backoffice UI

React components based on Material Design. edekadigital.github.io/backoffice-ui

Usage

1. Install

npm i -S @edekadigital/backoffice-ui

2. Load "Roboto" font

<link
  rel="stylesheet"
  href="https://fonts.googleapis.com/css?family=Roboto:300,400,500"
/>

3. Render BackofficeUiProvider

import { BackofficeUiProvider } from '@edekadigital/backoffice-ui';

export const App = () => (
  <BackofficeUiProvider>
    <SomeComponent />
    {/* ... */}
  </BackofficeUiProvider>
);

4. Use components

import { Button } from '@edekadigital/backoffice-ui';

export const SomeComponent = () => (
  <>
    {/* ... */}
    <Button>Some label</Button>
  </>
);

Development

Commands

CommandDescription
npm run storybookStart development mode (Storybook)
npm run build-storybookExport storybook into a static web app
npm run buildBuild library (cjs + es6)
npm run test, npm testRun tests (TODO)
npm run checkChecks code for formatting and lint issues
npm run fixFixes formatting and linting issues (if possible)
npm run cleanRemoves all files generated by the build

Resources