Skip to content

Full features javascript color parser module, perfect work with vue.js; support RGB, HSL, HSV/HSB, HSL255, HSL240, HWB, XYZ, LAB, LUV, LHCab, xyY...

Notifications You must be signed in to change notification settings

nullice/ichiColor

Repository files navigation

ichiColor

Coverage Status

一个数据响应风格的 Javascript 颜色处理模块

// __ // ___ ____/ /\ // / /\ / /:\_:\/:\ // / /:/ /__/::/\/:/\:\ // / /:/ \__\/\ /::\/:/__ // / /:/ /__/:/\:/:/ \:\ // / /:/ \ \:\/:/ /::/ // / /:/ \ \::/ /::/ // /__/:/ \ \:\/::/ // \__\/ \ \::/ // \__\/ //

Features

支持色彩以下色彩值间的转换:

  • rgb
  • hsl
  • hsv (hsb)
  • hwb
  • hex (色彩值十六进制文本)
  • int (色彩值十进制整数)
  • rgba (CSS 格式 RGBA 文本)

extension 扩展功能

  • hsl255 (Microsoft Office 色彩选择器风格)
  • hsl240 (Windows 系统色彩选择器风格)
  • labPs (D50 白点, Photoshop 风格)
  • lab (D65 白点)
  • xyz
  • xyY
  • LCHab
  • luv
  • theLuma_Rec709 (只读, Rec709 标准辉度)
  • theLuma_WCAG (只读, Rec709 标准辉度)
  • theWavelength (只读, 光谱波长)
  • getWCAGcontrastThan() (计算 Web 无障碍标准颜色对比度)

配合 Vue.js 可以用非常少的代码完成色彩选择器,如 demo

 <input v-model="color1.r" type="text" > //用 vue 直接绑定属性 

比其他同类库有更高的性能表现,如遍历所有颜色,比 one-color 快一个数量级

Usage

import

ES6 方式的模块载入:

import IchiColor from "./ichi-color.js"

compute

一个 IchiColor 的实例表示一个颜色,创建实例时可省略 new 关键字:

var color1 = new IchiColor("#FF0022") var color2 = IchiColor("#FF0022") // 可以省略 new  var color3 = IchiColor({r: 7, g: 58, b: 95}) var color4 = IchiColor({h: 205, s: 87, l: 20}) var color5 = IchiColor([255,211,22]) //[r,g,b] var color6 = IchiColor(16711714) //10 进制色彩值 ...

通过 IchiColor 实例上的属性来获取和设置各种颜色信息:

color1.r //255 color1.g //0 color1.b //34 color1.hex //"#ff0022" color1.int //16711714 (10 进制色彩值) color1.rgba //"rgba(255, 0, 34, 1)" color1.alpha  //1 (rgba 的不透明度) color1.hsl.h //352 color1.hsl.s //100 color1.hsl.l //50 color1.hsv.h //352 color1.hsv.s //100 color1.hsv.v //100 color1.hwb.h //352 color1.hwb.w //0 color1.hwb.b //0

可直接修改属性来设置颜色:

color1.r //255 color1.g //0 color1.b //34 color1.hex //"#ff0022" color1.r = 100 color1.hex //"#640022" color1.hex = "#32a3f1" color1.r //50  color1.g //163 color1.b //241 color1.hsl.l = 20 color1.r //7 color1.g //58 color1.b //95 ...

另外还可以使用实例上的 set() 方法,其可传入的参数格式和创建实例时的完全一致:

color1.set("#ff0022") color1.set({h: 205, s: 93, v: 37}) color1.set(16711714) //(10 进制色彩值) 

除了实例上的属性,实例对象还有一些方法,用来返回包含色彩信息的对象:

color1.getRGB() //{r: 7, g: 58, b: 95} color1.getRedGrainBlue() //{red: 7, grain: 58, blue: 95} color1.getRedGreenBlue() //{red: this.r, green: this.g, blue: this.b }; color1.getHSL() //{h: 205, s: 87, l: 20} color1.getHSV() //{h: 205, s: 93, v: 37} color1.getHWB() //{h: 205, w: 3, b: 63}

这些格式的对象,都可以用来创建颜色实例:

var color4 = IchiColor({red: 7, grain: 58, blue: 95})

另外有 2 个方法可以创建 IchiColor 实例的副本:

var newColor1 = color1.getClone() // 创建实例颜色的副本 newColor1.hex //"#073a5f" var newColor2 = color1.getInvertColor() //创建实例颜色反色的副本 newColor2.hex //"#f8c5a0"

Extension

一些不常用的功能通过扩展来通过提供

使用扩展功能的载入:

import IchiColor_base from "./ichi-color.js" import IchiColorEx from "./ichi-color-extension.js" var IchiColor = IchiColorEx(IchiColor_base) //添加扩展功能

之后 IchiColor 的实例会有 ichiColor.ex 属性,其中就是扩展功能

扩展功能:

  • ichiColor.ex.hsl255 (Microsoft Office 色彩选择器风格)
  • ichiColor.ex.hsl240 (Windows 系统色彩选择器风格)
  • ichiColor.ex.labPs (D50 白点, Photoshop 风格)
  • ichiColor.ex.lab (D65 白点)
  • ichiColor.ex.xyz
  • ichiColor.ex.xyY
  • ichiColor.ex.LCHab
  • ichiColor.ex.luv
  • ichiColor.ex.theLuma_Rec709 (只读, Rec709 标准辉度)
  • ichiColor.ex.theLuma_WCAG (只读, Web 无障碍标准辉度)
  • ichiColor.ex.theWavelength (只读, 光谱波长)
  • ichiColor.ex.getWCAGcontrastThan( ichiColor ) (计算 Web 无障碍标准颜色对比度)

扩展功能的色彩计算使用了 ColorRNA.js 库,并没有做特别的优化,使用扩展后色彩计算速度会有下降,可以通过设置的实例的属性 ichiColor.__ex_enable 为 false 来暂停扩展功能。

Other

由于使用了 ECMAScript 5.1 标准里的 setter 和 getter ,IE8 及以下的浏览器无法使用

虽然 IchiColor 的实例属性是 getter,不过取值时没有色彩计算过程(色彩计算在 set 时完成),不用担心连续取值性能问题

如果想要更多的功能,如色彩空间转换、色差计算,可以使用我另一个计算功能更多的色彩库: ColorRNA

本来想叫 oneColor 的无奈名字被先用了,只好叫 ichiColor 了

License

MIT

About

Full features javascript color parser module, perfect work with vue.js; support RGB, HSL, HSV/HSB, HSL255, HSL240, HWB, XYZ, LAB, LUV, LHCab, xyY...

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published