# @saas-ui/palette

> Color palette generator for Chakra UI

Latest version **2.2.0** (published 2024-10-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @saas-ui/palette
pnpm add @saas-ui/palette
yarn add @saas-ui/palette
bun add @saas-ui/palette
```

## Health

**Score 50/100 (C)** — status: stable.

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

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.2.0 |
| Published | 2024-10-23 |
| First published | 2021-10-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 27.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1649 |
| Author | Eelco Wiersma <eelco@appulse.nl> |
| Maintainers | eelcow |
| Keywords | react, ui, chakra-ui, design-system, react-components, uikit, accessible, components, emotion, library, design-system, hotkeys, keyboard-shortcuts |

## Links

- npm: https://www.npmjs.com/package/@saas-ui/palette
- Repository: https://github.com/saas-js/saas-ui
- Homepage: https://saas-ui.dev/
- npm.io page: https://npm.io/package/@saas-ui/palette

## Dependencies (1)

- [chroma-js](https://npm.io/package/chroma-js.md) ^2.6.0

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@mesalvo/react-ui](https://npm.io/package/@mesalvo/react-ui.md) — 1.7K weekly downloads

## Recent versions

- 2.2.0 (latest) — 2024-10-23
- 2.0.0-rc.4 (next) — 2023-05-27
- 0.0.2-beta (beta) — 2021-10-19
- 2.1.1 — 2024-02-19
- 2.1.0 — 2023-09-15
- 2.0.0 — 2023-06-30
- 2.0.0-next.3 — 2023-05-10
- 2.0.0-next.2 — 2023-05-08
- 1.3.2 — 2023-05-05
- 1.3.1 — 2023-05-05
- 2.0.0-next.1 — 2023-02-17
- 2.0.0-next.0 — 2023-02-17
- 1.3.0 — 2023-01-15
- 1.2.0 — 2022-11-01
- 1.1.0 — 2022-08-06
- … 23 more at https://npm.io/package/@saas-ui/palette/versions

## README

<p align='center'>
<img src="./apps/website/public/saasui.svg#gh-light-mode-only" alt="Saas UI logo" height="60px" />
<img src="./apps/website/public/saasui-dark.svg#gh-dark-mode-only" alt="Saas UI logo" height="60px" />
</p>

<p align='center'>A design system and source component registry for SaaS products</p>

<p align="center">
  <a href="https://www.npmjs.com/package/@saas-ui/cli">
    <img src="https://img.shields.io/npm/v/@saas-ui/cli/rc" alt="Saas UI CLI on npm">
  </a>
  <a href="https://www.npmjs.com/package/@saas-ui/chakra-preset">
    <img src="https://img.shields.io/npm/v/@saas-ui/chakra-preset" alt="Saas UI Chakra preset on npm">
  </a>
  <img alt="MIT License" src="https://img.shields.io/github/license/saas-js/saas-ui"/>
  <a href="https://twitter.com/intent/follow?screen_name=saas_js">
    <img src="https://img.shields.io/twitter/follow/saas_js" alt="follow on Twitter">
  </a>
</p>

<hr />

Saas UI helps teams build B2B applications and dashboards with Chakra UI. Chakra
primitives come from `@chakra-ui/react`, Saas UI tokens and recipes come from
`@saas-ui/chakra-preset`, and editable compositions such as Sidebar are
installed into applications with `@saas-ui/cli`.

This repository contains the preset, registry compiler and templates, CLI,
supporting packages, examples, and documentation website.

## Get started

Initialize an existing React project:

```sh
npx @saas-ui/cli@rc init
```

Add editable components or compositions:

```sh
npx @saas-ui/cli@rc add sidebar
```

Initialization installs compatible Chakra, Emotion, and preset dependencies,
creates `components.json`, and installs local provider setup. See the
[CLI README](packages/saas-ui-cli/README.md) for command details.

Existing `@saas-ui/react` users should follow the
[migration guide](MIGRATION.md). The package remains available during the
transition; this repository does not claim that npm deprecation or removal has
already occurred.

## Links

💡 [Documentation](https://saas-ui.dev/docs)

🧭 [Roadmap](https://roadmap.saas-ui.dev)

🖼 [Storybooks](https://storybook.saas-ui.pro)

🌟 [Saas UI Pro](https://saas-ui.dev/#pro-features)

## Sponsors ❤️

Saas UI is sponsored by these amazing companies and people.

- [LocalXPose](https://localxpose.io/)
- Frank Faubert

## Contributing & Support

Want to help? Great! Check out the [contributing guidelines](CONTRIBUTING.md)
and feel free to open a PR or
[discussion](https://github.com/saas-js/saas-ui/discussions/new) for feature
requests and feedback.

If you'd like to support the project financially, you can
[become a sponsor](https://github.com/sponsors/saas-js) of Saas UI or consider
ordering
[Saas UI Pro Beta](https://saas-ui.lemonsqueezy.com/checkout/buy/5c76854f-738a-46b8-b32d-932a97d477f5).
All funds will go toward the further development of Saas UI. This will give you
access to the private Git repository with the beta and our private Discord
server for support.

### Open source

The open-source distribution includes:

- Chakra tokens, recipes, semantic styling, and system configuration
- Editable registry components and application compositions
- CLI initialization, installation, migration, diff, and update workflows
- Supporting hooks, forms, authentication, and modal packages

### Pro

A premium catalog of editable application blocks for SaaS products. Pro blocks
are installed as source through the authenticated registry and can compose
public registry items.

![theme-tokens](https://user-images.githubusercontent.com/32583/172424112-72bacfdd-17df-4024-81db-690dc47d0c81.png)

- Example Next.js SaaS app (https://demo.saas-ui.dev)
- Authentication screens (Supabase/Magic/Clerk/Custom)
- App layout
- DataGrid and DataBoard (Kanban) with filtering/pagination
- User account pages
- Settings pages
- Feature flags
- Billing/subscription management (Lemonsqueezy)
- Mocked API with React Query
- Custom color schemes
- Glass theme
- Onboarding flows
- Example pages (CRM, Inbox)

## Using this repo

The docs website depends on private packages (`@saas-ui-pro/react`), and won't
build fully without access to the private Git submodule.

This repository is a pnpm workspace. Install pnpm 10 or newer, then run:

```bash
pnpm install
```

### Storybook

```bash
pnpm storybook
```

### Build

```bash
pnpm build:packages
```

### Website

Run the documentation website with:

```bash
pnpm dev:web
```

## License

All code in this repository, except for the Saas UI branding assets are licensed
under MIT.

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