tailwindcss-custom-colors 1.0.12 → 1.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +40 -36
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -29,6 +29,41 @@ import { generateConfig } from "tailwindcss-custom-colors";
|
|
|
29
29
|
import { generateStyleVariables } from "tailwindcss-custom-colors";
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
+
### Options
|
|
33
|
+
|
|
34
|
+
The `Options` interface allows you to customize the behavior of the package. Below are the available options and their default values.
|
|
35
|
+
|
|
36
|
+
#### Available Options
|
|
37
|
+
|
|
38
|
+
- `suffixMultiplier` (optional): Determines the multiplier for suffixes. Possible values are `100`, `10`, or `1`. Default is `100`.
|
|
39
|
+
- `variablePrefix` (optional): Specifies a prefix for variable names. Default is `undefined`.
|
|
40
|
+
- `contrast` (optional): If set to `true`, calculates the contrast. Default is `true`.
|
|
41
|
+
- `complement` (optional): If set to `true`, calculates the complementary color. Default is `true`.
|
|
42
|
+
- `classification` (optional): An object containing color classifications for light and dark themes. Default is `{ light: "#FFFFFF", dark: "#000000" }`.
|
|
43
|
+
- `light`: Hex color for light theme. Default is `"#FFFFFF"`.
|
|
44
|
+
- `dark`: Hex color for dark theme. Default is `"#000000"`.
|
|
45
|
+
- `steps` (optional): Determines the step values for shades. Possible values are `100` or `50`. Default is `100`.
|
|
46
|
+
- `default` (optional): If set to `true`, uses the default configuration. Default is `true`.
|
|
47
|
+
|
|
48
|
+
#### Default Options
|
|
49
|
+
|
|
50
|
+
The `defaultOptions` object represents the default configuration for the package:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
const defaultOptions: DefaultOptions = {
|
|
54
|
+
suffixMultiplier: 100,
|
|
55
|
+
variablePrefix: undefined,
|
|
56
|
+
contrast: true,
|
|
57
|
+
complement: true,
|
|
58
|
+
classification: {
|
|
59
|
+
light: "#FFFFFF",
|
|
60
|
+
dark: "#000000",
|
|
61
|
+
},
|
|
62
|
+
steps: 100,
|
|
63
|
+
default: true,
|
|
64
|
+
};
|
|
65
|
+
```
|
|
66
|
+
|
|
32
67
|
### generateConfig()
|
|
33
68
|
|
|
34
69
|
```js
|
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -25,6 +25,7 @@ const defaultOptions = {
|
|
|
25
25
|
dark: "#000000",
|
|
26
26
|
},
|
|
27
27
|
steps: 100,
|
|
28
|
+
default: true,
|
|
28
29
|
};
|
|
29
30
|
const computeOptions = (options) => {
|
|
30
31
|
const computedOptions = {
|
|
@@ -40,22 +41,23 @@ const computeOptions = (options) => {
|
|
|
40
41
|
* @returns {TailwindColorsConfig} A config object for tailwindcss
|
|
41
42
|
*/
|
|
42
43
|
const generateConfig = (colorNames, options) => {
|
|
43
|
-
const { suffixMultiplier, variablePrefix, contrast, complement, steps } = computeOptions(options || {});
|
|
44
|
+
const { suffixMultiplier, variablePrefix, contrast, complement, steps, default: defaultOption, } = computeOptions(options || {});
|
|
44
45
|
const colors = Array.isArray(colorNames) ? colorNames : [colorNames];
|
|
45
46
|
const config = {};
|
|
46
47
|
colors.forEach((colorName) => {
|
|
47
|
-
const
|
|
48
|
+
const defaultColor = {
|
|
48
49
|
DEFAULT: `rgb(var(${(0, variableName_1.default)(colorName, variablePrefix)}) / <alpha-value>)`,
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
50
|
+
};
|
|
51
|
+
const contrastColor = {
|
|
52
|
+
contrast: `rgb(var(${(0, variableName_1.default)(colorName, variablePrefix, "contrast")}) / <alpha-value>)`,
|
|
53
|
+
};
|
|
54
|
+
const complementColor = {
|
|
55
|
+
complement: `rgb(var(${(0, variableName_1.default)(colorName, variablePrefix, "complement")}) / <alpha-value>)`,
|
|
56
|
+
};
|
|
57
|
+
const colorTints = {
|
|
58
|
+
...(defaultOption ? defaultColor : {}),
|
|
59
|
+
...(contrast ? contrastColor : {}),
|
|
60
|
+
...(complement ? complementColor : {}),
|
|
59
61
|
};
|
|
60
62
|
shades[steps].forEach((shade) => {
|
|
61
63
|
const tintSuffix = `${shade * suffixMultiplier}`;
|
|
@@ -73,22 +75,23 @@ exports.generateConfig = generateConfig;
|
|
|
73
75
|
* @returns {string} A string of css variables
|
|
74
76
|
*/
|
|
75
77
|
const generateStyleVariables = (colorParams, options) => {
|
|
76
|
-
const { suffixMultiplier, variablePrefix, contrast, complement, classification, steps, } = computeOptions(options || {});
|
|
78
|
+
const { suffixMultiplier, variablePrefix, contrast, complement, classification, steps, default: defaultOption, } = computeOptions(options || {});
|
|
77
79
|
const colors = Array.isArray(colorParams) ? colorParams : [colorParams];
|
|
78
80
|
const styles = colors.map(({ color, name }) => {
|
|
79
81
|
const hslColor = (0, hexToHsl_1.default)(color);
|
|
80
|
-
const
|
|
82
|
+
const defaultTintColor = [
|
|
81
83
|
`${(0, variableName_1.default)(name, variablePrefix)}: ${(0, hexToRgb_1.hexToRgbString)(color)}`,
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
84
|
+
];
|
|
85
|
+
const contrastTintColor = [
|
|
86
|
+
`${(0, variableName_1.default)(name, variablePrefix, "contrast")}: ${(0, chroma_1.contrast)(hslColor, classification)}`,
|
|
87
|
+
];
|
|
88
|
+
const complementTintColor = [
|
|
89
|
+
`${(0, variableName_1.default)(name, variablePrefix, "complement")}: ${(0, chroma_1.complement)(hslColor, classification)}`,
|
|
90
|
+
];
|
|
91
|
+
const tintsString = [
|
|
92
|
+
...(defaultOption ? defaultTintColor : []),
|
|
93
|
+
...(contrast ? contrastTintColor : []),
|
|
94
|
+
...(complement ? complementTintColor : []),
|
|
92
95
|
];
|
|
93
96
|
shades[steps].forEach((shade) => {
|
|
94
97
|
const tintSuffix = `${shade * suffixMultiplier}`;
|
|
@@ -116,23 +119,24 @@ exports.generateStyleVariables = generateStyleVariables;
|
|
|
116
119
|
* @returns {TailwindColorsConfig} A config object for tailwindcss
|
|
117
120
|
*/
|
|
118
121
|
const generateConfigWithColors = (colorParams, options) => {
|
|
119
|
-
const { suffixMultiplier, variablePrefix, contrast, complement, classification, steps, } = computeOptions(options || {});
|
|
122
|
+
const { suffixMultiplier, variablePrefix, contrast, complement, classification, steps, default: defaultOption, } = computeOptions(options || {});
|
|
120
123
|
const colors = Array.isArray(colorParams) ? colorParams : [colorParams];
|
|
121
124
|
const config = {};
|
|
122
125
|
colors.forEach(({ color, name }) => {
|
|
123
126
|
const hslColor = (0, hexToHsl_1.default)(color);
|
|
124
|
-
const
|
|
127
|
+
const defaultColor = {
|
|
125
128
|
DEFAULT: `rgb(${(0, hexToRgb_1.hexToRgbString)(color)} / <alpha-value>)`,
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
129
|
+
};
|
|
130
|
+
const contrastColor = {
|
|
131
|
+
contrast: `rgb(${(0, chroma_1.contrast)(hslColor, classification)} / <alpha-value>)`,
|
|
132
|
+
};
|
|
133
|
+
const complementColor = {
|
|
134
|
+
complement: `rgb(${(0, chroma_1.complement)(hslColor, classification)} / <alpha-value>)`,
|
|
135
|
+
};
|
|
136
|
+
const colorTints = {
|
|
137
|
+
...(defaultOption ? defaultColor : {}),
|
|
138
|
+
...(contrast ? contrastColor : {}),
|
|
139
|
+
...(complement ? complementColor : {}),
|
|
136
140
|
};
|
|
137
141
|
shades[steps].forEach((shade) => {
|
|
138
142
|
const tintSuffix = `${shade * suffixMultiplier}`;
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,2CAKwB;AACxB,+CAAkD;AAClD,gEAAwC;AACxC,0DAAkC;AAClC,wEAAgD;AAEhD,MAAM,MAAM,GAAG;IACb,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAChC,EAAE,EAAE;QACF,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG;KAC5E;CACF,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,2CAKwB;AACxB,+CAAkD;AAClD,gEAAwC;AACxC,0DAAkC;AAClC,wEAAgD;AAEhD,MAAM,MAAM,GAAG;IACb,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAChC,EAAE,EAAE;QACF,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG;KAC5E;CACF,CAAC;AA4BF,MAAM,cAAc,GAAmB;IACrC,gBAAgB,EAAE,GAAG;IACrB,cAAc,EAAE,SAAS;IACzB,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE,IAAI;IAChB,cAAc,EAAE;QACd,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,SAAS;KAChB;IACD,KAAK,EAAE,GAAG;IACV,OAAO,EAAE,IAAI;CACd,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAE,EAAE;IAC1C,MAAM,eAAe,GAAG;QACtB,GAAG,cAAc;QACjB,GAAG,OAAO;KACX,CAAC;IAEF,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC;AAMF;;;;;GAKG;AACH,MAAM,cAAc,GAAG,CACrB,UAA6B,EAC7B,OAAiB,EACK,EAAE;IACxB,MAAM,EACJ,gBAAgB,EAChB,cAAc,EACd,QAAQ,EACR,UAAU,EACV,KAAK,EACL,OAAO,EAAE,aAAa,GACvB,GAAG,cAAc,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IAElC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAErE,MAAM,MAAM,GAAyB,EAAE,CAAC;IAExC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;QAC3B,MAAM,YAAY,GAAG;YACnB,OAAO,EAAE,WAAW,IAAA,sBAAY,EAC9B,SAAS,EACT,cAAc,CACf,oBAAoB;SACtB,CAAC;QAEF,MAAM,aAAa,GAAG;YACpB,QAAQ,EAAE,WAAW,IAAA,sBAAY,EAC/B,SAAS,EACT,cAAc,EACd,UAAU,CACX,oBAAoB;SACtB,CAAC;QAEF,MAAM,eAAe,GAAG;YACtB,UAAU,EAAE,WAAW,IAAA,sBAAY,EACjC,SAAS,EACT,cAAc,EACd,YAAY,CACb,oBAAoB;SACtB,CAAC;QAEF,MAAM,UAAU,GAA2B;YACzC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;YACtC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;YAClC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;SACvC,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,MAAM,UAAU,GAAG,GAAG,KAAK,GAAG,gBAAgB,EAAE,CAAC;YACjD,UAAU,CAAC,UAAU,CAAC,GAAG,WAAW,IAAA,sBAAY,EAC9C,SAAS,EACT,cAAc,EACd,UAAU,CACX,oBAAoB,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AA+JO,wCAAc;AAxJvB;;;;;GAKG;AACH,MAAM,sBAAsB,GAAG,CAC7B,WAAwC,EACxC,OAAiB,EACT,EAAE;IACV,MAAM,EACJ,gBAAgB,EAChB,cAAc,EACd,QAAQ,EACR,UAAU,EACV,cAAc,EACd,KAAK,EACL,OAAO,EAAE,aAAa,GACvB,GAAG,cAAc,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IAElC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IAExE,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE;QAC5C,MAAM,QAAQ,GAAG,IAAA,kBAAQ,EAAC,KAAK,CAAC,CAAC;QAEjC,MAAM,gBAAgB,GAAG;YACvB,GAAG,IAAA,sBAAY,EAAC,IAAI,EAAE,cAAc,CAAC,KAAK,IAAA,yBAAc,EAAC,KAAK,CAAC,EAAE;SAClE,CAAC;QACF,MAAM,iBAAiB,GAAG;YACxB,GAAG,IAAA,sBAAY,EAAC,IAAI,EAAE,cAAc,EAAE,UAAU,CAAC,KAAK,IAAA,iBAAY,EAChE,QAAQ,EACR,cAAc,CACf,EAAE;SACJ,CAAC;QACF,MAAM,mBAAmB,GAAG;YAC1B,GAAG,IAAA,sBAAY,EAAC,IAAI,EAAE,cAAc,EAAE,YAAY,CAAC,KAAK,IAAA,mBAAc,EACpE,QAAQ,EACR,cAAc,CACf,EAAE;SACJ,CAAC;QAEF,MAAM,WAAW,GAAG;YAClB,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1C,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;YACtC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC;SAC3C,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,MAAM,UAAU,GAAG,GAAG,KAAK,GAAG,gBAAgB,EAAE,CAAC;YACjD,IAAI,KAAK,KAAK,CAAC,EAAE;gBACf,WAAW,CAAC,IAAI,CACd,GAAG,IAAA,sBAAY,EAAC,IAAI,EAAE,cAAc,EAAE,UAAU,CAAC,KAAK,IAAA,yBAAc,EAClE,KAAK,CACN,EAAE,CACJ,CAAC;aACH;iBAAM,IAAI,KAAK,GAAG,CAAC,EAAE;gBACpB,IAAI,KAAK,GAAG,IAAA,eAAK,EAAC,CAAC,GAAG,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC;gBACpC,WAAW,CAAC,IAAI,CACd,GAAG,IAAA,sBAAY,EAAC,IAAI,EAAE,cAAc,EAAE,UAAU,CAAC,KAAK,IAAA,gBAAO,EAC3D,QAAQ,EACR,KAAK,CACN,EAAE,CACJ,CAAC;aACH;iBAAM;gBACL,IAAI,KAAK,GAAG,IAAA,eAAK,EAAC,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC,CAAC;gBACrC,WAAW,CAAC,IAAI,CACd,GAAG,IAAA,sBAAY,EAAC,IAAI,EAAE,cAAc,EAAE,UAAU,CAAC,KAAK,IAAA,eAAM,EAC1D,QAAQ,EACR,KAAK,CACN,EAAE,CACJ,CAAC;aACH;QACH,CAAC,CAAC,CAAC;QACH,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC,CAAC;AA4EuB,wDAAsB;AA1E/C;;;;;GAKG;AACH,MAAM,wBAAwB,GAAG,CAC/B,WAAwC,EACxC,OAAiB,EACK,EAAE;IACxB,MAAM,EACJ,gBAAgB,EAChB,cAAc,EACd,QAAQ,EACR,UAAU,EACV,cAAc,EACd,KAAK,EACL,OAAO,EAAE,aAAa,GACvB,GAAG,cAAc,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IAElC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IAExE,MAAM,MAAM,GAAyB,EAAE,CAAC;IAExC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE;QACjC,MAAM,QAAQ,GAAG,IAAA,kBAAQ,EAAC,KAAK,CAAC,CAAC;QAEjC,MAAM,YAAY,GAAG;YACnB,OAAO,EAAE,OAAO,IAAA,yBAAc,EAAC,KAAK,CAAC,mBAAmB;SACzD,CAAC;QACF,MAAM,aAAa,GAAG;YACpB,QAAQ,EAAE,OAAO,IAAA,iBAAY,EAC3B,QAAQ,EACR,cAAc,CACf,mBAAmB;SACrB,CAAC;QACF,MAAM,eAAe,GAAG;YACtB,UAAU,EAAE,OAAO,IAAA,mBAAc,EAC/B,QAAQ,EACR,cAAc,CACf,mBAAmB;SACrB,CAAC;QAEF,MAAM,UAAU,GAA2B;YACzC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;YACtC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;YAClC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;SACvC,CAAC;QAEF,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,MAAM,UAAU,GAAG,GAAG,KAAK,GAAG,gBAAgB,EAAE,CAAC;YACjD,IAAI,KAAK,KAAK,CAAC,EAAE;gBACf,UAAU,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC;aAC7C;iBAAM,IAAI,KAAK,GAAG,CAAC,EAAE;gBACpB,IAAI,KAAK,GAAG,IAAA,eAAK,EAAC,CAAC,GAAG,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC;gBACpC,UAAU,CAAC,UAAU,CAAC,GAAG,OAAO,IAAA,gBAAO,EACrC,QAAQ,EACR,KAAK,CACN,mBAAmB,CAAC;aACtB;iBAAM;gBACL,IAAI,KAAK,GAAG,IAAA,eAAK,EAAC,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC,CAAC;gBACrC,UAAU,CAAC,UAAU,CAAC,GAAG,OAAO,IAAA,eAAM,EACpC,QAAQ,EACR,KAAK,CACN,mBAAmB,CAAC;aACtB;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAE+C,4DAAwB"}
|