小程序-checkbox改造

Eater在2023年03月24日发布

在开发小程序的过程中，经常要用到Checkbox来承载用户对于某选项的选择或者不选择，听上去像是废话（哈哈）。
我们先看一下小程序官方推荐的Checkbox使用方法

第一步，定义结构

<checkbox-group bindchange="checkboxChange">
  <label class="checkbox" wx:for="{{items}}">
    <checkbox value="{{item.name}}" checked="{{item.checked}}"/>{{item.value}}
  </label>
</checkbox-group>

对应到html表单，这个结构是非常容易理解的，一个多选框组，这个组内包含若干个checkbox，组的根节点负责监听用户的选择、取消选择等事件，并映射到指定的处理方法上。

第二步，定义用于渲染的初始数据

Page({
  data: {
    items: [
      {name: 'USA', value: '美国'},
      {name: 'CHN', value: '中国', checked: 'true'},
      {name: 'BRA', value: '巴西'},
      {name: 'JPN', value: '日本'},
      {name: 'ENG', value: '英国'},
      {name: 'TUR', value: '法国'},
    ]
  },
  checkboxChange: function(e) {
    console.log('checkbox发生change事件，携带value值为：', e.detail.value)
  }
})

这样，Checkbox的原生小程序组件就实现了。但是，问题来了。

原生的Checkbox太丑了！要改掉它的表现。
好吧，这种事情对于前端开发而言简直太常见了，不就是改表现嘛，咱们来重置掉它的默认表现，换成美丽的设计稿上的图片就万事大吉啦。
打开小程序开发者工具的调试模式，查看元素的样式，截图如下

Checkbox元素调试截图

心里无限的忧伤啊，完全看不到小程序是如何设置Checkbox的样式的，小程序实现Checkbox的样式代码对我们是黑盒的。
于是很多同学自己开始吭哧吭哧地编写一个模拟的组件，创建一个template，编写它的数据渲染和事件监听处理，以及对用户操作的数据进行实时更新，总之是自己要做一套类原生的工作。
本文要说的点就是，我们不用重写一套Checkbox组件，我们还是在原生的Checkbox上进行表现的重置即可，其他的继续沿用Checkbox本身的机制，工作量大大减少。
接下来是比较关键的一步

切到开发者工具
选择调试模式
选中

将鼠标hover到Checkbox上
我们会看到在鼠标的上会有元素实际选择器的显示

div.wx-checkbox-input

小程序归根结底还是要转换成实际的html来交给webview渲染，因此我们有理由怀疑，我们只要重置上面的类表现就能重置Checkbox的表现，于是先做了如下代码测试

.wx-checkbox-input{
    display: none;
}

刷新小程序页面，发现Checkbox不见了，说明我们的猜测是成立的，接下来就是去实现我们想要的Checkbox样式啦

首先，定义结构

<template name="ws-checkbox">
    <checkbox class="ws-checkbox" value="{{text}}" checked="{{checked}}"/>
</template>

然后，定义样式

.wx-checkbox-input{
    display: none;
}
.ws-checkbox {
    display: inline-block;
    width: 12px;
    height: 12px;
    background-image: url(XXX.png);
    background-size: 100%;
}
.ws-checkbox[checked] {
    background-image: url(XXX-checked.png);
}

各位只需要将上面代码中的图片地址换成自己的图片地址即可，一个自定义的Checkbox就实现啦，而且，对于使用其原生的任何功能都没有影响。

有了上面介绍的方法，大家还可以去实现自定义的radio-button哦。

瓦尔登湖