Style Props Style props are a way to alter the style of a component by simply passing props
to it. It helps to save time by providing helpful shorthand ways to style
components.
Reference #
The following table shows a list of every style prop and the properties within
each group.
Margin and padding #
import { Box } from "@chakra-ui/react"
< Box m = { 2 } > Tomato </ Box >
< Box maxW = " 960px " mx = " auto " />
< Box m = { [ 2 , 3 ] } />
copy
Prop CSS Property Theme Key m, marginmarginspacemt, marginTopmargin-topspacemr, marginRightmargin-rightspaceme, marginEndmargin-inline-endspacemb, marginBottommargin-bottomspaceml, marginLeftmargin-leftspacems, marginStartmargin-inline-startspacemxmargin-inline-start + margin-inline-endspacemymargin-top + margin-bottomspacep, paddingpaddingspacept, paddingToppadding-topspacepr, paddingRightpadding-rightspacepe, paddingEndpadding-inline-endspacepb, paddingBottompadding-bottomspacepl, paddingLeftpadding-leftspaceps, paddingStartpadding-inline-startspacepxpadding-inline-start + padding-inline-endspacepypadding-top + padding-bottomspace
For mx and px props, we use margin-inline-start and margin-inline-end
to ensure the generated styles are RTL-friendly
Color and background color #
import { Box } from "@chakra-ui/react"
< Box color = ' gray.50 ' />
< Box color = ' #f00 ' />
< Box bg = ' tomato ' />
< Box backgroundColor = ' tomato ' />
copy
Prop CSS Property Theme Key colorcolorcolorsbg, backgroundbackgroundcolorsbgColorbackground-colorcolorsopacityopacitynone
Gradient #
import { Box , Text } from "@chakra-ui/react"
< Box w = " 100% " h = " 200px " bgGradient = " linear(to-t, green.200, pink.500) " />
< Box w = " 100% " h = " 200px " bgGradient = " radial(gray.300, yellow.400, pink.200) " />
< Text
bgGradient = " linear(to-l, #7928CA, #FF0080) "
bgClip = " text "
fontSize = " 6xl "
fontWeight = " extrabold "
>
Welcome to Chakra UI
</ Text >
copy
Prop CSS Property Theme Key bgGradientbackground-imagenone bgClip, backgroundClipbackground-clipnone
Typography #
import { Text } from "@chakra-ui/react"
< Text fontSize = " md " />
< Text fontSize = { 32 } />
< Text fontSize = ' 2em ' />
< Text textAlign = { [ 'left' , 'center' ] } />
copy
Prop CSS Property Theme Key fontFamilyfont-familyfontsfontSizefont-sizefontSizesfontWeightfont-weightfontWeightslineHeightline-heightlineHeightsletterSpacingletter-spacingletterSpacingstextAligntext-alignnone fontStylefont-stylenone textTransformtext-transformnone textDecorationtext-decorationnone
Layout, width and height #
import { Box } from "@chakra-ui/react"
< Box width = " 100% " height = { 32 } />
< Box w = " 100% " h = " 32px " />
< Box boxSize = " sm " />
< Box w = { 1 / 2 } />
< Box w = { 256 } />
< Box w = ' 40px ' />
copy
Prop CSS Property Theme Key w, widthwidthsizesh, heightheightsizesminW, minWidthmin-widthsizesmaxW, maxWidthmax-widthsizesminH, minHeightmin-heightsizesmaxH, maxHeightmax-heightsizesd, displaydisplaynone boxSizewidth, heightsizesverticalAlignvertical-alignnone overflowoverflownone overflowXoverflowXnone overflowYoverflowYnone
Flexbox #
import { Box , Flex } from "@chakra-ui/react"
< Box display = " flex " alignItems = " center " justifyContent = " space-between " >
Box with Flex props
</ Box >
< Flex align = " center " justify = " center " >
Flex Container
</ Flex >
copy
Note: Props in * will only work if you use the Flex component.
Prop CSS Property Theme Key alignItems, *alignalign-itemsnone alignContentalign-contentnone justifyItemsjustify-itemsnone justifyContent, *justifyjustify-contentnone flexWrap, *wrapflex-wrapnone flexDirection, flexDir, *directionflex-directionnone flexflexnone flexGrowflex-grownone flexShrinkflex-shrinknone flexBasisflex-basisnone justifySelfjustify-selfnone alignSelfalign-selfnone orderordernone
Grid Layout #
import { Box , Grid } from "@chakra-ui/react"
< Box display = " grid " gridGap = { 2 } gridAutoFlow = " row dense " >
Grid
</ Box >
< Grid gap = { 2 } autoFlow = " row dense " >
Grid
</ Grid >
copy
Note: Props in * will only work if you use the Grid component.
Prop CSS Property Theme Key gridGap, *gapgrid-gapspacegridRowGap, *rowGapgrid-row-gapspacegridColumnGap, *columnGapgrid-column-gapspacegridColumn, *columngrid-columnnone gridRow, *rowgrid-rownone gridArea, *areagrid-areanone gridAutoFlow, *autoFlowgrid-auto-flownone gridAutoRows, *autoRowsgrid-auto-rowsnone gridAutoColumns, *autoColumnsgrid-auto-columnsnone gridTemplateRows, *templateRowsgrid-template-rowsnone gridTemplateColumns, *templateColumnsgrid-template-columnsnone gridTemplateAreas, *templateAreasgrid-template-areasnone
Background #
import { Box } from "@chakra-ui/react"
< Box
backgroundImage = " url( ' /images/kyuubi.png ' ) "
backgroundPosition = " center "
backgroundRepeat = " no-repeat "
/>
< Box
bgImage = " url( ' /images/gaara.png ' ) "
bgPosition = " center "
bgRepeat = " no-repeat "
/>
copy
Prop CSS Property Theme Key bg, backgroundbackgroundnone bgImage, backgroundImagebackground-imagenone bgSize, backgroundSizebackground-sizenone bgPosition,backgroundPositionbackground-positionnone bgRepeat,backgroundRepeatbackground-repeatnone bgAttachment,backgroundAttachmentbackground-attachmentnone
Borders #
< Box border = ' 1px ' borderColor = ' gray.200 ' >
Card
</ Box >
copy
Prop CSS Property Theme Field borderborderbordersborderWidthborder-widthborderWidthsborderStyleborder-styleborderStylesborderColorborder-colorcolorsborderTopborder-topbordersborderTopWidthborder-top-widthborderWidthsborderTopStyleborder-top-styleborderStylesborderTopColorborder-top-colorcolorsborderRightborder-rightbordersborderEndborder-inline-endbordersborderRightWidthborder-right-widthborderWidthsborderEndWidthborder-inline-end-widthborderWidthsborderRightStyleborder-right-styleborderStylesborderEndStyleborder-inline-end-styleborderStylesborderRightColorborder-right-colorcolorsborderEndColorborder-inline-end-colorcolorsborderBottomborder-bottombordersborderBottomWidthborder-bottom-widthborderWidthsborderBottomStyleborder-bottom-styleborderStylesborderBottomColorborder-bottom-colorcolorsborderLeftborder-leftbordersborderStartborder-inline-startbordersborderLeftWidthborder-left-widthborderWidthsborderStartWidthborder-inline-start-widthborderWidthsborderLeftStyleborder-left-styleborderStylesborderStartStyleborder-inline-start-styleborderStylesborderLeftColorborder-left-colorcolorsborderStartColorborder-inline-start-colorcolorsborderXborder-left , border-rightbordersborderYborder-top , border-bottomborders
Border Radius #
import { Button } from "@chakra-ui/react"
< Button borderRightRadius = " 0 " > Button 1 </ Button >
< Button borderLeftRadius = " 0 " > Button 2 </ Button >
< Button borderTopRadius = " md " > Button 2 </ Button >
copy
Prop CSS Property Theme Field borderRadiusborder-radiusradiiborderTopLeftRadiusborder-top-left-radiusradiiborderTopStartRadiusborder-top-left-radius in LTR, border-top-right-radius in RTLradiiborderTopRightRadiusborder-top-right-radiusradiiborderTopEndRadiusborder-top-right-radius in LTR, border-top-left-radius in RTLradiiborderBottomRightRadiusborder-bottom-right-radiusradiiborderBottomEndRadiusborder-bottom-right-radius in LTR, border-bottom-left-radius in RTLradiiborderBottomLeftRadiusborder-bottom-left-radiusradiiborderBottomStartRadiusborder-bottom-left-radius in LTR, border-bottom-left-radius in RTLradiiborderTopRadiusborder-top-left-radius + border-top-right-radiusradiiborderRightRadiusborder-top-right-radius + border-bottom-right-radiusradiiborderEndRadiusborder-top-right-radius + border-bottom-right-radiusradiiborderBottomRadiusborder-bottom-left-radius + border-bottom-right-radiusradiiborderLeftRadiusborder-top-left-radius + border-bottom-left-radiusradiiborderStartRadiusborder-top-left-radius + border-bottom-left-radiusradii
Position #
import { Box } from "@chakra-ui/react"
< Box position = " absolute " > Cover </ Box >
< Box pos = " absolute " > Cover </ Box >
< Box pos = " absolute " top = " 0 " left = " 0 " >
Absolute with top and left
</ Box >
< Box pos = " fixed " w = " 100% " zIndex = { 2 } >
Fixed with zIndex
</ Box >
copy
Prop CSS Property Theme Field pos,positionpositionnone zIndexz-indexzIndicestoptopspacerightrightspacebottombottomspaceleftleftspace
Shadow #
< SimpleGrid
bg = ' gray.50 '
columns = { { sm : 2 , md : 4 } }
spacing = ' 8 '
p = ' 10 '
textAlign = ' center '
rounded = ' lg '
color = ' gray.400 '
>
< Box boxShadow = ' xs ' p = ' 6 ' rounded = ' md ' bg = ' white ' >
xs
</ Box >
< Box boxShadow = ' sm ' p = ' 6 ' rounded = ' md ' bg = ' white ' >
sm
</ Box >
< Box boxShadow = ' base ' p = ' 6 ' rounded = ' md ' bg = ' white ' >
Base
</ Box >
< Box boxShadow = ' md ' p = ' 6 ' rounded = ' md ' bg = ' white ' >
md
</ Box >
< Box boxShadow = ' lg ' p = ' 6 ' rounded = ' md ' bg = ' white ' >
lg
</ Box >
< Box boxShadow = ' xl ' p = ' 6 ' rounded = ' md ' bg = ' white ' >
xl
</ Box >
< Box boxShadow = ' 2xl ' p = ' 6 ' rounded = ' md ' bg = ' white ' >
2 xl
</ Box >
< Box boxShadow = ' dark-lg ' p = ' 6 ' rounded = ' md ' bg = ' white ' >
Dark lg
</ Box >
< Box boxShadow = ' outline ' p = ' 6 ' rounded = ' md ' bg = ' white ' >
Outline
</ Box >
< Box boxShadow = ' inner ' p = ' 6 ' rounded = ' md ' bg = ' white ' >
Inner
</ Box >
</ SimpleGrid >
copy
< Text textShadow = ' 1px 1px #ff0000 ' m = ' 6 ' >
Text with shadows
</ Text >
copy
Prop CSS Property Theme Field textShadowtext-shadowshadowsshadow, boxShadowbox-shadowshadows
Pseudo #
import { Button } from "@chakra-ui/react"
< Button
colorScheme = " teal "
_hover = { {
background : "white" ,
color : "teal.500" ,
} }
>
Hover me
</ Button >
< Box
role = " group "
>
< Box
_hover = { { fontWeight : 'semibold' } }
_groupHover = { { color : 'tomato' } }
>
</ Box >
</ Box >
copy
Prop CSS Property Theme Field _hover:hover,[data-hover]none _active:active,[data-active]none _focus:focus,[data-focus]none _highlighted[data-highlighted]none _focusWithin:focus-withinnone _focusVisible:focus-visiblenone _disabled[disabled],[aria-disabled=true],[data-disabled]none _readOnly[aria-readonly=true],[readonly], [data-readonly]none _before::beforenone _after::afternone _empty:emptynone _expanded[aria-expanded=true],[data-expanded]none _checked[aria-checked=true],[data-checked]none _grabbed[aria-grabbed=true],[data-grabbed]none _pressed[aria-pressed=true],[data-pressed]none _invalid[aria-invalid=true],[data-invalid]none _valid[data-valid],[data-state=valid]none _loading[data-loading],[aria-busy=true]none _selected[aria-selected=true],[data-selected]none _hidden[hidden],[data-hidden]none _autofill:-webkit-autofillnone _even:nth-of-type(even)none _odd:nth-of-type(odd)none _first:first-of-typenone _last:last-of-typenone _notFirst:not(:first-of-type)none _notLast:not(:last-of-type)none _visited:visitednone _activeLink[aria-current=page]none _activeStep[aria-current=step]none _indeterminate:indeterminate,[aria-checked=mixed],[data-indeterminate]none _groupHover[role=group]:hover &, [role=group][data-hover] &none _groupFocus[role=group]:focus &, [role=group][data-focus] &none _groupActive[role=group]:active &, [role=group][data-active] &none _groupDisabled[role=group]:disabled &, [role=group][data-disabled] &none _groupInvalid[role=group][data-invalid] &none _groupChecked[role=group][data-checked] &none _placeholder::placeholdernone _fullScreen:fullscreennone _selection::selectionnone
Other Props #
Asides all the common style props listed above, all component will accept the
following props:
Prop CSS Property Theme Field animationanimationnone appearanceappearancenone transformtransformnone transformOrigintransform-originnone visibilityvisibilitynone whiteSpacewhite-spacenone userSelectuser-selectnone pointerEventspointer-eventsnone wordBreakword-breaknone overflowWrapoverflow-wrapnone textOverflowtext-overflownone boxSizingbox-sizingnone cursorcursornone resizeresizenone transitiontransitionnone objectFitobject-fitnone objectPositionobject-positionnone objectPositionobject-positionnone floatfloatnone fillfillcolorsstrokestrokecolorsoutlineoutlinenone
The as prop #
The as prop is a feature in all of our components that allows you to pass an
HTML tag or component to be rendered.
For example, say you are using a Button component, and you need to make it a
link instead. You can compose a and Button like this:
< Button as = ' a ' target = ' _blank ' variant = ' outline ' href = ' https://chakra-ui.com ' >
Hello
</ Button >
copy
This allows you to use all of the Button props and all of the a props
without having to wrap the Button in an a component.