css-color-parser-h 3.0.4 → 3.0.5

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/@types/index.d.ts CHANGED
@@ -1,388 +1,10 @@
1
- /*
2
- * @Author: roman_123
3
- * @Description:
4
- * @Date: 2023-05-26 13:29:45
5
- * @LastEditTime: 2023-06-27 19:23:00
6
- */
7
- declare module 'css-color-parser-h' {
8
- class ColorJson {
9
- r: number
10
- g: number
11
- b: number
12
- a: number
13
- }
14
- export class CssColorParser {
15
- r: number
16
- g: number
17
- b: number
18
- a: number
19
- private _outColorPrecision
20
- private _outAlphaPrecision
21
- constructor(
22
- red?: number | string,
23
- green?: number | string,
24
- blue?: number | string,
25
- alpha?: number | string
26
- )
27
- /**
28
- * @description: 设置CssColorParser实例输出的精度
29
- * @param {number} colorPrecision 输出颜色的精度
30
- * @param {number} outAlphaPrecision 输出透明度的精度
31
- * @return {CssColorParser}
32
- */
33
- setOutPrecision(
34
- colorPrecision: number,
35
- outAlphaPrecision: number
36
- ): CssColorParser
37
- /**
38
- * 设置颜色
39
- * @param red
40
- * @param green
41
- * @param blue
42
- * @param alpha
43
- * @example: this.setColor(255,255,255,1)
44
- */
45
- setColor(
46
- red?: number | string,
47
- green?: number | string,
48
- blue?: number | string,
49
- alpha?: number | string
50
- ): CssColorParser
51
- /**
52
- * @description: 设置透明度
53
- * @param {number} alpha
54
- * @return {CssColorParser}
55
- */
56
- setAlpha(alpha?: number | string): CssColorParser
57
- /**
58
- * @description: 设置红色值
59
- * @param {number} red
60
- * @return {CssColorParser}
61
- */
62
- setRed(red?: number | string): CssColorParser
63
- /**
64
- * @description: 设置绿色值
65
- * @param {number} green
66
- * @return {CssColorParser}
67
- */
68
- setGreen(green?: number | string): CssColorParser
69
- /**
70
- * @description: 设置蓝色值
71
- * @param {number} blue
72
- * @return {CssColorParser}
73
- */
74
- setBlue(blue?: number | string): CssColorParser
75
- /**
76
- * @description: 返回rgba格式的css字符串
77
- * @return {string}
78
- */
79
- toRGBA(): string
80
- /**
81
- * @description: 返回字符串
82
- * @return {string}
83
- */
84
- toString(): string
85
- /**
86
- * @description: 归一化
87
- * @return {array}
88
- */
89
- toNormalize(): [number, number, number, number]
90
- /**
91
- * @description: 返回16进制格式的css字符串
92
- * @return {string}
93
- */
94
- toHEX(): string
95
- /**
96
- * @description: 返回rgba数组
97
- * @return {array}
98
- */
99
- toArray(): [number, number, number, number]
100
- /**
101
- * @description: 返回ColorJson
102
- * @return {ColorJson}
103
- */
104
- toJson(): ColorJson
105
- /**
106
- * @description: 返回取反色后的新的实例
107
- * @return {CssColorParser}
108
- */
109
- toInvert(): CssColorParser
110
- /**
111
- * @description: 拷贝
112
- * @return {CssColorParser}
113
- */
114
- clone(): CssColorParser
115
- /**
116
- * @description: 比较两个解析对象的数据是否相等
117
- * @param {string} color
118
- * @return {boolean}
119
- */
120
- equals(color: CssColorParser): boolean
121
- /**
122
- * @description: 反色
123
- * @return {CssColorParser}
124
- */
125
- setInvert(): CssColorParser
126
- /**
127
- * @description: 乘以倍数
128
- * @param {number} scalar
129
- * @param {boolean} isSetAlpha 透明度值是否参与计算(默认:是)
130
- * @return {CssColorParser}
131
- */
132
- multiplyByScalar(scalar: number, isSetAlpha?: boolean): CssColorParser
133
- /**
134
- * @description: 除以倍数
135
- * @param {number} scalar
136
- * @param {boolean} isSetAlpha 透明度值是否参与计算(默认:是)
137
- * @return {CssColorParser}
138
- */
139
- divideByScalar(scalar: number, isSetAlpha?: boolean): CssColorParser
140
- /**
141
- * @description: 实例相加
142
- * @param {CssColorParser} colorParser
143
- * @param {boolean} isSetAlpha 透明度值是否参与计算(默认:是)
144
- * @return {CssColorParser}
145
- */
146
- add(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser
147
- /**
148
- * @description: 实例相减
149
- * @param {CssColorParser} colorParser
150
- * @param {boolean} isSetAlpha 透明度值是否参与计算(默认:是)
151
- * @return {CssColorParser}
152
- */
153
- subtract(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser
154
- /**
155
- * @description: 实例相乘
156
- * @param {CssColorParser} colorParser
157
- * @param {boolean} isSetAlpha 透明度值是否参与计算(默认:是)
158
- * @return {CssColorParser}
159
- */
160
- multiply(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser
161
- /**
162
- * @description: 实例相除
163
- * @param {CssColorParser} colorParser
164
- * @param {boolean} isSetAlpha 透明度值是否参与计算(默认:是)
165
- * @return {CssColorParser}
166
- */
167
- divide(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser
168
- /**
169
- * @description: 颜色RGB加上数字
170
- * @param {number} num
171
- * @return {CssColorParser}
172
- */
173
- addNumberForRGB(num: number): CssColorParser
174
- /**
175
- * @description: 透明度加上数字
176
- * @param {number} num
177
- * @return {CssColorParser}
178
- */
179
- addNumberForAlpha(num: number): CssColorParser
180
- /**
181
- * @description: 解析16进制颜色
182
- * @param {string} v
183
- * @return {CssColorParser}
184
- * @example: CssColorParser.parseHEX('#FFF')
185
- */
186
- static parseHEX(v: string): CssColorParser
187
- /**
188
- * @description: 解析rgba、rgb颜色
189
- * @param {string} v
190
- * @return {CssColorParser}
191
- * @example: CssColorParser.parseRGBA('rgba(255,255,255,1)')
192
- */
193
- static parseRGBA(v: string): CssColorParser
194
- /**
195
- * @description: 将ColorJson格式的json数据转换为解析对象
196
- * @param {ColorJson} json
197
- * @return {CssColorParser}
198
- * @example: CssColorParser.fromJson({r: 255, g: 255, b: 255, a: 1})
199
- */
200
- static fromJson(json: ColorJson): CssColorParser
201
- /**
202
- * @description: 将RGBA数组转换为解析对象
203
- * @param {Array} color
204
- * @return {CssColorParser}
205
- * @example: CssColorParser.fromArray([255,255,255,1])
206
- */
207
- static fromArray(color: Array<number>): CssColorParser
208
- /**
209
- * @description: 产生随机颜色
210
- * @return {CssColorParser}
211
- * @example: CssColorParser.fromRandom(new CssColorParser(0,0,0,0), new CssColorParser(255,255,255,1))
212
- */
213
- static fromRandom(
214
- color1: CssColorParser,
215
- color2: CssColorParser
216
- ): CssColorParser
217
- /**
218
- * @description: 颜色序列化数组转换为CssColorParser对象实例
219
- * @param {array} colorArr
220
- * @example: CssColorParser.fromNormaliz([1, 0, 0, 1])
221
- */
222
- static fromNormalize(
223
- colorArr: [number, number, number, number]
224
- ): CssColorParser
225
- }
226
- export class CssColorParserPlus extends CssColorParser {
227
- /**
228
- * @description: 返回取反色后的新的实例
229
- * @return {CssColorParserPlus}
230
- */
231
- toInvert(): CssColorParserPlus
232
- /**
233
- * @description: 拷贝
234
- * @return {CssColorParserPlus}
235
- */
236
- clone(): CssColorParserPlus
237
- /**
238
- * @description: 比较两个解析对象的数据是否相等
239
- * @param {string} color
240
- * @return {boolean}
241
- */
242
- equals(color: CssColorParserPlus | string): boolean
243
- /**
244
- * @description: 实例相加
245
- * @param {CssColorParserPlus} colorParser
246
- * @param {boolean} isSetAlpha 透明度值是否参与计算(默认:是)
247
- * @return {CssColorParserPlus}
248
- */
249
- add(color: CssColorParserPlus | string, isSetAlpha?: boolean): CssColorParserPlus
250
- /**
251
- * @description: 实例相减
252
- * @param {CssColorParserPlus} colorParser
253
- * @param {boolean} isSetAlpha 透明度值是否参与计算(默认:是)
254
- * @return {CssColorParserPlus}
255
- */
256
- subtract(
257
- color: CssColorParserPlus | string,
258
- isSetAlpha?: boolean
259
- ): CssColorParserPlus
260
- /**
261
- * @description: 实例相乘
262
- * @param {CssColorParserPlus} colorParser
263
- * @param {boolean} isSetAlpha 透明度值是否参与计算(默认:是)
264
- * @return {CssColorParserPlus}
265
- */
266
- multiply(
267
- color: CssColorParserPlus | string,
268
- isSetAlpha?: boolean
269
- ): CssColorParserPlus
270
- /**
271
- * @description: 实例相除
272
- * @param {CssColorParserPlus} colorParser
273
- * @param {boolean} isSetAlpha 透明度值是否参与计算(默认:是)
274
- * @return {CssColorParserPlus}
275
- */
276
- divide(color: CssColorParserPlus | string, isSetAlpha?: boolean): CssColorParserPlus
277
- /**
278
- * @description: 解析css颜色
279
- * @param {string} v
280
- * @return {CssColorParserPlus}
281
- * @example: parseCssColorStr('rgba(255,255,255,1)')
282
- */
283
- static parseColor(v: string | CssColorParserPlus): CssColorParserPlus
284
- /**
285
- * @description: 将css字符串转换为解析对象
286
- * @param {string} v
287
- * @return {CssColorParserPlus}
288
- * @example: parseCssColorStr('rgba(255,255,255,1)')
289
- */
290
- static parseCssColorStr(v: string): CssColorParserPlus
291
- /**
292
- * @description: 解析颜色关键字
293
- * @param {string} v
294
- * @return {CssColorParserPlus}
295
- * @example: parseKeyWord('red')
296
- */
297
- static parseKeyWord(v: string): CssColorParserPlus
298
- /**
299
- * @description: 解析HSLA
300
- * @param {string} v
301
- * @return {CssColorParserPlus}
302
- * @example: parseHSLA('hsla(215,85%,62%,0.8)')
303
- */
304
- static parseHSLA(v: string): CssColorParserPlus
305
- /**
306
- * @description: 解析HWB
307
- * @param {string} v
308
- * @return {CssColorParserPlus}
309
- * @example: parseHWB('hwb(215deg 30% 6% / 80%)')
310
- */
311
- static parseHWB(v: string): CssColorParserPlus
312
- /**
313
- * @description: 将HSL色彩模式转换为解析对象
314
- * @param {number} hue 色相
315
- * @param {number} saturation 饱和度
316
- * @param {number} lightness 亮度
317
- * @param {number} alpha 不透明度
318
- * @return {CssColorParserPlus}
319
- * @example: fromHSL(0,1,1,1)
320
- */
321
- static fromHSL(
322
- h: number,
323
- s: number,
324
- l: number,
325
- a?: number
326
- ): CssColorParserPlus
327
- /**
328
- * @description: 将HWB色彩模式转换为解析对象
329
- * @param {number} h 色调
330
- * @param {number} w 白度
331
- * @param {number} b 黑度
332
- * @param {number} a 不透明度
333
- * @return {CssColorParserPlus}
334
- * @example: fromHSL(0,1,1,1)
335
- */
336
- static fromHWB(
337
- h: number,
338
- w: number,
339
- b: number,
340
- a?: number
341
- ): CssColorParserPlus
342
- /**
343
- * @description: 解析16进制颜色
344
- * @param {string} v
345
- * @return {CssColorParserPlus}
346
- * @example: CssColorParserPlus.parseHEX('#FFF')
347
- */
348
- static parseHEX(v: string): CssColorParserPlus
349
- /**
350
- * @description: 解析rgba、rgb颜色
351
- * @param {string} v
352
- * @return {CssColorParserPlus}
353
- * @example: CssColorParserPlus.parseRGBA('rgba(255,255,255,1)')
354
- */
355
- static parseRGBA(v: string): CssColorParserPlus
356
- /**
357
- * @description: 将ColorJson格式的json数据转换为解析对象
358
- * @param {ColorJson} json
359
- * @return {CssColorParserPlus}
360
- * @example: CssColorParserPlus.fromJson({r: 255, g: 255, b: 255, a: 1})
361
- */
362
- static fromJson(json: ColorJson): CssColorParserPlus
363
- /**
364
- * @description: 将RGBA数组转换为解析对象
365
- * @param {Array} color
366
- * @return {CssColorParserPlus}
367
- * @example: CssColorParserPlus.fromArray([255,255,255,1])
368
- */
369
- static fromArray(color: Array<number>): CssColorParserPlus
370
- /**
371
- * @description: 产生随机颜色
372
- * @return {CssColorParserPlus}
373
- * @example: CssColorParserPlus.fromRandom('black', new CssColorParserPlus(255,255,255,1))
374
- */
375
- static fromRandom(
376
- color1: CssColorParserPlus | string,
377
- color2: CssColorParserPlus | string
378
- ): CssColorParserPlus
379
- /**
380
- * @description: 颜色序列化数组转换为CssColorParserPlus对象实例
381
- * @param {array} colorArr
382
- * @example: CssColorParserPlus.fromNormaliz([1, 0, 0, 1])
383
- */
384
- static fromNormalize(
385
- colorArr: [number, number, number, number]
386
- ): CssColorParserPlus
387
- }
388
- }
1
+ /*
2
+ * @Author: roman_123
3
+ * @Description:
4
+ * @Date: 2023-05-26 13:29:45
5
+ * @LastEditTime: 2023-06-27 19:23:00
6
+ */
7
+ import CssColorParser from "./CssColorParser"
8
+ import CssColorParserPlus from "./CssColorParserPlus"
9
+
10
+ export { CssColorParser, CssColorParserPlus };
package/example.html CHANGED
@@ -17,7 +17,7 @@
17
17
  <meta http-equiv="Pragma" content="no-cache" />
18
18
  <meta http-equiv="Expires" content="0" />
19
19
  <title>css-color-parser示例</title>
20
- <script src="./dist/css-color-parser-h.umd.min.js"></script>
20
+ <script src="./dist/css-color-parser-h.umd.js"></script>
21
21
  </head>
22
22
 
23
23
  <body>