antd-color-editor
Version:
An open-source color editor for designing color system
208 lines (122 loc) โข 6.1 kB
Markdown
<a name="readme-top"></a>
<div align="center">
<img width="160" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg">
<h1>Antd Color Studio</h1>
[**๐จ Quick Start >>**](https://ant-design.github.io/antd-color-editor/~demos/colorstudio-demo-demo)
An open-source color editor for designing color system
[Changelog](./CHANGELOG.md) ยท [Report Bug][issues-url] ยท [Request Feature][issues-url]
<!-- SHIELD GROUP -->
[![release][release-shield]][release-url]
[![releaseDate][release-date-shield]][release-date-url]
[![ciTest][ci-test-shield]][ci-test-url]
[![ciRelease][ci-release-shield]][ci-release-url] <br/>
[![contributors][contributors-shield]][contributors-url]
[![forks][forks-shield]][forks-url]
[![stargazers][stargazers-shield]][stargazers-url]
[![issues][issues-shield]][issues-url]
[](https://ant-design.github.io/antd-color-editor/~demos/colorstudio-demo-demo)
</div>
<details>
<summary><kbd>Table of contents</kbd></summary>
#### TOC
- [๐ฆ Installation](#-installation)
- [๐จ Usage](#-usage)
- [Base on HCT](#base-on-hct)
- [Color Space](#color-space)
- [Color Accessibility](#color-accessibility)
- [Token Mode](#token-mode)
- [Setting Export](#setting-export)
- [โจ๏ธ Local Development](#๏ธ-local-development)
- [๐ค Contributing](#-contributing)
- [๐ Links](#-links)
####
</details>
## ๐ฆ Installation
To install components, run the following command:
```bash
pnpm add antd-color-editor
```
<div align="right">
[![][back-to-top]](#readme-top)
</div>
## ๐จ Usage
### Base on HCT
Resources: [The Science of Color & Design](https://material.io/blog/science-of-color-design)
| <img src="https://lh3.googleusercontent.com/FgfF6od_qjYXbXowPPgL3IQ8T0QnEAZnoehlRcXHSXK7QXfHe_LvBm3SeYIkxhSRn3gBjjH4GEO6DYOex8btaN34lVDSzP7ZULMMSqoE7bsxyCWA0Q=w1400-v0" height="240" /> | <img src="https://lh3.googleusercontent.com/PWM-JWdCtOxcGHHoiZfm1HkSNNcMRXyGE4CRapU1lrFHo93W1dqHACB24x7FCuqFKA-6LTBMhEtSHsMkZcu8EsOrNaUWE6ixtknM1Sv7hhpHwvLWcG1-=w1400-v0" height="240" /> |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
### Color Space

### Color Accessibility

### Token Mode

### Setting Export

<div align="right">
[![][back-to-top]](#readme-top)
</div>
## โจ๏ธ Local Development
You can use Gitpod for online development:
[][gitpod-url]
Or clone it for local development:
```bash
$ git clone https://github.com/ant-design/antd-color-editor.git
$ cd antd-color-editor
$ pnpm install
$ pnpm start
```
<div align="right">
[![][back-to-top]](#readme-top)
</div>
## ๐ค Contributing
<!-- CONTRIBUTION GROUP -->
> ๐ Total: <kbd>**3**</kbd>
<a href="https://github.com/apps/dependabot" title="dependabot[bot]">
<img src="https://avatars.githubusercontent.com/in/29110?v=4" width="50" />
</a>
<a href="https://github.com/canisminor1990" title="canisminor1990">
<img src="https://avatars.githubusercontent.com/u/17870709?v=4" width="50" />
</a>
<a href="https://github.com/actions-user" title="actions-user">
<img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
</a>
<!-- CONTRIBUTION END -->
<div align="right">
[![][back-to-top]](#readme-top)
</div>
## ๐ Links
- material-color-utilities: <https://github.com/material-foundation/material-color-utilities>
<div align="right">
[![][back-to-top]](#readme-top)
</div>
---
#### ๐ License
This project is [MIT](./LICENSE) licensed.
<!-- LINK GROUP -->
[gitpod-url]: https://gitpod.io/#https://github.com/ant-design/antd-color-editor
<!-- SHIELD LINK GROUP -->
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
<!-- release -->
[release-shield]: https://img.shields.io/npm/v/antd-color-editor?logo=npm
[release-url]: https://www.npmjs.com/package/antd-color-editor
<!-- releaseDate -->
[release-date-shield]: https://img.shields.io/github/release-date/ant-design/antd-color-editor?style=flat
[release-date-url]: https://github.com/ant-design/antd-color-editor/releases
<!-- ciTest -->
[ci-test-shield]: https://github.com/ant-design/antd-color-editor/workflows/Test%20CI/badge.svg
[ci-test-url]: https://github.com/ant-design/antd-color-editor/actions/workflows/test.yml
<!-- ciRelease -->
[ci-release-shield]: https://github.com/ant-design/antd-color-editor/workflows/Build%20and%20Release/badge.svg
[ci-release-url]: https://github.com/ant-design/antd-color-editor/actions/workflows/release.yml
<!-- contributors -->
[contributors-shield]: https://img.shields.io/github/contributors/ant-design/antd-color-editor.svg?style=flat
[contributors-url]: https://github.com/ant-design/antd-color-editor/graphs/contributors
<!-- forks -->
[forks-shield]: https://img.shields.io/github/forks/ant-design/antd-color-editor.svg?style=flat
[forks-url]: https://github.com/ant-design/antd-color-editor/network/members
<!-- stargazers -->
[stargazers-shield]: https://img.shields.io/github/stars/ant-design/antd-color-editor.svg?style=flat
[stargazers-url]: https://github.com/ant-design/antd-color-editor/stargazers
<!-- issues -->
[issues-shield]: https://img.shields.io/github/issues/ant-design/antd-color-editor.svg?style=flat
[issues-url]: https://github.com/ant-design/antd-color-editor/issues/new/choose