System Props

Primer Components utilize what we call "system props" to apply a standard set of props to each component. Using styled-system, groups of props are automatically applied to each component. Most components get the COMMON set of props which give the component access to color and space props (margin, padding, color and background color). These groups correspond to the color and space functions from styled-system which can be referenced in the styled system table of style functions.

To check which system props each component includes, check the documentation for that component.

System Prop Categories

CategoryIncluded Propsstyled-system docs
COMMON
margin, marginTop, marginRight, marginBottom, marginLeft, marginX, marginY, m, mt, mr, mb, ml, mx, my, padding, paddingTop, paddingRight, paddingBottom, paddingLeft, paddingX, paddingY, p, pt, pr, pb, pl, px, py, color, backgroundColor, opacity, bg, width, height, minWidth, minHeight, maxWidth, maxHeight, size, overflow, display, verticalAlign
styled-system core docs
TYPOGRAPHY
fontFamily, fontSize, fontWeight, lineHeight, letterSpacing, textAlign, fontStyle
styled-system typography docs
BORDER
border, borderWidth, borderStyle, borderColor, borderRadius, borderTop, borderRight, borderBottom, borderLeft, borderX, borderY, boxShadow, textShadow
styled-system border docs
LAYOUT
width, height, minWidth, minHeight, maxWidth, maxHeight, size, overflow, display, verticalAlign
styled-system layout docs
styled-system misc docs
POSITION
position, zIndex, top, right, bottom, left
styled-system position docs
FLEX
alignItems, alignContent, justifyItems, justifyContent, flexWrap, flexDirection, flex, flexGrow, flexShrink, flexBasis, justifySelf, alignSelf, order
styled-system flexbox docs
Edit this page on GitHub