@bebraw/system-components
Create consistent design-system-driven React UI components
Last updated 3 years ago by bebraw .
MIT · Original npm · Tarball · package.json
$ cnpm install @bebraw/system-components 
SYNC missed versions from official npm registry.

system-components

Create consistent design-system-driven React UI components

Built with styled-system & styled-components

Build Status

import system from 'system-components'

// creates a Box with default props tied to your theme
const Box = system({
  p: 2,
  bg: 'blue'
})

Usage

To create a styled-component with default props that hook into styled-system props, pass a plain object as the first argument to the system function.

const Card = system({
  px: 2,
  py: 3,
  borderWidth: 1,
  borderColor: 'lightGray',
  borderRadius: 2
})

The system function will automatically apply styled-system functions to the underlying styled-component based on the keys of the defaultProps object. System components also add prop type definitions and remove style props from the underlying HTML element.

See the styled-system docs for a complete list of the available style functions.

Add style props without defaultProps

System components can also be created with styled-system props without defining defaultProps.

const Box = system(
  'space',
  'width',
  'color'
)

This allows for style props to be passed to the component instance:

<Box
  width={1/2}
  px={3}
  py={4}
  bg='blue'
/>

Using custom functions

Custom style functions can be passed as an argument.

const Box = system(
  props => ({
    height: props.height
  })
)

Changing the underlying HTML element

System components default to using a <div> as the HTML element. To change the HTML element use the is prop.

const Heading = system({
  is: 'h2',
  m: 0,
  fontSize: 6
})

Since is is a prop, it can also be passed to the element when used. This is useful for one-off changes to ensure semantic markup.

<Heading is='h1'>
  Hello
</Heading>

Extending components

System components are styled-components, so any of the built-in methods work as expected, including .extend.

const Text = system({
  fontSize: 2,
})

const Bold = Text.extend`
  font-weight: bold;
`

MIT License

Current Tags

  • 2.0.4                                ...           latest (3 years ago)

2 Versions

  • 2.0.4                                ...           3 years ago
  • 2.0.3                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 2
Dependencies (2)
Dev Dependencies (11)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |