# color-palette-box

> ![Screenshot](static/color-palette-box-preview.png)

Latest version **2.1.0** (published 2022-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install color-palette-box
pnpm add color-palette-box
yarn add color-palette-box
bun add color-palette-box
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2022-06-15 |
| First published | 2022-05-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 59 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | willi-dev |
| Maintainers | willi-dev |
| Keywords | react, color-palette, design-system, storybook, mdx |

## Links

- npm: https://www.npmjs.com/package/color-palette-box
- Repository: https://github.com/willi-dev/color-palette-box
- Homepage: https://github.com/willi-dev/color-palette-box#readme
- Issues: https://github.com/willi-dev/color-palette-box/issues
- npm.io page: https://npm.io/package/color-palette-box

## Dependencies (2)

- [@emotion/react](https://npm.io/package/@emotion/react.md) ^11.9.0
- [@emotion/styled](https://npm.io/package/@emotion/styled.md) ^11.8.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.1.0 (latest) — 2022-06-15
- 1.0.0 (prerelease) — 2022-05-22
- 2.0.1 — 2022-06-08
- 2.0.0 — 2022-05-23
- 1.0.5 — 2022-05-22
- 1.0.4 — 2022-05-22
- 1.0.3 — 2022-05-22
- 1.0.2 — 2022-05-22
- 1.0.1 — 2022-05-22
- 0.1.0 — 2022-05-22

## README

## Color Palette Box

![Screenshot](static/color-palette-box-preview.png)

React Components for display color palette name.
It can use in React App or can use in MDX storybook docs.

### Documentation

**npm**
```
npm install color-palette-box
```

**yarn**
```
yarn add color-palette-box
```

**example**
```
//import
import { ColorPaletteGroup, ColorPaletteGroupItem } from 'color-palette-box'

# create a list of your colors
const list = [
  {
    name: 'color #1',
    bgColor: '#000000',
    desc: 'description here' // optional
  },
  {
    name: 'color #2',
    bgColor: '#DFDFDF',
    desc: 'description here' // optional
  }
]

// in your component render
<ColorPaletteGroup title="title is optional">
  {
    list.map(( color, index ) => {
      return (
        <ColorPaletteGroupItem name={color.name} bgColor={color.bgColor} key={index} />
      )
    })
  }
</ColorPaletteGroup>
```

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