# do0dle-colors

> a library to generate color schemes.

Latest version **2.2.3** (published 2024-05-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install do0dle-colors
pnpm add do0dle-colors
yarn add do0dle-colors
bun add do0dle-colors
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.3 |
| Published | 2024-05-02 |
| First published | 2023-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 55 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | do0dleman |
| Maintainers | do0dleman |
| Keywords | color schemes, generate colors, complimentary colors |

## Links

- npm: https://www.npmjs.com/package/do0dle-colors
- Repository: https://github.com/do0dleman/do0dle-colors
- Homepage: https://github.com/do0dleman/do0dle-colors#readme
- Issues: https://github.com/do0dleman/do0dle-colors/issues
- npm.io page: https://npm.io/package/do0dle-colors

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 2.2.3 (latest) — 2024-05-02
- 2.2.2 — 2024-04-28
- 2.2.0 — 2024-04-28
- 2.1.4 — 2023-12-29
- 2.1.3 — 2023-12-22
- 2.1.2 — 2023-12-22
- 2.1.1 — 2023-11-14
- 2.1.0 — 2023-11-14
- 2.0.0 — 2023-10-28
- 1.3.0 — 2023-07-26
- 1.2.8 — 2023-07-26
- 1.2.7 — 2023-06-03
- 1.2.6 — 2023-05-27
- 1.2.5 — 2023-05-27
- 1.2.4 — 2023-05-27
- … 10 more at https://npm.io/package/do0dle-colors/versions

## README

# do0dle-colors

do0dle-colors is a color scheme generation library with no dependencies that uses OkLCh under the hood to generate color schemes.

> Note that there is an error ~0.1 (depending on color) in conversion from OkLab color space into an RGB color space.

The bundle size is [currently ~3kB](https://bundlephobia.com/package/do0dle-colors).

You can check color scheme generation web app based on this library [here](https://do0dleman.github.io/hue-hub/).

## Instalation

Install with any prefered package manager such as `npm`.

`npm i do0dle-colors`

## Usage

Import **Color** object
```js
import { Color } from 'do0dle-colors'
```
Create **Color** instance
```js 
const color = new Color('#ff440e')
```
Use **getColorScheme** and specify amount of colors in color scheme
```js
const colors = color.getColorScheme(10)
```

### Generation methods

You can specify color scheme generation method
```js
color.getColorScheme(10, 'monochromatic')
```
Or using distinct methods for more customization
```js
// similar to color.getColorScheme(10, 'analogous')
// but only hue is being changed 
color.getAnalogous(10) 

// but you can specify more parameters
const step = 10
color.getAnalogous(10, step) 
``` 
You can get an array of avalible generation methods
```js
import { genMethods } from 'do0dle-colors'
```

Here is the table of avalible generation methods:

|    Color scheme     |
|---------------------|
|     analogous       |
|    complimentary    |
|    monochromatic    |
|      quadratic      |
| split complimentary |
|      tetraidic      |
|       triadic       |

>You can learn more about them [here](https://en.wikipedia.org/wiki/Color_scheme).

### Color constructors

You can create **Color** instance via:

* hex string: 
```js
new Color('#ff0ae7')
```
* css rgb, hsl or oklch property:
```js
new Color('rgb(255 10 231)')
new Color('rgb(255, 10, 231)')

new Color('hsl(306deg 100% 52%)')
new Color('hsl(0.85turn 100% 52%)')

new Color('oklch(74% .63 210)')
new Color('oklch(74% .63 3.67rad)')
```
* hsl, rgb or oklch array:
```js
//non-normalized color data
new Color([255, 10, 231], 'rgb')
new Color([306, 100, 52], 'hsl')

//Normalized color data
new Color([1, 0.039, 0.906], 'rgb', true)
new Color([0.85, 1, 0.52], 'hsl', true)

// isNormalized is not considered with oklch
// Lightness and Chroma must be in [0;1] 
// and hue must be in degrees
new Color([.56, .12, 240])  
new Color([.56, .12, 240], 'OkLCh')  
```

### Color get methods 

You can get **Color**'s color value as:

* css oklch property string:
```js
const color = new Color([.54, .34, 121])
color.getCssOklch() // 'oklch(54% 34% 121)'
```
* css hsl property string:
```js
const color = new Color([306, 100, 52], 'hsl')
color.getCssHsl() // 'hsl(306deg 100% 52%)'
```
* css rgb property string:
```js
const color = new Color([306, 100, 52], 'hsl')
color.getCssRgb() // 'rgb(255 10 231)'
```
* hex string:
```js
const color = new Color([306, 100, 52], 'hsl')
color.getCssHex() // '#FF0AE7'
```
* OkLCh array:
```js
const color = new Color([.54, .34, 121])
color.getOkLChArray() // [.54, .34, 121]
```
* hsl array:
```js
const color = new Color([306, 100, 52], 'hsl')
color.getHslArray() // [306, 100, 52]
```
* rgb array:
```js
const color = new Color([306, 100, 52], 'hsl')
color.getRgbArray() // [255, 10, 231]
```

### Color Conversion Functions

If you need to convert one color type to another directly you can used provided conversion functions:
```ts
import { ConversionFunctions } from 'do0dle-colors'
ConversionFunctions.hslToRgb([306, 1, .52]) // [255, 10, 231]
```
## License

See the [LICENSE](https://github.com/do0dleman/do0dle-colors/blob/master/LICENSE.md) file for license rights and limitations (MIT).

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