This commit is contained in:
Iliyan Angelov
2025-09-14 23:24:25 +03:00
commit c67067a2a4
71311 changed files with 6800714 additions and 0 deletions

View File

@@ -0,0 +1,48 @@
# Changes to PostCSS OKLab Function
### 1.1.1 (July 8, 2022)
- Fix case insensitive matching.
### 1.1.0 (April 4, 2022)
- Allow percentage and number units in more color components.
```css
.percentages {
color-1: oklab(40% 0.309% 0.975%);
color-2: oklch(40% 31.718385875% 34.568626);
/* becomes */
color-1: rgb(73, 71, 69);
color-1: color(display-p3 0.28515 0.27983 0.27246);
color-2: rgb(126, 37, 15);
color-2: color(display-p3 0.45368 0.16978 0.09411);
}
.numbers {
color-1: oklab(0.40 0.001236 0.0039);
color-2: oklch(0.40 0.1268735435 34.568626);
/* becomes */
color-1: rgb(73, 71, 69);
color-1: color(display-p3 0.28515 0.27983 0.27246);
color-2: rgb(126, 37, 15);
color-2: color(display-p3 0.45368 0.16978 0.09411);
}
```
### 1.0.2 (March 8, 2022)
- Fix gamut mapping giving overly unsaturated colors.
- Implement powerless color components in gamut mapping.
### 1.0.1 (February 12, 2022)
- Updated `@csstools/postcss-progressive-custom-properties` to `1.1.0`.
### 1.0.0 (February 11, 2022)
- Initial version

View File

@@ -0,0 +1,108 @@
# CC0 1.0 Universal
## Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator and
subsequent owner(s) (each and all, an “owner”) of an original work of
authorship and/or a database (each, a “Work”).
Certain owners wish to permanently relinquish those rights to a Work for the
purpose of contributing to a commons of creative, cultural and scientific works
(“Commons”) that the public can reliably and without fear of later claims of
infringement build upon, modify, incorporate in other works, reuse and
redistribute as freely as possible in any form whatsoever and for any purposes,
including without limitation commercial purposes. These owners may contribute
to the Commons to promote the ideal of a free culture and the further
production of creative, cultural and scientific works, or to gain reputation or
greater distribution for their Work in part through the use and efforts of
others.
For these and/or other purposes and motivations, and without any expectation of
additional consideration or compensation, the person associating CC0 with a
Work (the “Affirmer”), to the extent that he or she is an owner of Copyright
and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and
publicly distribute the Work under its terms, with knowledge of his or her
Copyright and Related Rights in the Work and the meaning and intended legal
effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights (“Copyright and
Related Rights”). Copyright and Related Rights include, but are not limited
to, the following:
1. the right to reproduce, adapt, distribute, perform, display, communicate,
and translate a Work;
2. moral rights retained by the original author(s) and/or performer(s);
3. publicity and privacy rights pertaining to a persons image or likeness
depicted in a Work;
4. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(i), below;
5. rights protecting the extraction, dissemination, use and reuse of data in
a Work;
6. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation thereof,
including any amended or successor version of such directive); and
7. other similar, equivalent or corresponding rights throughout the world
based on applicable law or treaty, and any national implementations
thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention of,
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
unconditionally waives, abandons, and surrenders all of Affirmers Copyright
and Related Rights and associated claims and causes of action, whether now
known or unknown (including existing as well as future claims and causes of
action), in the Work (i) in all territories worldwide, (ii) for the maximum
duration provided by applicable law or treaty (including future time
extensions), (iii) in any current or future medium and for any number of
copies, and (iv) for any purpose whatsoever, including without limitation
commercial, advertising or promotional purposes (the “Waiver”). Affirmer
makes the Waiver for the benefit of each member of the public at large and
to the detriment of Affirmers heirs and successors, fully intending that
such Waiver shall not be subject to revocation, rescission, cancellation,
termination, or any other legal or equitable action to disrupt the quiet
enjoyment of the Work by the public as contemplated by Affirmers express
Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason be
judged legally invalid or ineffective under applicable law, then the Waiver
shall be preserved to the maximum extent permitted taking into account
Affirmers express Statement of Purpose. In addition, to the extent the
Waiver is so judged Affirmer hereby grants to each affected person a
royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmers Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future time
extensions), (iii) in any current or future medium and for any number of
copies, and (iv) for any purpose whatsoever, including without limitation
commercial, advertising or promotional purposes (the “License”). The License
shall be deemed effective as of the date CC0 was applied by Affirmer to the
Work. Should any part of the License for any reason be judged legally
invalid or ineffective under applicable law, such partial invalidity or
ineffectiveness shall not invalidate the remainder of the License, and in
such case Affirmer hereby affirms that he or she will not (i) exercise any
of his or her remaining Copyright and Related Rights in the Work or (ii)
assert any associated claims and causes of action with respect to the Work,
in either case contrary to Affirmers express Statement of Purpose.
4. Limitations and Disclaimers.
1. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
2. Affirmer offers the Work as-is and makes no representations or warranties
of any kind concerning the Work, express, implied, statutory or
otherwise, including without limitation warranties of title,
merchantability, fitness for a particular purpose, non infringement, or
the absence of latent or other defects, accuracy, or the present or
absence of errors, whether or not discoverable, all to the greatest
extent permissible under applicable law.
3. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any persons Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the Work.
4. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to this
CC0 or use of the Work.
For more information, please see
http://creativecommons.org/publicdomain/zero/1.0/.

View File

@@ -0,0 +1,183 @@
# PostCSS OKLab Function [<img src="https://postcss.github.io/postcss/logo.svg" alt="PostCSS Logo" width="90" height="90" align="right">][postcss]
[<img alt="npm version" src="https://img.shields.io/npm/v/@csstools/postcss-oklab-function.svg" height="20">][npm-url]
[<img alt="CSS Standard Status" src="https://cssdb.org/images/badges/oklab-function.svg" height="20">][css-url]
[<img alt="Build Status" src="https://github.com/csstools/postcss-plugins/workflows/test/badge.svg" height="20">][cli-url]
[<img alt="Discord" src="https://shields.io/badge/Discord-5865F2?logo=discord&logoColor=white">][discord]
[PostCSS OKLab Function] lets you use `oklab` and `oklch` color functions in
CSS, following the [CSS Color] specification.
```pcss
.test-oklab {
color: oklab(40% 0.001236 0.0039);
}
.test-oklch {
color: oklch(40% 0.268735435 34.568626);
}
/* becomes */
.test-oklab {
color: rgb(73, 71, 69);
color: color(display-p3 0.28515 0.27983 0.27246);
}
.test-oklch {
color: rgb(131, 28, 0);
color: color(display-p3 0.49163 0.11178 0.00000);
}
```
## Usage
Add [PostCSS OKLab Function] to your project:
```bash
npm install postcss @csstools/postcss-oklab-function --save-dev
```
Use it as a [PostCSS] plugin:
```js
const postcss = require('postcss');
const postcssOKLabFunction = require('@csstools/postcss-oklab-function');
postcss([
postcssOKLabFunction(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);
```
[PostCSS OKLab Function] runs in all Node environments, with special
instructions for:
| [Node](INSTALL.md#node) | [PostCSS CLI](INSTALL.md#postcss-cli) | [Webpack](INSTALL.md#webpack) | [Create React App](INSTALL.md#create-react-app) | [Gulp](INSTALL.md#gulp) | [Grunt](INSTALL.md#grunt) |
| --- | --- | --- | --- | --- | --- |
## Options
### preserve
The `preserve` option determines whether the original notation
is preserved. By default, it is not preserved.
```js
postcssOKLabFunction({ preserve: true })
```
```pcss
.test-oklab {
color: oklab(40% 0.001236 0.0039);
}
.test-oklch {
color: oklch(40% 0.268735435 34.568626);
}
/* becomes */
.test-oklab {
color: rgb(73, 71, 69);
color: color(display-p3 0.28515 0.27983 0.27246);
color: oklab(40% 0.001236 0.0039);
}
.test-oklch {
color: rgb(131, 28, 0);
color: color(display-p3 0.49163 0.11178 0.00000);
color: oklch(40% 0.268735435 34.568626);
}
```
### enableProgressiveCustomProperties
The `enableProgressiveCustomProperties` option determines whether the original notation
is wrapped with `@supports` when used in Custom Properties. By default, it is enabled.
⚠️ We only recommend disabling this when you set `preserve` to `false` or if you bring your own fix for Custom Properties. See what the plugin does in its [README](https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-progressive-custom-properties#readme).
```js
postcssOKLabFunction({ enableProgressiveCustomProperties: false })
```
```pcss
:root {
--firebrick: oklab(40% 0.234 0.39);
}
/* becomes */
:root {
--firebrick: rgb(133, 0, 67); /* will never be used, not even in older browser */
--firebrick: color(display-p3 0.49890 0.00000 0.25954); /* will never be used, not even in older browser */
--firebrick: oklab(40% 0.234 0.39);
}
```
### subFeatures
#### displayP3
The `subFeatures.displayP3` option determines if `color(display-p3 ...)` is used as a fallback.<br>
By default, it is enabled.
`display-p3` can display wider gamut colors than `rgb` on some devices.
```js
postcssOKLabFunction({
subFeatures: {
displayP3: false
}
})
```
```pcss
.test-oklab {
color: oklab(40% 0.001236 0.0039);
}
.test-oklch {
color: oklch(40% 0.268735435 34.568626);
}
/* becomes */
.test-oklab {
color: rgb(73, 71, 69);
}
.test-oklch {
color: rgb(131, 28, 0);
}
```
## Out of gamut colors
Depending on the browser implementation out of gamut colors may be clipped, resulting in a different color.<br>
Fallback values generated by [PostCSS OKLab Function] are always mapped to a close alternative in sRGB.
When setting `preserve` to `true` the original values will be used by some browsers and these may be clipped.<br>
Certain browsers will have an incorrect color if this occurs.
If the plugin detects out of gamut colors it will emit a warning :
> "oklab(40% 0.234 0.39)" is out of gamut for "display-p3". When "preserve: true" is set this will lead to unexpected results in some browsers.
To resolve this warning you can use a color that is in gamut for `display-p3`.
## Copyright : color conversions
This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/tree/main/css-color-4. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
[css-url]: https://cssdb.org/#oklab-function
[discord]: https://discord.gg/bUadyRwkJS
[npm-url]: https://www.npmjs.com/package/@csstools/postcss-oklab-function
[CSS Color]: https://www.w3.org/TR/css-color-4/#specifying-oklab-oklch
[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
[PostCSS]: https://github.com/postcss/postcss
[PostCSS Loader]: https://github.com/postcss/postcss-loader
[PostCSS OKLab Function]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-oklab-function

View File

@@ -0,0 +1,3 @@
declare type color = [number, number, number];
export declare function oklabToDisplayP3(oklabRaw: color): [color, boolean];
export {};

View File

@@ -0,0 +1,3 @@
declare type color = [number, number, number];
export declare function oklabToSRgb(oklabRaw: color): color;
export {};

View File

@@ -0,0 +1,3 @@
declare type color = [number, number, number];
export declare function oklchToDisplayP3(oklchRaw: color): [color, boolean];
export {};

View File

@@ -0,0 +1,3 @@
declare type color = [number, number, number];
export declare function oklchToSRgb(oklchRaw: color): color;
export {};

View File

@@ -0,0 +1,47 @@
/**
* @license W3C
* https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
*
* @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/conversions.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
*
* @see https://github.com/w3c/csswg-drafts/blob/main/css-color-4/conversions.js
*/
declare type color = [number, number, number];
export declare const D50: number[];
export declare const D65: number[];
export declare function lin_sRGB(RGB: color): color;
export declare function gam_sRGB(RGB: color): color;
export declare function lin_sRGB_to_XYZ(rgb: color): color;
export declare function XYZ_to_lin_sRGB(XYZ: color): color;
export declare function lin_P3(RGB: color): color;
export declare function gam_P3(RGB: color): color;
export declare function lin_P3_to_XYZ(rgb: color): color;
export declare function XYZ_to_lin_P3(XYZ: color): color;
export declare function lin_ProPhoto(RGB: color): color;
export declare function gam_ProPhoto(RGB: color): color;
export declare function lin_ProPhoto_to_XYZ(rgb: color): color;
export declare function XYZ_to_lin_ProPhoto(XYZ: color): color;
export declare function lin_a98rgb(RGB: color): color;
export declare function gam_a98rgb(RGB: color): color;
export declare function lin_a98rgb_to_XYZ(rgb: color): color;
export declare function XYZ_to_lin_a98rgb(XYZ: color): color;
export declare function lin_2020(RGB: color): color;
export declare function gam_2020(RGB: color): color;
export declare function lin_2020_to_XYZ(rgb: color): color;
export declare function XYZ_to_lin_2020(XYZ: color): color;
export declare function D65_to_D50(XYZ: color): color;
export declare function D50_to_D65(XYZ: color): color;
export declare function XYZ_to_Lab(XYZ: color): color;
export declare function Lab_to_XYZ(Lab: color): color;
export declare function Lab_to_LCH(Lab: color): color;
export declare function LCH_to_Lab(LCH: color): color;
export declare function XYZ_to_OKLab(XYZ: color): color;
export declare function OKLab_to_XYZ(OKLab: color): color;
export declare function OKLab_to_OKLCH(OKLab: color): color;
export declare function OKLCH_to_OKLab(OKLCH: color): color;
export declare function rectangular_premultiply(color: color, alpha: number): color;
export declare function rectangular_un_premultiply(color: color, alpha: number): color;
export declare function polar_premultiply(color: color, alpha: number, hueIndex: number): color;
export declare function polar_un_premultiply(color: color, alpha: number, hueIndex: number): color;
export declare function hsl_premultiply(color: color, alpha: number): color;
export {};

View File

@@ -0,0 +1,11 @@
/**
* @license W3C
* https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
*
* @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/deltaEOK.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
*
* @see https://github.com/w3c/csswg-drafts/blob/main/css-color-4/deltaEOK.js
*/
declare type color = [number, number, number];
export declare function deltaEOK(reference: color, sample: color): number;
export {};

View File

@@ -0,0 +1,5 @@
declare type color = [number, number, number];
export declare function mapGamut(startOKLCH: color, toDestination: (x: color) => color, fromDestination: (x: color) => color): color;
export declare function clip(color: color): color;
export declare function inGamut(x: color): boolean;
export {};

View File

@@ -0,0 +1,13 @@
/**
* Simple matrix (and vector) multiplication
* Warning: No error handling for incompatible dimensions!
* @author Lea Verou 2020 MIT License
*
* @license W3C
* https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
*
* @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/multiply-matrices.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
*
* @see https://github.com/w3c/csswg-drafts/blob/main/css-color-4/multiply-matrices.js
*/
export declare function multiplyMatrices(a: Array<Array<number>> | Array<number>, b: Array<Array<number>> | Array<number>): Array<Array<number>> | Array<number>;

View File

@@ -0,0 +1,25 @@
/**
* @license W3C
* https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
*
* @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/utilities.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
*
* @see https://github.com/w3c/csswg-drafts/blob/main/css-color-4/utilities.js
*/
declare type color = [number, number, number];
export declare function sRGB_to_luminance(RGB: color): number;
export declare function contrast(RGB1: color, RGB2: color): number;
export declare function sRGB_to_LCH(RGB: color): color;
export declare function P3_to_LCH(RGB: color): color;
export declare function r2020_to_LCH(RGB: color): color;
export declare function LCH_to_sRGB(LCH: color): color;
export declare function LCH_to_P3(LCH: color): color;
export declare function LCH_to_r2020(LCH: color): color;
export declare function hslToRgb(hsl: color): color;
export declare function hueToRgb(t1: number, t2: number, hue: number): number;
export declare function naive_CMYK_to_sRGB(CMYK: [number, number, number, number]): color;
export declare function naive_sRGB_to_CMYK(RGB: color): [number, number, number, number];
export declare function XYZ_to_xy(XYZ: color): [number, number];
export declare function xy_to_uv(xy: [number, number]): [number, number];
export declare function XYZ_to_uv(XYZ: color): [number, number];
export {};

View File

@@ -0,0 +1,2 @@
import type { Declaration } from 'postcss';
export declare function hasFallback(node: Declaration): boolean;

View File

@@ -0,0 +1,2 @@
import type { Node } from 'postcss';
export declare function hasSupportsAtRuleAncestor(node: Node): boolean;

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,11 @@
import type { PluginCreator } from 'postcss';
declare type pluginOptions = {
enableProgressiveCustomProperties?: boolean;
preserve?: boolean;
subFeatures?: {
displayP3?: boolean;
};
};
/** Transform oklab() and oklch() functions in CSS. */
declare const postcssPlugin: PluginCreator<pluginOptions>;
export default postcssPlugin;

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,5 @@
import type { Declaration, Result } from 'postcss';
export declare function modifiedValues(originalValue: string, decl: Declaration, result: Result, preserve: boolean): {
rgb: string;
displayP3: string;
} | undefined;

View File

@@ -0,0 +1,4 @@
import type { FunctionNode } from 'postcss-value-parser';
import { Declaration, Result } from 'postcss';
export declare function onCSSFunctionSRgb(node: FunctionNode): void;
export declare function onCSSFunctionDisplayP3(node: FunctionNode, decl: Declaration, result: Result, preserve: boolean): void;

View File

@@ -0,0 +1,75 @@
{
"name": "@csstools/postcss-oklab-function",
"description": "Use oklab() and oklch() color functions in CSS",
"version": "1.1.1",
"author": "Jonathan Neal <jonathantneal@hotmail.com>",
"license": "CC0-1.0",
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/csstools"
},
"engines": {
"node": "^12 || ^14 || >=16"
},
"main": "dist/index.cjs",
"module": "dist/index.mjs",
"types": "./dist/index.d.ts",
"exports": {
".": {
"import": "./dist/index.mjs",
"require": "./dist/index.cjs",
"default": "./dist/index.mjs"
}
},
"files": [
"CHANGELOG.md",
"LICENSE.md",
"README.md",
"dist"
],
"dependencies": {
"@csstools/postcss-progressive-custom-properties": "^1.1.0",
"postcss-value-parser": "^4.2.0"
},
"peerDependencies": {
"postcss": "^8.2"
},
"scripts": {
"build": "rollup -c ../../rollup/default.js",
"clean": "node -e \"fs.rmSync('./dist', { recursive: true, force: true });\"",
"docs": "node ../../.github/bin/generate-docs/install.mjs",
"lint": "npm run lint:eslint && npm run lint:package-json",
"lint:eslint": "eslint ./src --ext .js --ext .ts --ext .mjs --no-error-on-unmatched-pattern",
"lint:package-json": "node ../../.github/bin/format-package-json.mjs",
"prepublishOnly": "npm run clean && npm run build && npm run test",
"test": "node .tape.mjs && npm run test:exports",
"test:exports": "node ./test/_import.mjs && node ./test/_require.cjs",
"test:rewrite-expects": "REWRITE_EXPECTS=true node .tape.mjs"
},
"homepage": "https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-oklab-function#readme",
"repository": {
"type": "git",
"url": "https://github.com/csstools/postcss-plugins.git",
"directory": "plugins/postcss-oklab-function"
},
"bugs": "https://github.com/csstools/postcss-plugins/issues",
"keywords": [
"color",
"colors",
"css",
"design",
"display-p3",
"oklab",
"oklch",
"postcss",
"postcss-plugin",
"syntax"
],
"csstools": {
"exportName": "postcssOKLabFunction",
"humanReadableName": "PostCSS OKLab Function"
},
"volta": {
"extends": "../../package.json"
}
}