组件关系
可独立绑定勾选状态，也可放入 多选组 组成连续按钮。需要 options 自动渲染时使用 多选集合 的 type="button"。
使用场景
通过 value 定义单项身份，default 插槽定义显示内容；放入对应 Group 统一维护选择。 与自动消费 options 的 Checkbox 集合入口分开。
组合与双向绑定
单项使用 value；label 用于显示或可访问说明，不依赖旧 label 充当选择值。禁用项无法更改。
组合与双向绑定
vue
<template>
<div class="example">
<AsamCheckboxGroup v-model="value">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="off" disabled> 停用 </AsamCheckboxButton>
</AsamCheckboxGroup>
<output>选择：{{ value }}</output>
</div>
</template>
<script lang="ts" setup>
defineOptions({ name: 'AsamCheckboxButtonBasicExample' });
import { ref } from 'vue';
import { AsamCheckboxGroup, AsamCheckboxButton } from '@asam-ui/ui';
const value = ref<string[]>(['design']);
</script>
<style scoped>
.example {
display: grid;
gap: var(--asam-space-md, 16px);
min-width: 0;
}
.row {
display: flex;
flex-wrap: wrap;
align-items: center;
gap: var(--asam-space-sm, 8px);
}
.density-grid {
display: grid;
gap: var(--asam-space-md, 16px);
grid-template-columns: repeat(auto-fit, minmax(min(100%, 260px), 1fr));
}
section {
display: grid;
gap: var(--asam-space-sm, 8px);
min-width: 0;
}
output {
overflow-wrap: anywhere;
color: var(--asam-color-text-secondary);
}
</style>vue
<template>
<div class="example">
<AsamCheckboxGroup v-model="value">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="off" disabled> 停用 </AsamCheckboxButton>
</AsamCheckboxGroup>
<output>选择：{{ value }}</output>
</div>
</template>
<script setup>
defineOptions({ name: 'AsamCheckboxButtonBasicExample' });
import { ref } from 'vue';
import { AsamCheckboxGroup, AsamCheckboxButton } from '@asam-ui/ui';
const value = ref(['design']);
</script>
<style scoped>
.example {
display: grid;
gap: var(--asam-space-md, 16px);
min-width: 0;
}
.row {
display: flex;
flex-wrap: wrap;
align-items: center;
gap: var(--asam-space-sm, 8px);
}
.density-grid {
display: grid;
gap: var(--asam-space-md, 16px);
grid-template-columns: repeat(auto-fit, minmax(min(100%, 260px), 1fr));
}
section {
display: grid;
gap: var(--asam-space-sm, 8px);
min-width: 0;
}
output {
overflow-wrap: anywhere;
color: var(--asam-color-text-secondary);
}
</style>选择限制与独立状态
本 Button 入口保留共享 Checkbox 类型中的 id、border、indeterminate 兼容字段。 完整说明。
选择限制与独立状态
vue
<template>
<div class="example">
<AsamCheckboxGroup v-model="value" :min="1" :max="2">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="ops"> 运维 </AsamCheckboxButton>
</AsamCheckboxGroup>
<AsamCheckboxItem v-model="checked" :indeterminate="!checked">
独立勾选项
</AsamCheckboxItem>
<output>集合：{{ value }}；独立：{{ checked }}</output>
</div>
</template>
<script lang="ts" setup>
defineOptions({ name: 'AsamCheckboxButtonStatesExample' });
import { ref } from 'vue';
import { AsamCheckboxGroup, AsamCheckboxButton, AsamCheckboxItem } from '@asam-ui/ui';
const value = ref<string[]>(['design']);
const checked = ref(false);
</script>
<style scoped>
.example {
display: grid;
gap: var(--asam-space-md, 16px);
min-width: 0;
}
.row {
display: flex;
flex-wrap: wrap;
align-items: center;
gap: var(--asam-space-sm, 8px);
}
.density-grid {
display: grid;
gap: var(--asam-space-md, 16px);
grid-template-columns: repeat(auto-fit, minmax(min(100%, 260px), 1fr));
}
section {
display: grid;
gap: var(--asam-space-sm, 8px);
min-width: 0;
}
output {
overflow-wrap: anywhere;
color: var(--asam-color-text-secondary);
}
</style>vue
<template>
<div class="example">
<AsamCheckboxGroup v-model="value" :min="1" :max="2">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="ops"> 运维 </AsamCheckboxButton>
</AsamCheckboxGroup>
<AsamCheckboxItem v-model="checked" :indeterminate="!checked">
独立勾选项
</AsamCheckboxItem>
<output>集合：{{ value }}；独立：{{ checked }}</output>
</div>
</template>
<script setup>
defineOptions({ name: 'AsamCheckboxButtonStatesExample' });
import { ref } from 'vue';
import { AsamCheckboxGroup, AsamCheckboxButton, AsamCheckboxItem } from '@asam-ui/ui';
const value = ref(['design']);
const checked = ref(false);
</script>
<style scoped>
.example {
display: grid;
gap: var(--asam-space-md, 16px);
min-width: 0;
}
.row {
display: flex;
flex-wrap: wrap;
align-items: center;
gap: var(--asam-space-sm, 8px);
}
.density-grid {
display: grid;
gap: var(--asam-space-md, 16px);
grid-template-columns: repeat(auto-fit, minmax(min(100%, 260px), 1fr));
}
section {
display: grid;
gap: var(--asam-space-sm, 8px);
min-width: 0;
}
output {
overflow-wrap: anywhere;
color: var(--asam-color-text-secondary);
}
</style>四档尺寸与上下文继承
四个实例分别显式使用 large、big、default、small。下面省略 size 的实例随 ConfigProvider 响应切换；显式 size 覆盖祖先。面板本身没有 size 契约的入口不附加虚构尺寸属性。
四档尺寸与上下文继承
vue
<template>
<div class="example">
<div class="density-grid">
<section data-density="large">
<strong> large </strong>
<AsamCheckboxGroup v-model="value" size="large">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="off" disabled> 停用 </AsamCheckboxButton>
</AsamCheckboxGroup>
</section>
<section data-density="big">
<strong> big </strong>
<AsamCheckboxGroup v-model="value" size="big">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="off" disabled> 停用 </AsamCheckboxButton>
</AsamCheckboxGroup>
</section>
<section data-density="default">
<strong> default </strong>
<AsamCheckboxGroup v-model="value" size="default">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="off" disabled> 停用 </AsamCheckboxButton>
</AsamCheckboxGroup>
</section>
<section data-density="small">
<strong> small </strong>
<AsamCheckboxGroup v-model="value" size="small">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="off" disabled> 停用 </AsamCheckboxButton>
</AsamCheckboxGroup>
</section>
</div>
<AsamConfigProvider :size="density">
<section data-density="inherited">
<AsamCheckboxGroup v-model="value">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="off" disabled> 停用 </AsamCheckboxButton>
</AsamCheckboxGroup>
</section>
</AsamConfigProvider>
<div class="row">
<AsamButton type="default" @click="density = 'small'"> 继承 small </AsamButton>
<AsamButton type="default" @click="density = 'big'"> 继承 big </AsamButton>
</div>
<output>配置提供器：{{ density }}</output>
</div>
</template>
<script lang="ts" setup>
defineOptions({ name: 'AsamCheckboxButtonSizesExample' });
import { ref } from 'vue';
import { AsamCheckboxGroup, AsamCheckboxButton, AsamConfigProvider, AsamButton } from '@asam-ui/ui';
import type { AsamControlSize } from '@asam-ui/ui';
const density = ref<AsamControlSize>('big');
const value = ref<string[]>(['design']);
</script>
<style scoped>
.example {
display: grid;
gap: var(--asam-space-md, 16px);
min-width: 0;
}
.row {
display: flex;
flex-wrap: wrap;
align-items: center;
gap: var(--asam-space-sm, 8px);
}
.density-grid {
display: grid;
gap: var(--asam-space-md, 16px);
grid-template-columns: repeat(auto-fit, minmax(min(100%, 260px), 1fr));
}
section {
display: grid;
gap: var(--asam-space-sm, 8px);
min-width: 0;
}
output {
overflow-wrap: anywhere;
color: var(--asam-color-text-secondary);
}
</style>vue
<template>
<div class="example">
<div class="density-grid">
<section data-density="large">
<strong> large </strong>
<AsamCheckboxGroup v-model="value" size="large">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="off" disabled> 停用 </AsamCheckboxButton>
</AsamCheckboxGroup>
</section>
<section data-density="big">
<strong> big </strong>
<AsamCheckboxGroup v-model="value" size="big">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="off" disabled> 停用 </AsamCheckboxButton>
</AsamCheckboxGroup>
</section>
<section data-density="default">
<strong> default </strong>
<AsamCheckboxGroup v-model="value" size="default">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="off" disabled> 停用 </AsamCheckboxButton>
</AsamCheckboxGroup>
</section>
<section data-density="small">
<strong> small </strong>
<AsamCheckboxGroup v-model="value" size="small">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="off" disabled> 停用 </AsamCheckboxButton>
</AsamCheckboxGroup>
</section>
</div>
<AsamConfigProvider :size="density">
<section data-density="inherited">
<AsamCheckboxGroup v-model="value">
<AsamCheckboxButton value="design"> 设计 </AsamCheckboxButton>
<AsamCheckboxButton value="dev"> 开发 </AsamCheckboxButton>
<AsamCheckboxButton value="off" disabled> 停用 </AsamCheckboxButton>
</AsamCheckboxGroup>
</section>
</AsamConfigProvider>
<div class="row">
<AsamButton type="default" @click="density = 'small'"> 继承 small </AsamButton>
<AsamButton type="default" @click="density = 'big'"> 继承 big </AsamButton>
</div>
<output>配置提供器：{{ density }}</output>
</div>
</template>
<script setup>
defineOptions({ name: 'AsamCheckboxButtonSizesExample' });
import { ref } from 'vue';
import { AsamCheckboxGroup, AsamCheckboxButton, AsamConfigProvider, AsamButton } from '@asam-ui/ui';
const density = ref('big');
const value = ref(['design']);
</script>
<style scoped>
.example {
display: grid;
gap: var(--asam-space-md, 16px);
min-width: 0;
}
.row {
display: flex;
flex-wrap: wrap;
align-items: center;
gap: var(--asam-space-sm, 8px);
}
.density-grid {
display: grid;
gap: var(--asam-space-md, 16px);
grid-template-columns: repeat(auto-fit, minmax(min(100%, 260px), 1fr));
}
section {
display: grid;
gap: var(--asam-space-sm, 8px);
min-width: 0;
}
output {
overflow-wrap: anywhere;
color: var(--asam-color-text-secondary);
}
</style>ASAM 扩展与迁移
ASAM 扩展为四档 size 和组内上下文继承。default 插槽只负责展示。Item、Button、Group 不提供实例方法，不能调用集合或输入组件的 focus。事件及当前可用属性以下方实际公开类型为准。
API 阅读方式
下方 Props、Events、Slots、Exposes 按当前实际公开类型与运行默认值生成。组合属性按分支生效，不能任意混搭值模式。标为“未知 / 未声明”的默认值不代表 false 或空值。源码区域提供对应语言的独立 Demo.vue，可直接复制或下载；本地辅助组件、数据和素材已内联到当前文件。
基础公开委托
透传基础控件的公开能力，保留 ASAM 四档尺寸与品牌样式。 完整说明。
API
属性 AsamCheckboxButtonProps
| 属性名 | 说明 | 类型 | 默认值 |
|---|---|---|---|
ariaLabel | — | string | undefined | — |
disabled | 是否禁用 | boolean | undefined | undefined |
tabindex | 输入框的 tabindex | string | number | undefined | — |
name | 原生 name 属性 | string | undefined | undefined |
value | 选中状态的值，只有在绑定对象类型为 array 时有效。 | string | number | boolean | Record<string, any> | undefined | undefined |
modelValue | 选中项绑定值 | string | number | boolean | undefined | undefined |
label | 在 checkbox-group 中使用时的复选框标签。 | string | number | boolean | Record<string, any> | undefined | undefined |
checked | 当前是否勾选 | boolean | undefined | false |
validateEvent | 是否触发表单验证 | boolean | undefined | true |
ariaControls | — | string | undefined | — |
trueValue | 选中时的值 | string | number | undefined | undefined |
falseValue | 没有选中时的值 | string | number | undefined | undefined |
trueLabel | 选中时的值 | string | number | undefined | undefined |
falseLabel | 没有选中时的值 | string | number | undefined | undefined |
size | — | enum"large" | "big" | "default" | "small"完整类型：AsamControlSize | undefined | undefined |
id | 兼容共享 Checkbox 属性；参与内部控件身份计算，但 Button 模板不直接绑定到 input id。 | string | undefined | undefined |
border | 兼容共享 Checkbox 属性；Button 不使用此值添加边框，边框由按钮状态与样式决定。 | boolean | undefined | false |
indeterminate | 兼容共享 Checkbox 属性；Button 不渲染半选样式，部分选择状态请使用 AsamCheckboxItem。 | boolean | undefined | false |
事件 AsamCheckboxButtonEmits
| 属性名 | 说明 | 类型 | 默认值 |
|---|---|---|---|
update:modelValue | — | (AsamCheckboxButtonEmits)["update:modelValue"] | — |
change | — | (AsamCheckboxButtonEmits)["change"] | — |
插槽 AsamCheckboxButtonSlots
| 属性名 | 说明 | 类型 | 默认值 |
|---|---|---|---|
default | — | (() => unknown) | undefined | — |
实例方法与状态 AsamCheckboxButtonExpose
用法与契约补充说明
选择限制与独立状态
本 Button 入口保留共享 Checkbox 类型中的 id、border、indeterminate 兼容字段。id 参与原生内部控件身份计算，但 Button 模板不直接把它绑定到 input；border 不控制按钮边框；indeterminate 不呈现半选样式。需要半选显示时使用 AsamCheckboxItem，按钮边框由按钮状态和样式决定。
基础公开委托
本入口直接委托底层依赖 2.14.7 对应组件的公开能力；公开 props/defaults、全部事件实参与插槽保持原生行为，仅增加 ASAM 四档尺寸与品牌样式。需要规范化 options、对象或字符串存储时使用本站 AsamRadio / AsamCheckbox 聚合入口。组内 Button 由原生样式处理首中尾连接、选中、禁用、焦点与键盘。
关联组件
参数与事件补充说明
共享基础 Checkbox 参数，并承接 Button 适用能力与 ASAM 尺寸密度。
参数与事件说明
ariaLabel
必填：否；声明来源：上游声明。
disabled
必填：否；声明来源：上游声明。
disabled 参数与事件数据
下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。
枚举：false / true
默认值与来源
undefined（已安装运行时；已安装组件）tabindex
必填：否；声明来源：上游声明。
name
必填：否；声明来源：上游声明。
默认值与来源
undefined（已安装运行时；已安装组件）value
必填：否；声明来源：上游声明。
value 参数与事件数据
下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。
枚举：false / true
默认值与来源
undefined（已安装运行时；已安装组件）modelValue
必填：否；声明来源：上游声明。
modelValue 参数与事件数据
下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。
枚举：false / true
默认值与来源
undefined（已安装运行时；已安装组件）label
必填：否；声明来源：上游声明。
label 参数与事件数据
下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。
枚举：false / true
默认值与来源
undefined（已安装运行时；已安装组件）checked
必填：否；声明来源：上游声明。
checked 参数与事件数据
下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。
枚举：false / true
默认值与来源
false（隐式 Boolean 默认；已安装组件）validateEvent
必填：否；声明来源：上游声明。
validateEvent 参数与事件数据
下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。
枚举：false / true
默认值与来源
true（已安装运行时；已安装组件）ariaControls
必填：否；声明来源：上游声明。
trueValue
必填：否；声明来源：上游声明。
默认值与来源
undefined（已安装运行时；已安装组件）falseValue
必填：否；声明来源：上游声明。
默认值与来源
undefined（已安装运行时；已安装组件）trueLabel
必填：否；声明来源：上游声明。
默认值与来源
undefined（已安装运行时；已安装组件）falseLabel
必填：否；声明来源：上游声明。
默认值与来源
undefined（已安装运行时；已安装组件）size
必填：否；声明来源：ASAM 声明。
size 参数与事件数据
下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。
枚举："large" / "big" / "default" / "small"
默认值与来源
undefined（源码表达式；ASAM 声明）id
必填：否；声明来源：ASAM 声明。
默认值与来源
undefined（已安装运行时；已安装组件）border
必填：否；声明来源：ASAM 声明。
border 参数与事件数据
下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。
枚举：false / true
默认值与来源
false（隐式 Boolean 默认；已安装组件）indeterminate
必填：否；声明来源：ASAM 声明。
indeterminate 参数与事件数据
下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。
枚举：false / true
默认值与来源
false（隐式 Boolean 默认；已安装组件）AsamCheckboxButtonProps 公开类型视图
ts
import type { AsamCheckboxButtonProps, AsamControlSize } from '@asam-ui/ui';
// AsamCheckboxButtonProps
type PublicContract = {
"ariaLabel"?: string | undefined;
"disabled"?: boolean | undefined;
"tabindex"?: string | number | undefined;
"name"?: string | undefined;
"value"?: string | number | boolean | Record<string, any> | undefined;
"modelValue"?: string | number | boolean | undefined;
"label"?: string | number | boolean | Record<string, any> | undefined;
"checked"?: boolean | undefined;
"validateEvent"?: boolean | undefined;
"ariaControls"?: string | undefined;
"trueValue"?: string | number | undefined;
"falseValue"?: string | number | undefined;
"trueLabel"?: string | number | undefined;
"falseLabel"?: string | number | undefined;
"size"?: AsamControlSize | undefined;
"id"?: string | undefined;
"border"?: boolean | undefined;
"indeterminate"?: boolean | undefined;
};参数与事件说明
update:modelValue
必填：是；声明来源：上游声明。
change
必填：是；声明来源：上游声明。
AsamCheckboxButtonEmits 公开类型视图
ts
import type { AsamCheckboxButtonEmits } from '@asam-ui/ui';
// AsamCheckboxButtonEmits
type PublicContract = {
"update:modelValue": (AsamCheckboxButtonEmits)["update:modelValue"];
"change": (AsamCheckboxButtonEmits)["change"];
};参数与事件说明
default
必填：否；声明来源：ASAM 声明。
default 参数与事件数据
下列为声明可读视图；可导入类型以公开类型视图为准。分支条件与父属性一致。
事件参数：(): unknown
AsamCheckboxButtonSlots 公开类型视图
ts
import type { AsamCheckboxButtonSlots } from '@asam-ui/ui';
// AsamCheckboxButtonSlots
type PublicContract = {
"default"?: (() => unknown) | undefined;
};AsamCheckboxButtonExpose 公开类型视图
ts
import type { AsamCheckboxButtonExpose } from '@asam-ui/ui';
// AsamCheckboxButtonExpose
type PublicContract = {
[key: string]: never;
};