Skip to content

m-checkbox 多选项

简述

m-checkbox 表示一个可勾选选项:在 m-checkbox-group 内可多选并绑定 string[];也可脱离组单独使用,用 checked 表示布尔状态(如协议勾选)。

IMPORTANT

本组件为 mmsUnix 自研;请勿与外部未授权商业组件源码混用或逐字对照非本库文档,以免授权风险。

注意

请以 uni_modules/m-unix 与本文为准;各端差异以 uni-app 与各平台官方文档为准。涉及隐私能力(相册、定位、剪贴板、手机号等)需在 manifest 与后台完成配置。

平台差异说明

App(vue)App(nvue)H5小程序

演示地址

与线上 H5 演示基座 分包一致(文档站右下角预览 iframe 亦指向同一路径)。

类型地址
分包路径pages_demo/checkbox/checkbox
线上 H5(hash)打开演示

基本使用

完整写法与组级 v-modelm-checkbox-group。典型结构:

uvue
<m-checkbox-group v-model="hobbies" direction="row">
	<m-checkbox value="read">
		<text>阅读</text>
	</m-checkbox>
	<m-checkbox value="sport">
		<text>运动</text>
	</m-checkbox>
</m-checkbox-group>

注意:组内使用时须放在 m-checkbox-group 内;每项 value 在组内唯一。

Props

参数说明类型默认值
value选项值;组内选中时写入 modelValue;独立使用时参与 change 回调string''
disabled单项禁用(组 disabled 为 true 时全部禁用)booleanfalse
checked仅独立使用:是否选中;建议 :checked + @update:checked 双向绑定(各端兼容)booleanfalse
color选中填充色;checkOnly 时为对号颜色string''(继承组或 #5677fc
borderColor未选中时的描边颜色string''(继承组或 #cccccc
checkMarkColor填充框内对号颜色string#ffffff
size方框(或对号区)边长,rpxnumber | string40
scale图标区域整体缩放倍数number | string1
checkOnly为 true 时选中仅显示对号,无填充底booleanfalse

Events

事件名说明回调参数
update:checked独立使用时切换选中boolean
change独立使用时选中状态变化{ checked: boolean, value: string }
click点击且状态已切换(组内为切换后的该项 valuestring

插槽

名称说明
default选项文案(如图标 + 文字)

独立使用(无 group)

适用于协议勾选等单布尔场景:

uvue
<m-checkbox :checked="agree" value="1" @update:checked="agree = $event">
	<text>我已阅读并同意</text>
</m-checkbox>

在部分小程序端自定义组件对 v-model:checked 支持不完整,推荐显式 :checked + @update:checked。也可监听 @change 自行维护状态。

与表单组合

可与 m-formm-inputm-radio-group 同页使用;组内演示路径见 m-checkbox-group

Released under the MIT License.