@class101/styled-system__theme-get
v5.3.3
Published
The `themeGet` function is an existential getter function that can be used in any style declaration to get a value from your theme, with support for fallback values. This helps prevent errors from throwing when a theme value is missing, which can be helpf
Downloads
3
Keywords
Readme
@class101/styled-system__theme-get
The themeGet
function is an existential getter function
that can be used in any style declaration to get a value
from your theme, with support for fallback values.
This helps prevent errors from throwing when a theme value is missing,
which can be helpful when unit testing styled-components.
npm i @class101/styled-system__theme-get
themeGet(objectPath, fallbackValue)(props)
themeGet
returns a function that accepts props as an argument
(themeGet(objectPath)(props)
), which when used in a tagged template
literal should look like this:
import styled from 'styled-components'
import { themeGet } from '@class101/styled-system__theme-get'
const Box = styled.div`
border-radius: ${themeGet('radii.small', '4px')};
`
When used with object literal syntax, themeGet
needs to be in a
function call and have props
passed to it:
import styled from 'styled-components'
import { themeGet } from '@class101/styled-system__theme-get'
const Box = styled('div')(props => ({
borderRadius: themeGet('radii.small', '4px')(props),
}))