JSPM

  • Created
  • Published
  • Downloads 777
  • Score
    100M100P100Q111743F
  • License MIT

DesignSystem on which admin-bro is build

Package Exports

  • @admin-bro/design-system

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@admin-bro/design-system) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@admin-bro/design-system

This package consist of all DesignSystem components from AdminBro so you can use all of them outside the @admin-bro/core.

It was created with the help of 2 amazing packages:

Installation

yarn add styled-components @admin-bro/design-system

Optionally, if you use typescript, you might want to install types for styled-components

yarn add --dev @types/styled-components

Design System needs a theme so in order to use it you have to use ThemeProvider from styled-components like this:

import { ThemeProvider } from 'styled-components'

// theme is the default theme, which you can alter
import { theme, Button, Box, Icon } from '@admin-bro/design-system'

function App() {
  return (
    <ThemeProvider theme={theme}>
      <Box variant="grey">
        <Button><Icon icon="Add" />Click Me</Button>
        <Button variant='primary' ml="xl">I am important</Button>
      </Box>
    </ThemeProvider>
  );
}

export default App;

Changing theme

Design System provides you with the default theme. It contains all the parameters like paddings, colors, font sizes etc. For the list of all available parameters take a look at the Theme spec.

But nothing stands in a way for you to change the default theme. In order to do that you can use bundled combineStyles method: