Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wayfair/rainbow-sprinkles
Dynamic, theme-driven, style props for vanilla-extract.
https://github.com/wayfair/rainbow-sprinkles
css css-in-js design-system react styled-system typescript vanilla-extract
Last synced: 3 months ago
JSON representation
Dynamic, theme-driven, style props for vanilla-extract.
- Host: GitHub
- URL: https://github.com/wayfair/rainbow-sprinkles
- Owner: wayfair
- License: mit
- Created: 2022-04-12T18:34:12.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-02T09:54:26.000Z (3 months ago)
- Last Synced: 2024-08-02T19:29:37.325Z (3 months ago)
- Topics: css, css-in-js, design-system, react, styled-system, typescript, vanilla-extract
- Language: TypeScript
- Homepage:
- Size: 28.5 MB
- Stars: 204
- Watchers: 9
- Forks: 17
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Rainbow Sprinkles 🧁
Dynamic, theme-driven, style props for vanilla-extract
[](/packages/rainbow-sprinkles/CHANGELOG.md)
[](LICENSE)
[](CODE_OF_CONDUCT.md)
[](https://wayfair.github.io)
Rainbow sprinkles works similarly to `@vanilla-extract/sprinkles`. Like sprinkles, it generates custom CSS utility classes at build time. While sprinkles requires a pre-defined list of available values, Rainbow Sprinkles uses CSS custom properties to allow dynamic values using inline style variable assignments.
Compared to sprinkles:
- **Rainbow sprinkles ships a fraction of the CSS.** For each property, Sprinkles produces CSS that's a factor of `[pre-defined values] * [possible conditions]`. Rainbow sprinkles produces CSS that only scales with the number of conditions.
- **Supports dynamic values.** Rainbow Sprinkles uses dynamic inline style assignments to set the value of each property. You still get the TypeScript editor suggestions, but the ability to use any valid CSS value for that property.
```tsx
function App() {
return (
// Use pre-defined values
{/* Or any valid CSS value */}
Hello world!
);
}
```
[See a stackblitz demo here!](https://stackblitz.com/edit/rainbowsprinkles-m3jek9?file=src/components/rainbow-sprinkles.css.ts)
## Setup
Install Rainbow Sprinkles.
```bash
npm install rainbow-sprinkles
```
Create a `rainbow-sprinkles.css.ts` file, then create and export your `rainbowSprinkles` function:
```typescript
// rainbow-sprinkles.css.ts
import { defineProperties, createRainbowSprinkles } from 'rainbow-sprinkles';
// or import a theme (e.g. `createTheme`, `createThemeContract`)
const vars = {
space: {
none: '0',
small: '4px',
medium: '8px',
large: '16px',
// etc.
},
colors: {
blue50: '#eff6ff',
blue100: '#dbeafe',
blue200: '#bfdbfe',
gray700: '#374151',
gray800: '#1f2937',
gray900: '#111827',
// etc.
},
};
const responsiveProperties = defineProperties({
conditions: {
mobile: {},
tablet: { '@media': 'screen and (min-width: 768px)' },
desktop: { '@media': 'screen and (min-width: 1024px)' },
},
defaultCondition: 'mobile',
dynamicProperties: {
// Define pre-determined values, which will be autosuggested
color: vars.colors,
backgroundColor: vars.colors,
margin: vars.space,
marginTop: vars.space,
marginLeft: vars.space,
marginRight: vars.space,
marginBottom: vars.space,
// Will work with any CSS value
display: true,
textAlign: true,
flexDirection: true,
justifyContent: true,
alignItems: true,
},
staticProperties: {
// Build out utility classes that don't use CSS variables
display: ['block', 'flex', 'inline-block', 'inline-flex'],
},
shorthands: {
bg: ['backgroundColor'],
m: ['margin'],
mr: ['marginRight'],
ml: ['marginLeft'],
mt: ['marginTop'],
mb: ['marginBottom'],
marginX: ['marginLeft', 'marginRight'],
marginY: ['marginTop', 'marginBottom'],
mx: ['marginLeft', 'marginRight'],
my: ['marginTop', 'marginBottom'],
},
});
export const rainbowSprinkles = createRainbowSprinkles(responsiveProperties);
export type Sprinkles = Parameters[0];
```
Then set-up in your "host" component (in this case, a Box component):
```tsx
// Box.tsx
import { rainbowSprinkles, Sprinkles } from './rainbow-sprinkles.css';
interface BoxProps extends Sprinkles {
children?: React.ReactNode;
}
export const Box = ({ children, ...props }: BoxProps) => {
const { className, style, otherProps } = rainbowSprinkles(props);
return (
{children}
);
};
```
🎉 Good to go!
```tsx
// App.tsx
import { Box } from './Box';
function App() {
return (
// Use pre-defined values
{/* Or any valid CSS value */}
Hello world!
);
}
```
## CSS Layers
You can define a [css layer](https://developer.mozilla.org/en-US/docs/Web/CSS/@layer) for a given set of properties.
```typescript
// rainbow-sprinkles.css.ts
import { layer } from '@vanilla-extract/css';
import { defineProperties } from 'rainbow-sprinkles';
export const sprinklesLayer = layer();
const properties = defineProperties({
'@layer': sprinklesLayer
// etc.
});
```
### `dynamicProperties` vs `staticProperties`
One trade off that's made for supporting dynamic values is that we have to increase the size of the document. Instead of just appending a single class to an element to add a style, both a utility class and an inline style assignment is added to an element. While this setup will still produce an overall smaller bundle in many cases, some large applications may observe frequent recurrence of specific combinations of CSS properties and values. In these cases, those combinations can be set-up in `staticProperties` in the initial configuration. `staticProperties` will produce typical CSS utility classes. The runtime portion of Rainbow Sprinkles will defer to the CSS classes created by `staticProperties` and not apply any inline style assignments.
Here's an example scenario in which this property could be valuable. Your organization sets up Rainbow Sprinkles and sees widespread adoption. Your metrics reveal that the most frequently used prop/value combinations is `display="flex"` and `margin` with the application's theme variables. You can run an experiment to evaluate whether making these property/values combination static improves the bundle size.
```tsx
createRainbowSprinkles({
dynamicProperties: {
// Still support arbitrary values
display: true,
margin: true,
},
staticProperties: {
// Also produce fixed CSS classes
display: ['flex'],
margin: vars.space,
},
});
```
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. For detailed contributing guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md)
## Thanks
- [Vanilla Extract](https://vanilla-extract.style) for creating an inovative and configurable CSS preprocessor
- [Styled System](https://styled-system.com) for inventing theme-driven style props
- Homebase, Wayfair's design system, for providing interesting problems to solve
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
- The Homebase Engineering Team - [email](mailto:[email protected])
- Rogin Farrer - [@roginfarrer](https://twitter.com/roginfarrer)