Checkbox 多选框


多选框组件

使用指南

在 Taro 文件中引入组件

  1. import { AtCheckbox } from 'taro-ui'

组件依赖的样式文件(仅按需引用时需要)

  1. @import "~taro-ui/dist/style/components/checkbox.scss";
    @import "~taro-ui/dist/style/components/icon.scss";

一般用法

说明:

  • 该组件为受控组件,开发者需要通过 onChange 事件来更新 selectedList 值变化,selectedList 与 onChange 函数必填

  • 由于小程序组件化的限制,AtCheckbox 嵌套在 AtForm 或原生小程序组件 Form 中的时候,onSubmit 事件获得的 event 中的 event.detail.value 始终为空对象,开发者要获取数据,可以自行在页面的 state 中获取

  1. import Taro from '@tarojs/taro'
    import { View } from '@tarojs/components'
    import { AtCheckbox } from 'taro-ui'
    export default class Index extends Taro.Component {
    constructor () {
    super(...arguments)
    this.state = {
    checkedList: ['list1']
    }
    this.checkboxOption = [{
    value: 'list1',
    label: 'iPhone X',
    desc: '部分地区提供电子普通发票,用户可自行打印,效力等同纸质普通发票,具体以实际出具的发票类型为准。'
    },{
    value: 'list2',
    label: 'HUAWEI P20'
    },{
    value: 'list3',
    label: 'OPPO Find X',
    desc: '部分地区提供电子普通发票,用户可自行打印,效力等同纸质普通发票,具体以实际出具的发票类型为准。',
    disabled: true
    },{
    value: 'list4',
    label: 'vivo NEX',
    desc: '部分地区提供电子普通发票,用户可自行打印,效力等同纸质普通发票,具体以实际出具的发票类型为准。',
    disabled: true
    }]
    }
    handleChange (value) {
    this.setState({
    checkedList: value
    })
    }
    render () {
    return (
    <AtCheckbox
    options={this.checkboxOption}
    selectedList={this.state.checkedList}
    onChange={this.handleChange.bind(this)}
    />
    )
    }
    }

参数

参数说明类型可选值默认值
selectedList被选中的选项列表 eg: ['list1'],开发者需要通过 onChange 事件来更新 selectedList 值,必填Array--
optionsobject选项列表,object 字段详细看下表Array--

options object 字段详解

参数说明类型可选值默认值可选或必填
value选项标识符,必须保证唯一String--必填
label选项标题String--必填
desc选项描述,显示在标题下方的文字String--可选
disabled是否禁止点击Boolean-false可选

事件

事件名称说明返回参数
onChange必填,需要通过该事件来改变state的值,输入框值改变时触发的事件选中的 value 列表

Checkbox多选框 - 图1