Skip to content

t-checkbox

Checkbox 多选框

组件介绍

t-checkbox 是一个多选复选框组件,支持自定义样式、状态和事件自定义图标,适用于各种表单场景。组件提供了多种模式(复选框、按钮、单元格),支持主题类型、尺寸、禁用状态等配置,可与 t-checkbox-group 组件配合使用,实现多选功能。

平台兼容

HarmonyH5AndroidiOS小程序UTS

基础用法

基础用法参考 demo/checkbox/checkbox.uvue,通过 checked 属性设置选中状态,使用 label 属性设置标签文本。

vue
<template>
  <!-- 基础复选框 -->
  <t-checkbox v-model:checked="checked1" label="选项1" class="mb-20"></t-checkbox>
  <t-checkbox v-model:checked="checked2" label="选项2" class="mb-20"></t-checkbox>
  <t-checkbox v-model:checked="checked3" label="选项3" disabled class="mb-20"></t-checkbox>

  <!-- 按钮模式 -->
  <t-checkbox mode="button" v-model:checked="checked4" label="按钮1" type="primary" class="mr-20"></t-checkbox>
  <t-checkbox mode="button" v-model:checked="checked5" label="按钮2" type="success" class="mr-20"></t-checkbox>
  <t-checkbox mode="button" v-model:checked="checked6" label="按钮3" type="warning" class="mr-20"></t-checkbox>

  <!-- 单元格模式 -->
  <t-checkbox mode="cell" v-model:checked="checked7" label="单元格1" class="mb-10"></t-checkbox>
  <t-checkbox mode="cell" v-model:checked="checked8" label="单元格2" class="mb-10"></t-checkbox>
</template>

<script setup>
const checked1 = ref(false);
const checked2 = ref(true);
const checked3 = ref(false);
const checked4 = ref(false);
const checked5 = ref(true);
const checked6 = ref(false);
const checked7 = ref(false);
const checked8 = ref(true);
</script>

Props

属性名说明类型默认值
path点击组件后跳转的页面路径;为空时仅响应事件string''
hover是否启用点击效果booleanfalse
type组件主题类型,可选 infoprimaryerrorwarningsuccessstring''
disabled是否禁用booleanfalse
effect组件显示主题,可选 normaldarklightplainstring''
size组件尺寸,可选 largemediumsmallministring''
transition是否开启图标动画booleanfalse
duration图标动画时间number200
border是否显示边框booleantrue
checked是否被选中booleanfalse
value当前选中的值string''
label标签string''
labelClass标签的样式any''
icon图标string'check-fill'
iconBoxClass图标盒子的样式any''
activeClass被选中时的样式any''
inactiveClass未选中时的样式any''
iconClass图标样式any''
activeIconClass被选中时图标的样式any''
inactiveIconClass未被选中时图标的样式any''
activeLabelClass被选中时标签的样式any''
inactiveLabelClass未被选中时标签的样式any''
mode筛选框的样式,可选 checkboxcellbuttonstring'checkbox'

Events

事件名说明回调参数
change复选框状态变化时触发boolean
select选择时触发boolean
click点击时触发UniPointerEvent
initFinished组件初始化完成时触发,返回组件节点信息NodeInfo
touchstart触摸开始时触发-
touchend触摸结束时触发-
touchmove触摸移动时触发-
touchcancel触摸取消时触发-
transitionend动画结束时触发-

Slots

插槽名说明
default默认插槽,用于自定义标签内容
label标签插槽,用于自定义标签的显示