Skip to content

Commit 94dcd33

Browse files
committed
docs: update default color space in README and TypeScript interfaces to 'oklch'
1 parent 27fa209 commit 94dcd33

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ swatches.Vibrant?.color.hex();
7474
|---|---|---|
7575
| `colorCount` | `10` | Number of palette colors (2–20) |
7676
| `quality` | `10` | Sampling rate (1 = every pixel, 10 = every 10th) |
77-
| `colorSpace` | `'rgb'` | Quantization space: `'rgb'` or `'oklch'` |
77+
| `colorSpace` | `'oklch'` | Quantization space: `'rgb'` or `'oklch'` |
7878
| `worker` | `false` | Offload to Web Worker (browser only) |
7979
| `signal` | — | `AbortSignal` to cancel extraction |
8080
| `ignoreWhite` | `true` | Skip white pixels |

src/observe.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface ObserveOptions extends FilterOptions {
2828
colorCount?: number;
2929
/** Sampling quality (1 = highest). @default 10 */
3030
quality?: number;
31-
/** Color space for quantization. @default 'rgb' */
31+
/** Color space for quantization. @default 'oklch' */
3232
colorSpace?: ColorSpace;
3333
/** Called whenever a new palette is extracted. */
3434
onChange: (palette: Color[]) => void;

src/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ export interface ExtractionOptions extends FilterOptions {
6262
colorCount?: number;
6363
/** Sampling quality (1 = highest). @default 10 */
6464
quality?: number;
65-
/** Color space for quantization. @default 'rgb' */
65+
/** Color space for quantization. @default 'oklch' */
6666
colorSpace?: ColorSpace;
6767
/** AbortSignal to cancel extraction. */
6868
signal?: AbortSignal;

0 commit comments

Comments
 (0)