https://github.com/thednp/color

🎨 Fast color conversion tool made in TypeScript
https://github.com/thednp/color

Last synced: 30 days ago
JSON representation

🎨 Fast color conversion tool made in TypeScript

• Host: GitHub
• URL: https://github.com/thednp/color
• Owner: thednp
• License: mit
• Created: 2022-07-28T09:10:35.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T20:28:12.000Z (about 2 months ago)
• Last Synced: 2024-09-18T01:24:19.639Z (about 2 months ago)
• Language: TypeScript
• Size: 987 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Color

[![Coverage Status](https://coveralls.io/repos/github/thednp/color/badge.svg)](https://coveralls.io/github/thednp/color)

[![ci](https://github.com/thednp/color/actions/workflows/ci.yml/badge.svg)](https://github.com/thednp/color/actions/workflows/ci.yml)

[![NPM Version](https://img.shields.io/npm/v/@thednp/color.svg)](https://www.npmjs.com/package/@thednp/color)

[![NPM Downloads](https://img.shields.io/npm/dm/@thednp/color.svg)](http://npm-stat.com/charts.html?package=@thednp/color)

[![jsDeliver](https://img.shields.io/jsdelivr/npm/hw/@thednp/color)](https://www.jsdelivr.com/package/npm/@thednp/color)

[![typescript version](https://img.shields.io/badge/typescript-5.5.4-brightgreen)](https://www.typescriptlang.org/)

[![eslint version](https://img.shields.io/badge/eslint-8.57.0-brightgreen)](https://github.com/eslint)

[![prettier version](https://img.shields.io/badge/prettier-2.8.8-brightgreen)](https://prettier.io/)

[![vitest version](https://img.shields.io/badge/vitest-2.0.5-brightgreen)](https://vitest.dev/)

[![vite version](https://img.shields.io/badge/vite-5.4.3-brightgreen)](https://github.com/vitejs)

A TypeScript flavored fork of the excelent [TinyColor](https://github.com/bgrins/TinyColor) optimized for [ColorPicker](https://github.com/thednp/color-picker) with new features and improvements:

- added support for HWB(a) colors (Hue, Whiteness, Blackness);

- added support for CSS4 Color module (`rgb(40 74 200 / 90%)`, `hsl(227deg 67% 47% / 90%)`)

- improved regular expressions;

- tree shaking;

- slightly faster performance;

- stronger and more strict types.

### Install

```js

npm install @thednp/color

```

### Quick Usage

```js

import Color from "@thednp/color";

// provide a web colour, the constructor will determine

const myHEXColor = new Color("red", "hex").toString();

// => { r: 250, g: 0, b: 0, a: 1, ok: true, originalInput: 'red', ...}

// use the value where you need it

Object.assign(myElement.style, { color: myHEXColor.toString() });

// => #ff0000

```

### Wiki

For a more detailed guide please visit the wiki page at [Color Wiki](https://github.com/thednp/color/wiki)!

### Thanks

- Brian Grinstead for his original [TinyColor](https://github.com/bgrins/TinyColor)

- Scott Cooper for his awesome version of [TinyColor](https://github.com/scttcper/tinycolor)

### License

**Color** is released under the [MIT License](https://github.com/thednp/color/blob/master/LICENSE)