# react-color-class

> some common color classes

Latest version **0.0.7** (published 2018-04-03) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install react-color-class
pnpm add react-color-class
yarn add react-color-class
bun add react-color-class
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2018-04-03 |
| First published | 2018-03-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | gim |
| Maintainers | gimholg |
| Keywords | react, color, class |

## Links

- npm: https://www.npmjs.com/package/react-color-class
- npm.io page: https://npm.io/package/react-color-class

## 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

- 0.0.7 (latest) — 2018-04-03
- 0.0.6 — 2018-03-29
- 0.0.5 — 2018-03-29
- 0.0.4 — 2018-03-29
- 0.0.3 — 2018-03-29
- 0.0.2 — 2018-03-29
- 0.0.1 — 2018-03-28

## README

# react-color-class
一系列颜色类型，能方便的对颜色进行处理、以及互相转换。目前RGB、RGBA、HSV。

## HSV
HSV(HSB)颜色类。
[什么是HSB](https://baike.baidu.com/item/hsb/10338413)

### 定义与使用 | Definition & Usage

```js
var colorHSV = new HSV(0,1,1); // Red;
```

### 对象属性 | Properties

| 属性名 Property | 描述 Descrition|
| --------| -----|
| h| 色调(0-360)。|
| s| 饱和度(0-1)。|
| b| 明亮度(0-1)。|

### 对象方法 | Methods

| 方法名 Method | 描述 Descrition|
| --------| -----|
| getH | 获取色调。 |
| setH | 设置色调0-360)。 |
| getS | 获取饱和度。 |
| setS | 设置饱和度(0-1)。 |
| getB | 获取明亮度。 |
| setB | 设置明亮度(0-1)。 |
| getV | 同getB。 |
| setV | 同setB。 |
| copy | 返回一份拷贝。|
| toString| 返回字符串。|
| stripSB | 返回一个抛弃饱和度和明亮度的拷贝。|
| toRGB | 返回一个RGB格式的颜色。 |

## RGB
RGB颜色类。

### 定义与使用 | Definition & Usage

```js
var colorRGB = new RGB(255,255,255); // White;
```
### 静态属性 | Static Properties

| 属性名 Property | 描述 Descrition|
| --------| -----|
| White| 白色。|
| Black| 黑色。|

### 对象属性 | Properties

| 属性名 Property | 描述 Descrition|
| --------| -----|
| r| 红色值(0-255)。|
| g| 绿色值(0-255)。|
| b| 蓝色值(0-255)。|

### 对象方法 | Methods

| 方法名 Method | 描述 Descrition|
| --------| -----|
| getR| 获取红色值。 |
| getG| 获取绿色值。 |
| getB| 获取蓝色值。 |
| setR| 设置红色值(0-255)。 |
| setG| 设置绿色值(0-255)。 |
| setB| 设置蓝色值(0-255)。 |
| copy| 返回一份拷贝。|
| toString| 返回字符串。|
| toHex| 返回十六进制格式颜色的字符串。|
| toHSV| 返回一个Hsv格式颜色。|

## RGBA
RGBA颜色类。

### 定义与使用 | Definition & Usage

```js
var colorRGBA = new RGBA(255,255,255,255); // White;
```
### 静态属性 | Static Properties

| 属性名 Property | 描述 Descrition|
| --------| -----|
| White| 白色。|
| Black| 黑色。|
| WhiteT| 白色透明。|
| BlackT| 黑色透明。|

### 静态方法 | Static Methods

| 方法名 Method | 描述 Descrition|
| --------| -----|
| fromHex| 通过十六进制格式颜色的字符串，创建RGBA颜色类。|
| fromRGB| 通过一个RGB颜色类实例，与一个透明度，创建RGBA颜色类。|


### 静态属性 | Static Properties

| 属性名 Property | 描述 Descrition|
| --------| -----|
| White| 白色。|
| Black| 黑色。|
| WhiteT| 白色透明。|
| BlackT| 黑色透明。|

### 对象属性 | Properties

| 属性名 Property | 描述 Descrition|
| --------| -----|
| r| 红色值(0-255)。|
| g| 绿色值(0-255)。|
| b| 蓝色值(0-255)。|
| a| 透明度(0-255)。|

### 对象方法 | Methods

| 方法名 Method | 描述 Descrition|
| --------| -----|
| getR| 获取红色值。 |
| getG| 获取绿色值。 |
| getB| 获取蓝色值。 |
| setR| 设置红色值(0-255)。 |
| setG| 设置绿色值(0-255)。 |
| setB| 设置蓝色值(0-255)。 |
| getA| 获取透明度。|
| setA| 设置透明度(0-255)。 |
| copy| 返回一份拷贝。|
| toString| 返回字符串。|
| setRGB| 通过一个RGB颜色类实例，设置自己数据。|
| toRGB| 返回RGB颜色类实例，将丢弃透明度。 |
| toHex| 返回十六进制格式颜色的字符串。|
| toHSV| 返回一个Hsv颜色类实例，将丢弃透明度。|

## TODO

### 修改RGB：
  改为用一个整数类型数据来存放RGB信息。
  RGB添加fromHex。

### 修改RGBA：
  改为用一个整数类型数据来存放RGBA信息。
  fromHex，兼容RGB的16位颜色格式。

### 更多颜色类：
  LAB格式与CMYK格式的颜色类型。

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