colorizr 2.1.1 → 3.0.0-1

package/README.md

@@ -1,14 +1,14 @@
 # Colorizr
 
-[![NPM version](https://badge.fury.io/js/colorizr.svg)](https://www.npmjs.com/package/colorizr) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/colorizr)](https://bundlephobia.com/result?p=colorizr) [![CI](https://github.com/gilbarbara/colorizr/actions/workflows/main.yml/badge.svg)](https://github.com/gilbarbara/colorizr/actions/workflows/main.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/6d686ce2a9f2a1a47d98/maintainability)](https://codeclimate.com/github/gilbarbara/colorizr/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/6d686ce2a9f2a1a47d98/test_coverage)](https://codeclimate.com/github/gilbarbara/colorizr/test_coverage)
+[![NPM version](https://badge.fury.io/js/colorizr.svg)](https://www.npmjs.com/package/colorizr) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/colorizr)](https://bundlephobia.com/result?p=colorizr) [![CI](https://github.com/gilbarbara/colorizr/actions/workflows/main.yml/badge.svg)](https://github.com/gilbarbara/colorizr/actions/workflows/main.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gilbarbara_colorizr&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=gilbarbara_colorizr) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=gilbarbara_colorizr&metric=coverage)](https://sonarcloud.io/summary/new_code?id=gilbarbara_colorizr)
 
-Color conversion, manipulation, comparison, and analysis.
+Color conversion, generation, manipulation, comparison, and analysis.
 
 ## Highlights
 
-- 🏖 **Easy to use**: Works with HSL and RGB, including CSS strings
+- 🏖 **Easy to use**: Works with Hex, HSL, OkLab, OkLCH, and RGB.
 - ♿️ **Accessibility:** WCAG analysis and comparison.
-- 🛠 **Small:** Less than 6k (gzipped) and zero dependencies.
+- 🛠 **Small:** Less than 7k (gzipped) and tree-shakable.
 - 🟦 **Modern:** Written in Typescript.
 
 ## Setup
@@ -16,40 +16,47 @@ Color conversion, manipulation, comparison, and analysis.
 **Install**
 
 ```bash
-npm install --save colorizr
+npm i colorizr
 ```
 
 ## Usage
 
+You can use all the functions standalone:
+
 ```typescript
 import { luminance } from 'colorizr';
 
 const lux = luminance('#ff0044'); // 0.2168
 ```
 
-Or you can create an instance to access all methods:
+Or you can create an instance to use all the methods for the same color:
 
 ```typescript
 import Colorizr from 'Colorizr';
 
-const colorizr = new Colorizr('#ff0044');
+const colorInstance = new Colorizr('#ff0044');
+colorInstance.luminance; // 0.2168
+colorInstance.chroma; // 1
+colorInstance.opacity; // 1
 ```
 
-## Methods
+## API
 
-> String inputs accept css values: hex, rgb(a), hsl(a) and named colors.
+> String inputs accept css values: hex, hsl, oklab, oklch, rgb, and named colors.
 
-**brightnessDifference(left: string, right: string): number**  
-_get the brightness difference between 2 colors_
+- [Info](#Info)
+- [Manipulators](#Manipulators)
+- [Converters](#Converters)
+- [Generators](#Generators)
+- [Comparison](#Comparison)
+- [Utilities](#Utilities)
+- [Validators](#Validators)
+- [Class](#Class)
 
-```typescript
-import { brightnessDifference } from 'colorizr';
-
-brightnessDifference('#fff', 'rgb(255, 0, 68)'); // 171.003
-```
+### Info
 
 **chroma(input: string): number**  
-_get the chroma of a color_
+Get the chroma of a color.
 
 ```typescript
 import { chroma } from 'colorizr';
@@ -58,24 +65,148 @@ chroma('#ff0044'); // 1
 chroma('#ffc0cb'); // 0.2471
 ```
 
+**luminance(input: string): number**  
+Get the relative brightness according to the [WCAG definition](https://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef).  
+Normalized to `0` for black and `1` for white.
+
+```typescript
+import { luminance } from 'colorizr';
+
+luminance('#ff0044'); // 0.2168
+```
+
+**name(input: string): string**  
+Get the name of a color. Return the hex code if it can't be named.
+
+```typescript
+import { name } from 'colorizr';
+
+name('#ffc0cb'); // pink
+name('rgb(176 224 230)'); // 'powderblue'
+name('hsl(344 100 50)'); // #ff0044
+```
+
+**opacity(input: string): string**  
+Get the opacity of a color.
+
+```typescript
+import { opacity } from 'colorizr';
+
+opacity('#ff0044'); // 1
+opacity('rgb(255 0 68 / 90%)'); // 0.9
+opacity('hsl(344 100 50 / 60%)'); // 0.6
+```
+
+### Manipulators
+
+**lighten(input: string, amount: number): string**  
+Get a color with increased lightness.
+
+```typescript
+import { lighten } from 'colorizr';
+
+lighten('#ff0044', 10); // #ff3369
+lighten('hsl(136 100% 50%)', 10); // hsl(136 100% 60%)
+```
+
+**darken(input: string, amount: number): string**  
+Get a color with decreased lightness.
+
+```typescript
+import { darken } from 'colorizr';
+
+darken('#ff0044', 10); // #cc0036
+darken('oklch(47.642% 0.29956 274.93693)', 10); // oklch(40.377% 0.25281 275.46794)
+```
+
+**saturate(input: string, amount: number): string**  
+Get a color with increased saturation.
+
+```typescript
+import { saturate } from 'colorizr';
+
+saturate('#ff0044', 10); // #ff0044 (already at the maximum)
+saturate('pink', 10); // #ffc0cb
+```
+
+**desaturate(input: string, alpha: number): string**  
+Get a color with decreased saturation.
+
+```typescript
+import { desaturate } from 'colorizr';
+
+desaturate('#ff0044', 10); // #f20d4a
+desaturate('oklab(70.622% 0.1374 0.14283)', 10); // oklab(69.021% 0.12176 0.13721)
+```
+
+**invert(input: string): string**  
+Invert the color.
+
+```typescript
+import { invert } from 'colorizr';
+
+invert('#07e'); // '#0077ee'
+invert('#f058'); // '#ff005588'
+```
+
+**rotate(input: string, degrees: number): string**  
+Get a color with a hue rotated by the specified degrees.
+
+```typescript
+import { rotate } from 'colorizr';
+
+rotate('#ff0044', 30); // #ff3b00
+```
+
+**opacify(input: string, alpha: number, format?: ColorType): string**  
+Add opacity to a color
+
+```typescript
+import { opacify } from 'colorizr';
+
+opacify('hsl(344, 100, 50)', 0.9); // hsl(344 100 50 / 90%)
+opacify('#ff0044', 0.8); // #ff0044cc
+```
+
+**transparentize(input: string, alpha: number, format?: ColorType): string**  
+Increase/decrease the color opacity.
+
+```typescript
+import { transparentize } from 'colorizr';
+
+transparentize('hsl(344, 100, 50)', 10); // hsl(344 100 50 / 90%)
+transparentize('#ff0044', 50, 'hsl'); // #ff004480
+```
+
+### Comparison
+
+**brightnessDifference(left: string, right: string): number**  
+Get the brightness difference between the two colors.
+
+```typescript
+import { brightnessDifference } from 'colorizr';
+
+brightnessDifference('#fff', 'rgb(255, 0, 68)'); // 171.003
+```
+
 **colorDifference(left: string, right: string): number**  
-_get the color difference between 2 colors_
+Get the color difference between the two colors.
 
 ```typescript
 import { colorDifference } from 'colorizr';
 
-colorDifference('hsl(0, 0%, 100%)', '#f04'); // 442
+colorDifference('hsl(0 0% 100%)', '#f04'); // 442
 ```
 
 **compare(left: string, right: string): Analysis**  
-_get the WCAG analysis for two colors_
+Get the WCAG analysis between two colors.
 
 ```typescript
 import { compare } from 'colorizr';
 
 compare('#ff0044', '#fff');
 
-{
+({
   "brightnessDifference": 171.003,
   "colorDifference": 442,
   "compliant": 1,
@@ -84,77 +215,105 @@ compare('#ff0044', '#fff');
   "largeAAA": false,
   "normalAA": false,
   "normalAAA": false,
-}
+})
 ```
 
 **contrast(left: string, right: string): number**  
-_get the WCAG contrast ratio between 2 colors_
+Get the WCAG contrast ratio between two colors.
 
 ```typescript
 import { contrast } from 'colorizr';
 
-contrast('hsl(0, 0%, 100%)', 'rgb(255, 0, 68)'); // 3.94
+contrast('hsl(0 0% 100%)', 'rgb(255 0 68)'); // 3.94
 ```
+### Generators
 
-**darken(input: string, amount = 10): string**  
-_get a color with decreased lightness_
+**palette(input: string, options?: PaletteOptions): string[]**  
+Generate a palette of colors.
 
 ```typescript
-import { darken } from 'colorizr';
+import { palette } from 'colorizr';
 
-darken('#ff0044', 10); // #cc0036
+palette('#ff0044');
+// ['#ff0044', '#ff7700', '#88ff00', '#00ff77', '#0088ff', '#7700ff'];
+
+palette('#ff0044', { type: 'monochromatic' });
+// ['#ff99b4', '#ff5582', '#ff1150', '#cc0036', '#880024', '#440012']
 ```
 
-**desaturate(input: string, amount: number): string**  
-_get a color with decreased saturation_
+**scheme(input: string, type: Scheme): string[]**  
+Get a color scheme.
 
 ```typescript
-import { desaturate } from 'colorizr';
+import { scheme } from 'colorizr';
 
-desaturate('#ff0044', 10); // #f20d4a
+const complementary = scheme('rgb(255 0 68)'); // ['#ff0044', '#00ffbb']
+const triadic = scheme('#ff0044', 'triadic'); // ['#ff0044', '#44ff00', '#0044ff']
 ```
 
-**fade(input: string, amount: number = 10, output?: ColorTypes = 'rgb'): string**  
-_get a transparent color_
+**swatch(input: string, variant?: 'up' | 'down'): string[]**  
+Generate a color swatch with ten shades.  
+The `variant` can be used to generate a lighter or darker swatch.
 
 ```typescript
-import { fade } from 'colorizr';
+import { swatch } from 'colorizr';
 
-fade('hsl(344, 100, 50)', 10); // rgba(255, 0, 68, 0.9)
-fade('#ff0044', 50, 'hsl'); // hsla(344, 100%, 50%, 0.5)
+const colors = swatch('#ff0044');
+/* [
+  "#ffccda",
+  "#ff99b4",
+  "#ff668f",
+  "#ff3369",
+  "#ff0044",
+  "#cc0036",
+  "#990029",
+  "#66001b",
+  "#33000e",
+  "#1a0007",
+] */
 ```
 
-**formatCSS(input: HSL | RGB, options?: FormatOptions): string**  
-_get the css string for a color model object_
+### Converters
+
+**convert(input: string, format: ColorType): string**  
+Convert a color string to another format.
 
 ```typescript
-import { formatCSS } from 'colorizr';
+import { convert } from 'colorizr';
 
-formatCSS({ h: 344, s: 100, l: 50 }, { model: 'rgb' }); // 'rgb(255, 0, 68)'
-formatCSS({ r: 255, g: 0, b: 68 }, { alpha: 0.5, model: 'hsl' }); // 'hsla(344, 100%, 50%, 0.5)'
+convert('#ff0044', 'hsl') // hsl(344 100% 50%)
+convert('rgb(255 0 68)', 'oklch') // oklch(63.269% 0.25404 19.90218)
 ```
 
-**formatHex(input: string): string**  
-_format a short hex string of 3 (or 4) digits into 6 (or 8) digits._
+**hex2hsl(input: string): HSL**  
+Convert HEX to HSL.
 
 ```typescript
-import { formatHex } from 'colorizr';
+import { hex2hsl } from 'colorizr';
 
-formatHex('#07e'); // '#0077ee'
-formatHex('#f058'); // '#ff005588'
+hex2hsl('#ff0044'); // { h: 344, s: 100, l: 50 }
 ```
 
-**hex2hsl(input: string): HSL**  
-_convert a hex string into an HSL object_
+**hex2oklab(input: string, precision?: number): LAB**  
+Convert HEX to OKLAB.
 
 ```typescript
-import { hex2hsl } from 'colorizr';
+import { hex2oklab } from 'colorizr';
 
-hex2hsl('#ff0044'); // { h: 344, s: 100, l: 50 }
+hex2oklab('#ff0044'); // { l: 0.63269, a: 0.23887, b: 0.08648 }
+```
+
+**hex2oklch(input: string, precision?: number): LCH**  
+Convert HEX to OKLCH.
+
+```typescript
+import { hex2oklch } from 'colorizr';
+
+hex2oklch('#ff0044'); // { l: 0.63269, c: 0.25404, h: 19.90218 }
 ```
 
 **hex2rgb(input: string): RGB**  
-_convert a hex string into an RGB object_
+Convert HEX to RGB.
 
 ```typescript
 import { hex2rgb } from 'colorizr';
@@ -162,161 +321,261 @@ import { hex2rgb } from 'colorizr';
 hex2rgb('#ff0044'); // { r: 255, g: 0, b: 68 }
 ```
 
-**hsl2hex(input: HSL): string**  
-_convert an HSL object into a hex string_
+**hsl2hex(input: HSL | ColorTuple): string**  
+Convert HSL to HEX.
 
 ```typescript
 import { hsl2hex } from 'colorizr';
 
 hsl2hex({ h: 344, s: 100, l: 50 }); // '#ff0044'
+hsl2hex([344, 100, 50]); // '#ff0044'
+```
+
+**hsl2oklab(input: HSL | ColorTuple, precision?: number): LAB**  
+Convert HSL to OKLAB.
+
+```typescript
+import { hsl2oklab } from 'colorizr';
+
+hsl2oklab({ h: 344, s: 100, l: 50 }); // { l: 0.63269, a: 0.23887, b: 0.08648 }
+hsl2oklab([344, 100, 50]); // { l: 0.63269, a: 0.23887, b: 0.08648 }
+```
+
+**hsl2oklch(input: HSL | ColorTuple, precision?: number): LCH**  
+Convert HSL to OKLCH.
+
+```typescript
+import { hsl2oklch } from 'colorizr';
+
+hsl2oklch({ h: 344, s: 100, l: 50 }); // { l: 0.63269, c: 0.25404, h: 19.90218 }
+hsl2oklch([344, 100, 50]); // { l: 0.63269, c: 0.25404, h: 19.90218 }
 ```
 
-**hsl2rgb(input: HSL): RGB**  
-_convert an HSL object into an RGB object_
+**hsl2rgb(input: HSL | ColorTuple): RGB**  
+Convert HSL to RGB.
 
 ```typescript
 import { hsl2rgb } from 'colorizr';
 
 hsl2rgb({ h: 344, s: 100, l: 50 }); // { r: 255, g: 0, b: 68 }
+hsl2rgb([344, 100, 50]); // { r: 255, g: 0, b: 68 }
 ```
 
-**isValidColor(input: any): boolean**  
-_check if the input can be parsed correctly_
+**oklab2hex(input: LAB | ColorTuple): string**  
+Convert OKLAB to HEX.
 
 ```typescript
-import { isValidColor } from 'colorizr';
+import { oklab2hex } from 'colorizr';
 
-isValidColor('#f04'); // true
-isValidColor('#ff0044'); // true
-isValidColor('#ff004400'); // true
-isValidColor('rgb(100, 255, 0)'); // true
-isValidColor('hsla(344, 100%, 50%)'); // true
-isValidColor('blue'); // true
-isValidColor('aliceblue'); // true
-isValidColor('#mmff00'); // false
-isValidColor('blue-ish'); // false
+oklab2hex({ l: 0.63269, a: 0.23887, b: 0.08648 }); // '#ff0044'
+oklab2hex([0.63269, 0.23887, 0.08648]); // '#ff0044'
 ```
 
-**isValidHex(input: any): boolean**  
-_check if the input is a valid hex_
+**oklab2hsl(input: LAB | ColorTuple): HSL**  
+Convert OKLAB to HSL.
 
 ```typescript
-import { isValidHex } from 'colorizr';
+import { oklab2hsl } from 'colorizr';
 
-isValidHex('#f04'); // true
+oklab2hsl({ l: 0.63269, a: 0.23887, b: 0.08648 }); // { h: 344, s: 100, l: 50 }
+oklab2hsl([0.63269, 0.23887, 0.08648]); // { h: 344, s: 100, l: 50 }
 ```
 
-**lighten(input: string, amount: number): string**  
-_get a color with increased lightness_
+**oklab2oklch(input: LAB | ColorTuple, precision?: number): LCH**  
+Convert OKLAB to OKLCH.
 
 ```typescript
-import { lighten } from 'colorizr';
+import { oklab2oklch } from 'colorizr';
 
-lighten('#ff0044', 10); // #ff3369
+oklab2oklch({ l: 0.63269, a: 0.23887, b: 0.08648 }); // { l: 0.63269, c: 0.25404, h: 19.90218 }
+oklab2oklch([0.63269, 0.23887, 0.08648]); // { l: 0.63269, c: 0.25404, h: 19.90218 }
 ```
 
-**luminance(input: string): number**  
-_get the relative brightness according to the [WCAG definition](https://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef). Normalized to `0` for black and `1` for white._
+**oklab2rgb(input: LAB | ColorTuple, precision: number = 0): RGB**  
+Convert OKLAB to RGB.
 
 ```typescript
-import { luminance } from 'colorizr';
+import { oklab2rgb } from 'colorizr';
 
-luminance('#ff0044'); // 0.2168
+oklab2rgb({ l: 0.63269, a: 0.23887, b: 0.08648 }); // { r: 255, g: 0, b: 68 }
+oklab2rgb([0.63269, 0.23887, 0.08648]); // { r: 255, g: 0, b: 68 }
 ```
 
-**name(input: string): string**  
-_get the named color. return the hex code if it can't be named_
+**oklch2hex(input: LCH | ColorTuple): string**  
+Convert OKLCH to HEX.
 
 ```typescript
-import { name } from 'colorizr';
+import { oklch2hex } from 'colorizr';
 
-name('#ffc0cb', 10); // pink
-name('rgb(176, 224, 230)'); // 'powderblue'
-name('hsl(344, 100, 50)'); // #ff0044
+oklch2hex({ l: 0.63269, c: 0.25404, h: 19.90218 }); // '#ff0044'
+oklch2hex([0.63269, 0.25404, 19.90218]); // '#ff0044'
 ```
 
-**palette(input: string, options?: PaletteOptions): string[]**  
-_get a palette for a color_
+**oklch2hsl(input: LCH | ColorTuple): HSL**  
+Convert OKLCH to HSL.
 
 ```typescript
-import { palette } from 'colorizr';
+import { oklch2hsl } from 'colorizr';
 
-palette('#ff0044');
-// ['#ff0044', '#ff7700', '#88ff00', '#00ff77', '#0088ff', '#7700ff'];
-
-palette('#ff0044', { type: 'monochromatic' });
-// ['#ff99b4', '#ff5582', '#ff1150', '#cc0036', '#880024', '#440012']
+oklch2hsl({ l: 0.63269, c: 0.25404, h: 19.90218 }); // { h: 344, s: 100, l: 50 }
+oklch2hsl([0.63269, 0.25404, 19.90218]); // { h: 344, s: 100, l: 50 }
 ```
 
-**parseCSS(input: string, output: ColorTypes = 'hex'): string | HSL | RGB**  
-_parse a css string to hex, hsl, or RGB_
+**oklch2oklab(input: LCH | ColorTuple, precision?: number): LAB**  
+Convert OKLCH to OKLAB.
 
 ```typescript
-import { parseCSS } from 'colorizr';
+import { oklch2oklab } from 'colorizr';
 
-parseCSS('hsl(270 60% 70%)'); // '#b385e0'
-parseCSS('#ff0044', 'hsl'); // { h: 344, l: 50, s: 100 }
+oklch2oklab({ l: 0.63269, c: 0.25404, h: 19.90218 }); // { l: 0.63269, a: 0.23887, b: 0.08648 }
+oklch2oklab([0.63269, 0.25404, 19.90218]); // { l: 0.63269, a: 0.23887, b: 0.08648 }
 ```
 
-**random(): string**  
-_get a random color_
+**oklch2rgb(input: LCH | ColorTuple, precision: number = 0): RGB**  
+Convert OKLCH to RGB.
 
 ```typescript
-import { random } from 'colorizr';
+import { oklch2rgb } from 'colorizr';
 
-random(); // '#b385e0'
+oklch2rgb({ l: 0.63269, c: 0.25404, h: 19.90218 }); // { r: 255, g: 0, b: 68 }
+oklch2rgb([0.63269, 0.25404, 19.90218]); // { r: 255, g: 0, b: 68 }
 ```
 
-**rgb2hex(input: RGB | RGBArray): string**  
-_convert an RGB object into a hex string_
+**rgb2hex(input: RGB | ColorTuple): string**  
+Convert RGB to HEX.
 
 ```typescript
 import { rgb2hex } from 'colorizr';
 
-rgb2hex({ r: 255, g: 55, b: 75 }); // '#ff374b'
+rgb2hex({ r: 255, g: 0, b: 68 }); // '#ff0044'
 rgb2hex([255, 0, 68]); // '#ff0044'
 ```
 
-**rgb2hsl(input: RGB | RGBArray): HSL**  
-_convert an RGB object into an HSL object_
+**rgb2hsl(input: RGB | ColorTuple): HSL**  
+Convert RGB to HSL.
 
 ```typescript
 import { rgb2hsl } from 'colorizr';
 
-rgb2hsl({ r: 255, g: 55, b: 75 }); // { h: 354, s: 100, l: 60.78 }
+rgb2hsl({ r: 255, g: 0, b: 68 }); // { h: 344, s: 100, l: 50 }
 rgb2hsl([255, 0, 68]); // { h: 344, s: 100, l: 50 }
 ```
 
-**rotate(input: string, degrees = 15): string** _get a color with changed hue_
+**rgb2oklab(input: RGB | ColorTuple, precision: number): LAB**  
+Convert RGB to OKLAB.
 
 ```typescript
-import { rotate } from 'colorizr';
+import { rgb2oklab } from 'colorizr';
 
-rotate('#ff0044', 30); // #ff3b00
+rgb2oklab({ r: 255, g: 0, b: 68 }); // { l: 0.63269, a: 0.23887, b: 0.08648 }
+rgb2oklab([255, 0, 68]); // { l: 0.63269, a: 0.23887, b: 0.08648 }
 ```
 
-**saturate(input: string, amount: number): string**  
-_get a color with increased saturation_
+**rgb2oklch(input: RGB | ColorTuple, precision: number): LCH**  
+Convert RGB to OKLCH.
 
 ```typescript
-import { saturate } from 'colorizr';
+import { rgb2oklch } from 'colorizr';
 
-saturate('#ff0044', 10); // #ff0044 (already at the maximum)
-saturate('pink', 10); // #ffc0cb
+rgb2oklch({ r: 255, g: 0, b: 68 }); // { l: 0.63269, c: 0.25404, h: 19.90218 }
+rgb2oklch([255, 0, 68]); // { l: 0.63269, c: 0.25404, h: 19.90218 }
 ```
 
-**scheme(input: string, type: Scheme): string[]**  
-_get the scheme for a color_
+### Utilities
+
+**addAlphaToHex(input: string, alpha: number): string**  
+Add an alpha value to a hex string
 
 ```typescript
-import { scheme } from 'colorizr';
+import { addAlphaToHex } from 'colorizr';
 
-const complementary = scheme('rgb(255, 0, 68)'); // ['#ff0044', '#00ffbb']
-const triadic = scheme('#ff0044', 'triadic'); // ['#ff0044', '#44ff00', '#0044ff']
+addAlphaToHex('#ff0044', 0.9); // '#ff0044e6'
+addAlphaToHex('#ff0044cc', 0.9); // '#ff0044e6'
+```
+
+**convertAlphaToHex(input: number): string**  
+Convert an alpha value to a hex value.
+
+```typescript
+import { convertAlphaToHex } from 'colorizr';
+
+convertAlphaToHex(0.5); // '80'
+```
+
+**extractAlphaFromHex(input: string): number**  
+Extract the alpha value from a hex string
+
+```typescript
+import { extractAlphaFromHex } from 'colorizr';
+
+convertAlphaToHex('#ff004480'); // 0.5
+```
+
+**extractColorParts(input: string): ExtractColorPartsReturn**  
+Extract the color parts from a CSS color string.
+Hex colors are not supported.
+
+```typescript
+type ExtractColorPartsReturn = {
+  alpha?: number;
+  model: 'hsl' | 'oklab' | 'oklch' | 'rgb';
+} & Record<string, number>;
+
+extractColorParts('rgb(255 0 68)') // { model: 'rgb', r: 255, g: 0, b: 68 }
+extractColorParts('hsl(344 100% 50% / 90%)') // { alpha: 0.9, model: 'hsl', h: 344, g: 100, l: 50 }
+```
+
+**formatCSS(input: HSL | RGB, options?: FormatOptions): string**  
+Get a css string from a color object.
+
+```typescript
+import { formatCSS } from 'colorizr';
+
+formatCSS({ h: 344, s: 100, l: 50 }, { format: 'rgb' }); // 'rgb(255, 0, 68)'
+formatCSS({ r: 255, g: 0, b: 68 }, { alpha: 0.5, format: 'hsl' }); // 'hsla(344, 100%, 50%, 0.5)'
+```
+
+**formatHex(input: string): string**  
+Format a short hex string of 3 (or 4) digits into 6 (or 8) digits.
+
+```typescript
+import { formatHex } from 'colorizr';
+
+formatHex('#07e'); // '#0077ee'
+formatHex('#f058'); // '#ff005588'
+```
+**parseCSS(input: string, format?: ColorType): string | HSL | RGB**  
+Parse a css string to hex, HSL, OKLAB, OKLCH, or RGB.  
+If the format isn't set, it will return the same format as the input.
+
+```typescript
+import { parseCSS } from 'colorizr';
+
+parseCSS('hsl(344 100% 50%)'); // { h: 344, l: 50, s: 100 }
+parseCSS('#ff0044', 'hsl'); // { h: 344, l: 50, s: 100 }
+```
+
+**random(type: ColorType = 'hex'): string**  
+Get a random color.
+
+```typescript
+import { random } from 'colorizr';
+
+random(); // '#b385e0'
+random('oklch') // oklab(86.876% -0.22518 0.1597)
+```
+
+**removeAlphaFromHex(input: string): string**  
+Remove the alpha value from a hex string
+
+```typescript
+import { removeAlphaFromHex } from 'colorizr';
+
+removeAlphaFromHex('#ff0044cc'); // '#ff0044'
 ```
 
 **textColor(input: string): string**  
-_get a contrasting color to use with the text_
+Get a contrasting color (black or white) for the input color.
 
 ```typescript
 import { textColor } from 'colorizr';
@@ -325,7 +584,75 @@ textColor('#ff0044'); // #ffffff
 textColor('#fff800'); // #000000
 ```
 
-## Instance API
+### Validators
+
+**isValidColor(input: any): boolean**  
+Check if the input is a valid color.
+
+```typescript
+import { isValidColor } from 'colorizr';
+
+isValidColor('#ff0044'); // true
+isValidColor('#ff004400'); // true
+isValidColor('hsl(136 100% 50%)'); // true
+isValidColor('hsla(344, 100%, 50%, 0.4)'); // true
+isValidColor('oklab(70.622% 0.1374 0.14283)'); // true
+isValidColor('oklch(47.642% 0.29956 274.93693)'); // true
+isValidColor('rgb(255 230 109)'); // true
+isValidColor('blue'); // true
+isValidColor('aliceblue'); // true
+isValidColor('#mmff00'); // false
+isValidColor('blue-ish'); // false
+```
+
+**isHex(input: unknown): boolean**  
+Check if the input is a valid hex color.
+
+```typescript
+import { isHex } from 'colorizr';
+
+isHex('#f04'); // true
+isHex('#ff0044'); // true
+isHex('#ff0044cc'); // true
+```
+
+**isHSL(input: unknown): boolean**  
+Check if the input is a valid HSL object.
+
+```typescript
+import { isHSL } from 'colorizr';
+
+isHSL({ h: 344, s: 100, l: 50 }); // true
+```
+
+**isLAB(input: unknown): boolean**  
+Check if the input is a valid LAB color.
+
+```typescript
+import { isLAB } from 'colorizr';
+
+isLAB({ l: 0.63269, a: 0.23887, b: 0.08648 }); // true
+```
+
+**isLHC(input: unknown): boolean**  
+Check if the input is a valid LCH color.
+
+```typescript
+import { isLHC } from 'colorizr';
+
+isLHC({ l: 0.63269, c: 0.25404, h: 19.90218 }); // true
+```
+
+**isRGB(input: unknown): boolean**  
+Check if the input is a valid RGB color.
+
+```typescript
+import { isRGB } from 'colorizr';
+
+isRGB({ r: 255, g: 0, b: 68 }); // true
+```
+
+### Class
 
 ```typescript
 import Colorizr from 'Colorizr';
@@ -337,65 +664,72 @@ colorizr.hsl; // { h: 344, s: 100, l: 50 };
 colorizr.rgb; // { r: 255, g: 0, b: 68 };
 ```
 
-### Getters
+#### Getters
 
 **colorizr.hex**  
-_returns the hex_
+Get the hex code.
 
 **colorizr.hsl**  
-_returns the HSL object_
+Get the HSL object.
+
+**colorizr.oklab**  
+Get the OKLAB object.
+
+**colorizr.oklch**  
+Get the OKLCH object.
 
 **colorizr.rgb**  
-_returns the RGB object_
+Get the RGB object.
 
 **colorizr.hue**  
-_returns the color hue, between 0 and 360_
+Get the hue (0-360).
 
 **colorizr.saturation**  
-_returns the color saturation, between 0 and 100_
+Get the saturation (0-100).
 
 **colorizr.lightness**  
-_returns the color lightness, between 0 and 100_
+Get the lightness (0-100).
 
 **colorizr.red**  
-_returns the color red level, between 0 and 255_
+Get the red level (0-255).
 
 **colorizr.green**  
-_returns the color green level, between 0 and 255_
+Get the green level (0-255).
 
 **colorizr.blue**  
-_returns the color blue level, between 0 and 255_
-
-**colorizr.luminance**
+Get the blue level (0-255).
 
 **colorizr.chroma**
+Get the chroma (0-1).
 
-**colorizr.textColor**
-
-### Manipulation
-
-**colorizr.lighten(percentage = 10)**
+**colorizr.luminance**  
+Get the luminance (0-1).
 
-**colorizr.darken(percentage = 10)**
+**colorizr.opacity**  
+Get the opacity (0-1).
 
-**colorizr.saturate(percentage = 10)**
+**colorizr.css**  
+Get the css string of the same type as the input.
 
-**colorizr.saturate(percentage = 10)**
-
-**colorizr.rotate(degrees = 15)**
+**colorizr.textColor**
+Get a contrasting color (black or white).
 
-**colorizr.invert()**
+#### Methods
 
-**colorizr.fade(percentage = 10)**
+**colorizr.format(type: ColorType, precision?: number)**  
+Returns the formatted color with the type
 
-### Comparison
+...
 
-**colorizr.compare(color: string)**  
-_returns an object with the analysis (check the compare output above)_
+Also, all the [manipulators](#Manipulators) and [comparison](#Comparison) utilities.
 
-## References
+## Credits / References
 
+[color.js](https://github.com/color-js/color.js)  
+[chroma-js](https://gka.github.io/chroma.js/)  
 [calculating-color-contrast](https://24ways.org/2010/calculating-color-contrast/)  
 [Colour Contrast Check](https://snook.ca/technical/colour_contrast/colour.html)  
 [Contrast Checker](https://webaim.org/resources/contrastchecker/)  
-[Converting Color Spaces in typescript](https://css-tricks.com/converting-color-spaces-in-typescript/)
+[Converting Color Spaces in typescript](https://css-tricks.com/converting-color-spaces-in-typescript/)  
+[A perceptual color space for image processing](https://bottosson.github.io/posts/oklab/)
+