@soybeanjs/colord 0.0.8 → 0.1.1

package/README.md

@@ -17,7 +17,8 @@
 
 ## Differences from [colord](https://github.com/omgovich/colord)
 
-- support `oklab` and `oklch` color space
+- support `oklab` and `oklch` color models
+- support `palette` API to generate and find the nearest palette color
 - more correct color parsing
 - simplify type definitions
 - rewrite color string parsing
@@ -38,6 +39,16 @@ colord("hsl(0, 50%, 50%)").darken(0.25).toHex(); // "#602020"
 colord({ r: 128, g: 128, b: 128, alpha: 0.25 }).toRgbString(); // "rgba(128, 128, 128, 0.25)"
 ```
 
+## Palette API
+
+```ts
+import { tailwindPalette, generatePalette, generateNearestPalette } from '@soybeanjs/colord/palette';
+
+tailwindPalette.slate['500']; // 'oklch(55.4% 0.046 257.417)'
+generatePalette('red'); // generate the palette of the color 'red'
+generateNearestPalette('red'); // find the nearest color in the palette of the color 'red'
+```
+
 ## Supported Color Models
 
 - Hexadecimal strings (including 3, 4 and 8 digit notations)
@@ -53,6 +64,7 @@ colord({ r: 128, g: 128, b: 128, alpha: 0.25 }).toRgbString(); // "rgba(128, 128
 - OKLAB objects ([via plugin](#plugins))
 - OKLCH objects ([via plugin](#plugins))
 
+
 ## More API
 
 see the more api in [colord](https://github.com/omgovich/colord)

package/dist/{colord-DjohCNUk.d.ts → colord-iJvjkDaN.d.ts}

@@ -1,4 +1,4 @@
-import { a as HsvColor, c as InputSource, i as HslColor, t as AnyColor, v as RgbColor } from "./types-B93dJkfp.js";
+import { a as HsvColor, c as InputSource, i as HslColor, t as AnyColor, v as RgbColor } from "./types-CV5bTriG.js";
 
 //#region src/colord.d.ts
 

package/dist/colord.d.ts

@@ -1,2 +1,2 @@
-import { n as colord, t as Colord } from "./colord-DjohCNUk.js";
+import { n as colord, t as Colord } from "./colord-iJvjkDaN.js";
 export { Colord, colord };

package/dist/{extend-DmcZT4-q.d.ts → extend-BwkxQVzY.d.ts}

@@ -1,5 +1,5 @@
-import { _ as Parsers } from "./types-B93dJkfp.js";
-import { t as Colord } from "./colord-DjohCNUk.js";
+import { _ as Parsers } from "./types-CV5bTriG.js";
+import { t as Colord } from "./colord-iJvjkDaN.js";
 
 //#region src/extend.d.ts
 type Plugin = (ColordClass: typeof Colord, parsers: Parsers) => void;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { a as HsvColor, b as XyzColor, f as OklabColor, i as HslColor, l as LabColor, o as HwbColor, p as OklchColor, r as Format, s as Input, t as AnyColor, u as LchColor, v as RgbColor } from "./types-B93dJkfp.js";
-import { n as colord, t as Colord } from "./colord-DjohCNUk.js";
-import { n as extend, t as Plugin } from "./extend-DmcZT4-q.js";
+import { a as HsvColor, b as TailwindPaletteColorKey, f as OklabColor, g as PaletteColorLevel, i as HslColor, l as LabColor, o as HwbColor, p as OklchColor, r as Format, s as Input, t as AnyColor, u as LchColor, v as RgbColor, x as XyzColor } from "./types-CV5bTriG.js";
+import { n as colord, t as Colord } from "./colord-iJvjkDaN.js";
+import { n as extend, t as Plugin } from "./extend-BwkxQVzY.js";
 
 //#region src/shared/parse.d.ts
 
@@ -12,4 +12,4 @@ declare const getFormat: (input: Input) => Format | undefined;
 //#region src/shared/random.d.ts
 declare const random: () => Colord;
 //#endregion
-export { type AnyColor, Colord, type HslColor, type HsvColor, type HwbColor, type LabColor, type LchColor, type OklabColor, type OklchColor, type Plugin, type RgbColor, type XyzColor, colord, extend, getFormat, random };
+export { type AnyColor, Colord, type HslColor, type HsvColor, type HwbColor, type LabColor, type LchColor, type OklabColor, type OklchColor, type PaletteColorLevel, type Plugin, type RgbColor, type TailwindPaletteColorKey, type XyzColor, colord, extend, getFormat, random };

package/dist/palette/index.d.ts

@@ -1,4 +1,4 @@
-import { d as NearestPalette, g as PaletteColorLevel, h as OutputFormat, m as OutputColorMap, t as AnyColor, y as TailwindPaletteColor } from "../types-B93dJkfp.js";
+import { d as NearestPalette, g as PaletteColorLevel, h as OutputFormat, m as OutputColorMap, t as AnyColor, y as TailwindPaletteColor } from "../types-CV5bTriG.js";
 
 //#region src/palette/constant.d.ts
 

package/dist/plugins/a11y.d.ts

@@ -1,5 +1,5 @@
-import { t as AnyColor } from "../types-B93dJkfp.js";
-import { t as Plugin } from "../extend-DmcZT4-q.js";
+import { t as AnyColor } from "../types-CV5bTriG.js";
+import { t as Plugin } from "../extend-BwkxQVzY.js";
 
 //#region src/plugins/a11y.d.ts
 interface ReadabilityOptions {

package/dist/plugins/cmyk.d.ts

@@ -1,5 +1,5 @@
-import { n as CmykColor } from "../types-B93dJkfp.js";
-import { t as Plugin } from "../extend-DmcZT4-q.js";
+import { n as CmykColor } from "../types-CV5bTriG.js";
+import { t as Plugin } from "../extend-BwkxQVzY.js";
 
 //#region src/plugins/cmyk.d.ts
 declare module '@soybeanjs/colord' {

package/dist/plugins/harmonies.d.ts

@@ -1,4 +1,4 @@
-import { t as Plugin } from "../extend-DmcZT4-q.js";
+import { t as Plugin } from "../extend-BwkxQVzY.js";
 
 //#region src/plugins/harmonies.d.ts
 type HarmonyType = 'analogous' | 'complementary' | 'double-split-complementary' | 'rectangle' | 'split-complementary' | 'tetradic' | 'triadic';

package/dist/plugins/hwb.d.ts

@@ -1,5 +1,5 @@
-import { o as HwbColor } from "../types-B93dJkfp.js";
-import { t as Plugin } from "../extend-DmcZT4-q.js";
+import { o as HwbColor } from "../types-CV5bTriG.js";
+import { t as Plugin } from "../extend-BwkxQVzY.js";
 
 //#region src/plugins/hwb.d.ts
 declare module '@soybeanjs/colord' {

package/dist/plugins/lab.d.ts

@@ -1,5 +1,5 @@
-import { l as LabColor, t as AnyColor } from "../types-B93dJkfp.js";
-import { t as Plugin } from "../extend-DmcZT4-q.js";
+import { l as LabColor, t as AnyColor } from "../types-CV5bTriG.js";
+import { t as Plugin } from "../extend-BwkxQVzY.js";
 
 //#region src/plugins/lab.d.ts
 declare module '@soybeanjs/colord' {

package/dist/plugins/lch.d.ts

@@ -1,5 +1,5 @@
-import { u as LchColor } from "../types-B93dJkfp.js";
-import { t as Plugin } from "../extend-DmcZT4-q.js";
+import { u as LchColor } from "../types-CV5bTriG.js";
+import { t as Plugin } from "../extend-BwkxQVzY.js";
 
 //#region src/plugins/lch.d.ts
 declare module '@soybeanjs/colord' {

package/dist/plugins/minify.d.ts

@@ -1,4 +1,4 @@
-import { t as Plugin } from "../extend-DmcZT4-q.js";
+import { t as Plugin } from "../extend-BwkxQVzY.js";
 
 //#region src/plugins/minify.d.ts
 interface MinificationOptions {

package/dist/plugins/mix.d.ts

@@ -1,5 +1,5 @@
-import { t as AnyColor } from "../types-B93dJkfp.js";
-import { t as Plugin } from "../extend-DmcZT4-q.js";
+import { t as AnyColor } from "../types-CV5bTriG.js";
+import { t as Plugin } from "../extend-BwkxQVzY.js";
 
 //#region src/plugins/mix.d.ts
 declare module '@soybeanjs/colord' {

package/dist/plugins/names.d.ts

@@ -1,4 +1,4 @@
-import { t as Plugin } from "../extend-DmcZT4-q.js";
+import { t as Plugin } from "../extend-BwkxQVzY.js";
 
 //#region src/plugins/names.d.ts
 interface ConvertOptions {

package/dist/plugins/oklab.d.ts

@@ -1,5 +1,5 @@
-import { f as OklabColor } from "../types-B93dJkfp.js";
-import { t as Plugin } from "../extend-DmcZT4-q.js";
+import { f as OklabColor } from "../types-CV5bTriG.js";
+import { t as Plugin } from "../extend-BwkxQVzY.js";
 
 //#region src/plugins/oklab.d.ts
 declare module '@soybeanjs/colord' {

package/dist/plugins/oklch.d.ts

@@ -1,5 +1,5 @@
-import { p as OklchColor } from "../types-B93dJkfp.js";
-import { t as Plugin } from "../extend-DmcZT4-q.js";
+import { p as OklchColor } from "../types-CV5bTriG.js";
+import { t as Plugin } from "../extend-BwkxQVzY.js";
 
 //#region src/plugins/oklch.d.ts
 declare module '@soybeanjs/colord' {

package/dist/plugins/xyz.d.ts

@@ -1,5 +1,5 @@
-import { b as XyzColor } from "../types-B93dJkfp.js";
-import { t as Plugin } from "../extend-DmcZT4-q.js";
+import { x as XyzColor } from "../types-CV5bTriG.js";
+import { t as Plugin } from "../extend-BwkxQVzY.js";
 
 //#region src/plugins/xyz.d.ts
 declare module '@soybeanjs/colord' {

package/dist/{types-B93dJkfp.d.ts → types-CV5bTriG.d.ts}

@@ -109,4 +109,4 @@ interface NearestPalette<F extends OutputFormat> {
   palette: Record<PaletteColorLevel, OutputColorMap[F]>;
 }
 //#endregion
-export { Parsers as _, HsvColor as a, XyzColor as b, InputSource as c, NearestPalette as d, OklabColor as f, PaletteColorLevel as g, OutputFormat as h, HslColor as i, LabColor as l, OutputColorMap as m, CmykColor as n, HwbColor as o, OklchColor as p, Format as r, Input as s, AnyColor as t, LchColor as u, RgbColor as v, TailwindPaletteColor as y };
+export { Parsers as _, HsvColor as a, TailwindPaletteColorKey as b, InputSource as c, NearestPalette as d, OklabColor as f, PaletteColorLevel as g, OutputFormat as h, HslColor as i, LabColor as l, OutputColorMap as m, CmykColor as n, HwbColor as o, OklchColor as p, Format as r, Input as s, AnyColor as t, LchColor as u, RgbColor as v, XyzColor as x, TailwindPaletteColor as y };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@soybeanjs/colord",
   "type": "module",
-  "version": "0.0.8",
+  "version": "0.1.1",
   "description": "A tiny yet powerful tool for high-performance color manipulations and conversions",
   "author": {
     "name": "Soybean",