etymos
v0.0.2
Published
responsive toolkit for react + styled-components
Downloads
12
Maintainers
Readme
ἔτυμος
etymos is a responsive, mobile-first, toolkit for
react
+styled-components
.
installation
yarn:
yarn add etymos
npm:
npm install etymos --save
usage
this package provides a Provider
, some hooks
and a styled-components
helper
Provider
receives a breakpoints
prop (if not present, this package provides a default)
this prop is an object with other objects containing at least a width
number (in pixels), but it can contain more entries (useful together with mapTheme
function)
const breakpoints = {
hey: { width: 0 },
thats: { width: 480 },
rad: { width: 768 },
}
const App = () => (
<Provider breakpoints={breakpoints}>
<pre>hey, app here</pre>
</Provider>
)
hooks
provides data derived from closest <Provider/>
and / or window size
*
useTheme
outputs an object
with:
columns
: columns countbreakpoints
: breakpoints object as described on Provider
useWindowSize
outputs an object
with numeric: innerHeight
& innerWidth
when ssr
, both will return 0
useMediaQuery
receives an object with optional above
and below
parameters and returns a boolean. both parameters can be one of:
a string denoting a breakpoint
a number of pixels
the default parameters are below: 0
, above: Infinity
, therefore, if no parameters are provided, it will always return true
useBreakpoints
returns an array of strings denoting the breakpoint that are visible eg. on a tablet, we should get something like ['xs', 'sm', 'md']
useCurrentBreakpoint
returns a string denoting the biggest visible breakpoint, following the example, on a tablet we should get something like 'md'
styled-components helpers
above
a media query
helper utility to use inside styled-components
. receives a string denoting the breakpoint, and a template literal with the css
that should be rendered:
const AboveMD = styled.div`
display: none;
${above('md')`
display: block;
`}
`
mapBreakpoints
this helper will create props with your breakpoints keys, that will be treated by a function (receiving the value defined, as other props) and will be rendered inside an above
blocks for the corresponding defined breakpoints props.
const Spacer = styled.div`
display: block;
${mapBreakpoints((value, props) => `
margin: ${value}rem;
`)}
`
const App = () => <Provider><Spacer xs={0} md={1} /></Provider>
mapTheme
similar to mapBreakpoints
this helper can read entries on each breakpoint (defined by the breakpoints
object) and treat them with a function that will render inside above
blocks.
const breakpoints = {
sm: {width: 0, gutter: 0.5},
md: {width: 0},
lg: {width: 0, gutter: 1},
}
const Spacer = styled.div`
display: block;
${mapTheme((value, props) => value.gutter && `
margin: ${value.gutter}rem;
`)}
`
const App = () => (
<Provider breakpoints={breakpoints}>
<Spacer/>
</Provider>
)
contributing
this repo is open to issues
and pull requests
thanks
mostly of this lib was done with @leonardodino great help and probably wouldn't be possible without it.