@styled-system/prop-types
v5.1.5
Published
Add prop types to components built with Styled System
Downloads
216,653
Readme
@styled-system/prop-types
Add prop types to components built with Styled System
npm i styled-system @styled-system/prop-types
import styled from 'styled-components'
import { space, color } from 'styled-system'
import propTypes from '@styled-system/prop-types'
const Box = styled('div')(space, color)
Box.propTypes = {
...propTypes.space,
...propTypes.color,
}
Available Type Categories
space
color
layout
typography
flexbox
border
background
position
grid
See props of each category in the reference table.
Custom Props
import styled from 'styled-components'
import { space, system } from 'styled-system'
import propTypes, { propType } from '@styled-system/prop-types'
const gridGap = system({
gap: {
property: 'gridGap',
scale: 'space',
defaultScale: [0, 4, 8, 16, 32, 64, 128, 256, 512]
}
})
const Stack = styled('div')(
compose(space, gridGap)
)
Stack.propTypes = {
...propTypes.space,
gap: propType,
}