pantoken-root / packages/core/src / applyModify

関数: applyModify()

applyModify(value, modify): string | undefined

ベータ

Tokens Studio の TokenModify を具体的な 16 進カラーに適用する。

パラメーター

value

string

modify

TokenModify

戻り値

string | undefined

修正された色、または undefined（value が 16 進カラーでない場合。呼び出し元が修飾子をメタデータとして保持するためにフォールバックできる）。

例

暗くする、明るくする、アルファを追加する

import { applyModify } from "@pantoken/core";

applyModify("#808080", { type: "darken", value: 0.5, space: "hsl" });  // → "#404040"
applyModify("#808080", { type: "lighten", value: 0.5, space: "hsl" }); // → "#c0c0c0"
applyModify("#808080", { type: "lighten", value: 0.5, space: "lch" }); // → "#bdbdbd"
applyModify("#ffffff", { type: "alpha", value: 0.5, space: "hsl" });   // → "#ffffff80"

16進でない入力と mix は undefined を返す（メタデータとして保持する）

import { applyModify } from "@pantoken/core";

applyModify("var(--x)", { type: "darken", value: 0.1, space: "hsl" }); // → undefined