颜色选择器

颜色选择器 colorpicker 用于对颜色的快捷选择,支持 hex,rgb,rgba 三种颜色类型。

示例

  

将颜色值赋给表单

  

设置 RGB / RGBA

  

开启透明度

  

预定义颜色项

  

全功能和回调的使用

  

颜色框尺寸

  

同时绑定多个元素

  

API

API 描述
var colorpicker = layui.colorpicker 获得 colorpicker 模块。
colorpicker.render(options) colorpicker 组件渲染,核心方法。

渲染

colorpicker.render(options);

  • 参数 options : 基础属性配置项。#详见属性
    2.7+ : 除 elem 属性外,其他基础属性也可以直接写在元素的 lay-options="{}" 属性中。
<div id="ID-test-colorpicker"></div>
<div class="class-test-colorpicker" lay-options="{color: '#333'}"></div>
<div class="class-test-colorpicker" lay-options="{color: '#777'}"></div>
<!-- import layui --> 
<script>
layui.use(function(){
  var colorpicker = layui.colorpicker;
  // 单个渲染
  colorpicker.render({
    elem: '#ID-test-colorpicker'
  });
  // 批量渲染
  colorpicker.render({
    elem: '.class-test-colorpicker'
  });
});
</script>

属性

属性名 描述 类型 默认值
elem

绑定元素选择器或 DOM 对象

string/DOM -
color

默认颜色值,值的格式跟随 format 属性的设定。

string -
format

颜色显示/输入格式,支持 hex rgb 。 若同时开启 alpha 属性,则颜色值自动变为 rgba

string

hex

alpha

是否开启透明度。当同时开启 format: 'rgb' 时,color 值将采用 rgba 格式。

boolean

false

predefine

是否开启预定义颜色栏

boolean

false

colors

设置可选的颜色列表,需开启 predefine: true 有效。
用法详见:#预定义颜色项

array -
size

颜色框的尺寸,可选值: lg sm xs

string

sm

change

颜色被改变的回调函数。用法详见:#示例

change: function(value){
  console.log(value); // 当前颜色值
}
done

颜色选择完毕的回调函数。点击“确认”和“清除”按钮均会触发

done: function(value){
  console.log(value); // 当前选中的颜色值
}

用法详见:#示例

cancel 2.8+

取消颜色选择的回调函数,一般点击非颜色选择面板区域触发。

cancel: function(value){
  console.log(value); // 当前颜色值
}

用法详见:#示例

close 2.8+

颜色选择面板被关闭后即触发。

close: function(value){
  console.log(value); // 当前颜色值
}

兼容性

colorpicker 组件支持 Chrome,Edge,Firefox 等所有高级浏览器,不支持 IE10 低版本浏览器。