Skip to content

Checkbox 复选框

用于在多个选项中选择一个或多个。基于 BrConfigProvider 实现全局主题配置。

基础用法

Example

复选框组

使用 BrCheckboxGroup 来组合多个复选框。

Selected: [ "apple" ]
Example

不确定状态 (Indeterminate)

indeterminate 状态用于复选框既非选中也非未选中的状态(例如:全选/半选)。

Example

尺寸

我们提供了一组默认尺寸,你可以通过 size 属性来控制。

Example

禁用状态

Disabled Group

Example

主题定制

全局定制 (BrConfigProvider)

你可以通过 BrConfigProvidertheme 属性覆盖默认 CSS 变量。

vue
<template>
  <BrConfigProvider :theme="{ primary: '#10B981', radius: 0.5 }">
    <BrCheckbox v-model="checked" label="Custom Theme" />
  </BrConfigProvider>
</template>

局部定制 (TailwindCSS)

你可以直接在包装器上使用 TailwindCSS 工具类覆盖样式。

vue
<template>
  <BrCheckbox class="mb-4" label="Margin Bottom" />
</template>

API

BrCheckbox

Props

名称类型默认值说明
modelValueboolean | string | numberundefined绑定值
valuestring | number | booleanundefined复选框的值(在组中使用)
disabledbooleanfalse是否禁用
indeterminatebooleanfalse是否处于不确定状态
labelstringundefined标签文本
idstringundefinedInput id
namestringundefinedInput name
requiredbooleanfalse是否必填
errorbooleanfalse是否处于错误状态
size'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | 'default''default'尺寸

Emits

名称说明参数
update:modelValue更新模型值(value: boolean | string | number)
change变更事件(value: boolean | string | number)

Slots

名称说明
default标签内容
icon自定义图标插槽

BrCheckboxGroup

Props

名称类型默认值说明
modelValue(string | number)[][]绑定值数组
disabledbooleanfalse是否禁用组内所有复选框
size'sm' | 'default' | 'lg''default'组内所有复选框的尺寸
namestringundefined所有复选框的 name 属性

Emits

名称说明参数
update:modelValue更新模型值(value: (string | number)[])
change变更事件(value: (string | number)[])