The simplest way to add CSS styles to your React components.
No configuration required.
- Zero-runtime CSS in JS
- Generates atomic class names
- De-duplicates styles
- Works in Server and Client Components
- Compatible with Suspense and streaming
- Encourages encapsulation
- Supports
cssprop with JSX pragma - Loads styles on demand
- Allows shipping CSS in NPM packages
- Small core
1.69kbminified and gzipped
npm install restyleimport { styled } from 'restyle'
export const Box = styled('div', {
padding: '1rem',
backgroundColor: 'peachpuff',
})Important
This library requires a React Canary version since it utilizes the new style hoisting feature.
Restyle leverages React's new ability to hoist style elements by generating atomic CSS on-demand to provide a flexible and efficient styling solution for React components. Here's a high-level overview of how it operates:
- Styles Parsing: Restyle takes a styles object of CSS and parses it, generating atomic class names for each unique style property and value pair:
import { css } from 'restyle'
const [classNames, styleElement] = css({
padding: '1rem',
backgroundColor: 'peachpuff',
})
// classNames: 'x1y2 x3z4'
// styleElement: <style>.x1y2{padding:1rem}.x3z4{background-color:peachpuff}</style>- Class Names Generation and Deduplication: Atomic class names are generated using a hashing function to ensure uniqueness and prevent collisions. Class names are cached per request, optimizing performance and reducing the overall size of the generated CSS:
import { css } from 'restyle'
const [classNames] = css({
padding: '1rem',
backgroundColor: 'tomato',
})
// Example output: 'x1y2 xfg3'- Atomic CSS: By breaking down styles into atomic units, it allows for highly reusable class names, making it easy to manage and override styles while reducing the overall size of the CSS produced:
import { css } from 'restyle'
const styles = {
padding: '1rem',
backgroundColor: 'rebeccapurple',
}
const [classNames, styleElement] = css(styles)
// classNames: 'x1y2 x4z1'
// Reuse class names for other elements
const buttonStyles = {
...styles,
border: '1px solid black',
}
const [buttonClassNames, buttonStyleElement] = css(buttonStyles)
// buttonClassNames: 'x1y2 x4z1 x5a6'- On-Demand Style Injection: Styles are only added to the DOM when the component or element is rendered:
import { css } from 'restyle'
export default function OnDemandStyles() {
const [classNames, styleElement] = css({
padding: '1rem',
backgroundColor: 'papayawhip',
})
return (
<>
<div className={classNames}>Hello World</div>
{styleElement}
</>
)
}- Integration with JSX Pragma: Easily add support for the
cssprop via the JSX pragma, allowing colocated inline CSS styles directly on JSX elements.
/** @jsxImportSource restyle */
export default function MyComponent() {
return (
<div
css={{
padding: '1rem',
backgroundColor: 'peachpuff',
}}
>
Hello World
</div>
)
}The css function returns a tuple of class names and the style tags to render. You can use the class names to apply styles to an element and the style tag to inject the styles into the head of the document:
import React from 'react'
import { css } from 'restyle'
export default function BasicUsage() {
const [classNames, styles] = css({
padding: '1rem',
backgroundColor: 'peachpuff',
})
return (
<>
<div className={classNames}>Hello World</div>
{styles}
</>
)
}The css function is most useful for components. However, you can use the css prop to style elements directly. The pragma will take care of applying the class names and injecting the style tag.
First, configure the pragma in your tsconfig.json file:
{
"compilerOptions": {
"jsxImportSource": "restyle"
}
}Now, you can use the css prop to style elements:
export default function CSSProp() {
return (
<div
css={{
padding: '1rem',
backgroundColor: 'peachpuff',
}}
>
Hello World
</div>
)
}Alternatively, you can set the pragma at the top of the file:
/** @jsxImportSource restyle */
export default function CSSProp() {
return (
<div
css={{
padding: '1rem',
backgroundColor: 'peachpuff',
}}
>
Hello World
</div>
)
}The styled function is a higher-order function that returns a styled component that can accept a css prop. It takes an element tag name or a component and a style object:
import Link from 'next/link'
import { styled } from 'restyle'
const Box = styled(Link, {
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
padding: '1rem',
backgroundColor: 'peachpuff',
})import React from 'react'
import { css } from 'restyle'
export function Box({
children,
display = 'flex',
alignItems,
justifyContent,
padding,
backgroundColor,
}) {
const [classNames, styles] = css({
display,
alignItems,
justifyContent,
padding,
backgroundColor,
})
return (
<div className={classNames}>
{children}
{styles}
</div>
)
}/** @jsxImportSource restyle */
export default function Hover() {
return (
<div
css={{
':hover': {
opacity: 0.8,
},
}}
>
Hover me
</div>
)
}/** @jsxImportSource restyle */
export default function MediaQueries() {
return (
<h1
css={{
fontSize: '2rem',
'@media screen and (min-width: 40em)': {
fontSize: '3.5rem',
},
}}
>
Resize the window
</h1>
)
}/** @jsxImportSource restyle */
export default function ChildSelectors() {
return (
<div
css={{
color: 'black',
'> a': {
color: 'tomato',
},
}}
>
Parent
<a href="#">Link</a>
</div>
)
}This project is inspired by and builds upon the ideas and work of several other projects in the CSS-in-JS ecosystem from over the years:
- Glamor for the original
cssprop implementation - The styled-components team for the
styledfunction - Emotion for types and the modern JSX pragma
- CXS for the atomic CSS generation
Thank you to WebReflection for the restyle NPM package name.
cd example
npm install
npm run dev