# @spicy-ui/styled-system

> Responsive, theme-based style props for building design systems with React

Latest version **0.0.1-alpha.3** (published 2021-02-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @spicy-ui/styled-system
pnpm add @spicy-ui/styled-system
yarn add @spicy-ui/styled-system
bun add @spicy-ui/styled-system
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-alpha.3 |
| Published | 2021-02-01 |
| First published | 2021-01-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 358.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Alex Gabites |
| Maintainers | south-paw, resir014 |
| Keywords | react, css-in-js, styled-components, emotion |

## Links

- npm: https://www.npmjs.com/package/@spicy-ui/styled-system
- Repository: https://github.com/spicy-ui/styled-system
- Issues: https://github.com/spicy-ui/styled-system/issues
- npm.io page: https://npm.io/package/@spicy-ui/styled-system

## Dependencies (3)

- [csstype](https://npm.io/package/csstype.md) ^3.0.6
- [@emotion/memoize](https://npm.io/package/@emotion/memoize.md) ^0.7.5
- [@emotion/is-prop-valid](https://npm.io/package/@emotion/is-prop-valid.md) ^1.0.0

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 0.0.1-alpha.3 (latest) — 2021-02-01
- 0.0.1-alpha.2 — 2021-01-30
- 0.0.1-alpha.1 — 2021-01-30

## README

# styled-system

🌶️ Responsive, theme-based style props for building design systems with React

[![npm](https://img.shields.io/npm/v/@spicy-ui/styled-system.svg)](https://www.npmjs.com/package/@spicy-ui/styled-system)
[![Dependencies](https://david-dm.org/spicy-ui/styled-system/status.svg)](https://david-dm.org/spicy-ui/styled-system)
[![Dev Dependencies](https://david-dm.org/spicy-ui/styled-system/dev-status.svg)](https://david-dm.org/spicy-ui/styled-system?type=dev)

## ⚠️ Caution

While it is _almost_ a direct port of [styled-system](https://github.com/styled-system/styled-system) to TypeScript it does have a few minor changes.

- `bg` is now for the `background` css property (but it still uses the `color` scale) and `bgColor` has been added
- there are a bunch of new aliased props (e.g. `h` for `height`, `maxW` for `max-width`, etc)
- there is an `extendedFlexbox` and `extendedGrid` parser which contains shorthands for `flexbox` and `grid` parsers (good for Flex and Grid components)
- the `css` function now supports a collection of pseudo selectors (e.g. `_hover` for `&:hover`)
- new `animation` and `transition` parsers (and scales) which are also rolled into the `css` function

A major part that is incomplete in this package is the types (both exported and internal and particulary around the `css` export) - if you're able and willing to have a crack at them please do, it would be super appreciated to get some help on this.

## Issues and Bugs

If you happen to find any, please report them [here](https://github.com/spicy-ui/core/issues) so they can be squashed.

## License

MIT, see the [LICENSE](./LICENSE) file.

---
_Source: https://npm.io/package/@spicy-ui/styled-system · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
