多选框 Checkbox

多选框

使用

API

安装使用

import { TiCheckbox, TiCheckboxGroup, TiCheckboxButton } from '@titian-design/mobile-vue';

用法示例

TiCheckbox 示例

单独使用

checkbox

组件附带文字内容

codesanbox

copy

code

<template>
  <TiCheckbox label="checkbox" />
  <TiCheckbox>checkbox</TiCheckbox>
  <TiCheckbox />
</template>

<script lang="ts" setup>
import { TiCheckbox } from 'titian-h5-vue';
</script>

禁用多选框点击效果

当设置 disabled 时， 组件将禁用组件的图标和文字的点击切换效果，当设置 labelDisabled 时将禁用文字的点击效果，实现更细粒的控制。

codesanbox

copy

code

<template>
  <TiCheckbox disabled label="checkbox" />
  <TiCheckbox disabled defaultChecked label="checkbox" />
</template>

<script lang="ts" setup>
import { TiCheckbox } from 'titian-h5-vue';
</script>

图标尺寸

codesanbox

copy

code

<template>
  <TiCheckbox label="checkbox" />
  <TiCheckbox :size="46" label="checkbox" />
  <TiCheckbox :size="60" label="checkbox" />
</template>

<script lang="ts" setup>
import { TiCheckbox } from 'titian-h5-vue';
</script>

事件监听

未选中

codesanbox

copy

code

<template>
  <TiCheckbox @change="toggle">{{ selected ? '选中' : '未选中' }}</TiCheckbox>
</template>

<script lang="ts" setup>
import { ref } from 'vue';
import { TiCheckbox } from 'titian-h5-vue';

const selected = ref(false);
const toggle = () => {
  selected.value = !selected.value;
};
</script>

默认选中状态

当设置 checked 时为受控模式，多选框的选中状态将由使用者控制，当设置 defaultChecked时为非受控模式，选中状态将由组件内部控制。默认为非受控模式。

codesanbox

copy

code

<template>
  <TiCheckbox label="checkbox" />
  <TiCheckbox checked label="checkbox" />
  <TiCheckbox defaultChecked label="checkbox" />
</template>

<script lang="ts" setup>
import { TiCheckbox } from 'titian-h5-vue';
</script>

图标类型

多选框支持自定义组件图标, 图标大小，图标颜色等。

codesanbox

copy

code

<template>
  <TiCheckbox label="checkbox" defaultChecked />
  <TiCheckbox icon="right-custom" label="checkbox" defaultChecked />
</template>

<script lang="ts" setup>
import { TiCheckbox } from 'titian-h5-vue';
</script>

修改多选框的圆角度数

多选框可自定义边框角度，支持方形（square）、圆形（circle）和自定义角度，默认为圆形。当自定义角度时，会自动根据屏幕分辨率调整数字大小！

codesanbox

copy

code

<template>
  <TiCheckbox defaultChecked label="checkbox" />
  <TiCheckbox shape="square" label="checkbox" />
  <TiCheckbox :shape="8" label="checkbox" />
</template>

<script lang="ts" setup>
import { TiCheckbox } from 'titian-h5-vue';
</script>

TiCheckboxButton 示例

单独使用

checkbox

组件附带文字内容

codesanbox

copy

code

<template>
  <TiCheckboxButton label="checkbox" />
  <TiCheckboxButton>checkbox</TiCheckboxButton>
</template>

<script lang="ts" setup>
import { TiCheckboxButton } from 'titian-h5-vue';
</script>

组件内容设置

多选按钮支持自定义前后内容，图标等。

codesanbox

copy

code

<template>
  <TiCheckboxButton label="设置右侧图标" icon="sort-inactive" />

  <TiCheckboxButton label="自定义左侧内容">
    <TiImage
      slot="prefix"
      width="40"
      radius="8"
      height="40"
      extStyle="margin-right: 4px"
      src="https://image-c-dev.weimobwmc.com/qa-On6X/8b97cd488593474ba4a8ccaa3c1a493f.png"
    />
  </TiCheckboxButton>

  <TiCheckboxButton label="自定义右侧内容">
    <TiImage
      slot="suffix"
      width="40"
      radius="8"
      height="40"
      extStyle="margin-right: 4px"
      src="https://image-c-dev.weimobwmc.com/qa-On6X/8b97cd488593474ba4a8ccaa3c1a493f.png"
    />
  </TiCheckboxButton>
</template>

<script lang="ts" setup>
import { TiCheckboxButton, TiImage } from 'titian-h5-vue';
</script>

事件监听

未选中

codesanbox

copy

code

<template>
  <TiCheckboxButton @change="toggle">{selected ? '选中' : '未选中'}</TiCheckboxButton>
</template>

<script lang="ts" setup>
import { ref } from 'vue';
import { TiCheckboxButton } from 'titian-h5-vue';

const selected = ref(false);
const toggle = () => {
  selected.value = !selected.value;
};
</script>

默认选中状态

当设置 checked 时为受控模式，多选按钮的选中状态将由使用者控制，当设置 defaultChecked 时为非受控模式，选中状态将由组件内部控制。默认为非受控模

codesanbox

copy

code

<template>
  <TiCheckboxButton label="默认选中" checked />
  <TiCheckboxButton label="默认选中" defaultChecked />
</template>

<script lang="ts" setup>
import { TiCheckboxButton } from 'titian-h5-vue';
</script>

改变多选按钮颜色

多选按钮默认根据主题色变化

codesanbox

copy

code

<template>
  <TiCheckboxButton label="通过属性更改颜色" color="#2a6ae9" />

  <div :style="styles">
    <TiCheckboxButton label="通过 css 变量更改颜色" />
  </div>
</template>

<script lang="ts" setup>
import { TiCheckboxButton } from 'titian-h5-vue';
const styles: Record<string, string> = {
  '--checkbox-button-checked-border-color': 'rgba(30, 128, 255, 40%)',
  '--checkbox-button-checked-bg-color': 'rgba(30, 128, 255, 10%)',
  '--checkbox-button-checked-text-color': 'rgba(30, 128, 255, 100%)',
};
</script>

TiCheckboxGroup 示例

基本使用

codesanbox

copy

code

<template>
  <div class="code-container">
    <TiCheckboxGroup>
      <TiCheckbox label="checkbox" value="1" />
      <TiCheckbox label="checkbox" value="2" />
      <TiCheckbox label="checkbox" value="3" />
    </TiCheckboxGroup>

    <TiCheckboxGroup>
      <TiCheckboxButton label="checkbox" value="1" />
      <TiCheckboxButton label="checkbox" value="2" />
      <TiCheckboxButton label="checkbox" value="3" />
    </TiCheckboxGroup>
  </div>
</template>

<script lang="ts" setup>
import { TiCheckbox, TiCheckboxGroup, TiCheckboxButton } from 'titian-h5-vue';
</script>

设置选中值

codesanbox

copy

code

<template>
  <div class="code-container">
    <TiCheckboxGroup :value="['1', '2']">
      <TiCheckbox label="受控模式-1" value="1" />
      <TiCheckbox label="受控模式-2" value="2" />
      <TiCheckbox label="受控模式-3" value="3" />
    </TiCheckboxGroup>

    <TiCheckboxGroup :defaultValue="['1', '2']">
      <TiCheckbox label="非受控模式-1" value="1" />
      <TiCheckbox label="非受控模式-2" value="2" />
      <TiCheckbox label="非受控模式-3" value="3" />
    </TiCheckboxGroup>

    <TiCheckboxGroup :value="['1', '2']">
      <TiCheckboxButton label="受控模式-1" value="1" />
      <TiCheckboxButton label="受控模式-2" value="2" />
      <TiCheckboxButton label="受控模式-3" value="3" />
    </TiCheckboxGroup>

    <TiCheckboxGroup :defaultValue="['1', '2']">
      <TiCheckboxButton label="非受控模式-1" value="1" />
      <TiCheckboxButton label="非受控模式-2" value="2" />
      <TiCheckboxButton label="非受控模式-3" value="3" />
    </TiCheckboxGroup>
  </div>
</template>

<script lang="ts" setup>
import { TiCheckbox, TiCheckboxGroup, TiCheckboxButton } from 'titian-h5-vue';
</script>

事件监听

codesanbox

copy

code

<template>
  <div class="code-container">
    <TiCheckboxGroup @change="handleChange">
      <TiCheckbox label="checkbox" value="1" />
      <TiCheckbox label="checkbox" value="2" />
      <TiCheckbox label="checkbox" value="3" />
    </TiCheckboxGroup>

    <TiCheckboxGroup @change="handleChange">
      <TiCheckboxButton label="checkbox" value="1" />
      <TiCheckboxButton label="checkbox" value="2" />
      <TiCheckboxButton label="checkbox" value="3" />
    </TiCheckboxGroup>
  </div>
</template>

<script lang="ts" setup>
import { TiCheckbox, TiCheckboxGroup, TiCheckboxButton } from 'titian-h5-vue';

const handleChange = (e: CustomEvent<Array<string | number>>) => {
  alert(`组件选中: ${e.detail.join(', ')}`);
};
</script>

禁用

当设置 disabled 时， 子组件将禁用组件的图标和文字的点击切换效果，当设置 labelDisabled 时将禁用子组件文字的点击效果，实现更细粒的控制。

codesanbox

copy

code

<template>
  <div class="code-container">
    <TiCheckboxGroup disabled :defaultValue="['1', '2']">
      <TiCheckbox label="checkbox" value="1" />
      <TiCheckbox label="checkbox" value="2" />
      <TiCheckbox label="checkbox" value="3" />
    </TiCheckboxGroup>

    <TiCheckboxGroup disabled :defaultValue="['1', '2']">
      <TiCheckboxButton label="checkbox" value="1" />
      <TiCheckboxButton label="checkbox" value="2" />
      <TiCheckboxButton label="checkbox" value="3" />
    </TiCheckboxGroup>
  </div>
</template>

<script lang="ts" setup>
import { TiCheckbox, TiCheckboxGroup, TiCheckboxButton } from 'titian-h5-vue';
</script>

使用 options 创建多选框

codesanbox

copy

code

<template>
  <div class="code-container">
    <TiCheckboxGroup :options="options" />
  </div>
</template>

<script lang="ts" setup>
import { TiCheckboxGroup } from 'titian-h5-vue';

const options = [
  { value: 'a', label: '选项 A' },
  { value: 'b', label: '选项 B' },
  { value: 'c', label: '选项 C' },
];
</script>

设置最大选中数量

codesanbox

copy

code

<template>
  <div class="code-container">
    <TiCheckboxGroup @handleMax="handleMax" :max="2">
      <TiCheckbox label="checkbox" value="1" />
      <TiCheckbox label="checkbox" value="2" />
      <TiCheckbox label="checkbox" value="3" />
    </TiCheckboxGroup>

    <TiCheckboxGroup @handleMax="handleMax" :max="2">
      <TiCheckboxButton label="checkbox" value="1" />
      <TiCheckboxButton label="checkbox" value="2" />
      <TiCheckboxButton label="checkbox" value="3" />
    </TiCheckboxGroup>
  </div>
</template>

<script lang="ts" setup>
import { TiCheckbox, TiCheckboxGroup, TiCheckboxButton } from 'titian-h5-vue';

const handleMax = () => {
  alert('超出最大数量');
};
</script>

TiCheckbox API

属性 Properties

名称	类型	必填	默认值	说明	备注
label	string	否	-	文字内容	-
value	string	否	-	标识 checkbox 名称	-
checked	boolean	否	false	指定当前是否选中, 此模式下为控制型组件	-
default-checked	boolean	否	false	初始是否选中, 此模式下为非控制型组件	-
disabled	boolean	否	false	是否禁用	-
label-disabled	boolean	否	false	文字区域是否禁用	-
shape	square | circle | number	否	circle	多选框形状	-
icon	string	否	-	自定义图标名称	-
size	number	否	-	自定义图标尺寸	-
color	string	否	-	自定义图标颜色	-
ext-style	string | Record<string, string>	否	-	根节点额外扩展样式	属性值如果是带单位的话，要带上单位，如：{margin: '10px'}

事件 Events

名称	参数列表	描述	备注
change	(e: CustomEvent<boolean>) => void	多选框选中时触发的事件	当被 TiCheckboxGroup 包裹时，只有 TiCheckboxGroup 的 change 会被触发

插槽 Slots

名称	说明	备注
icon	图标插槽	当 :icon="false"，使用此插槽

可扩展样式名 External Class

名称	说明	备注
ext-class	根节点可扩展的类名	-
icon-class	icon 可扩展的类名	-

CSS 变量 CSS Variables

变量	默认值	说明	备注
--checkbox-radius	theme.borderRadius.round	圆角	-
--checkbox-gap	theme.spacing.gap.g3	文字与图标间距	-
--checkbox-padding-v	theme.spacing.vertical.v0	上下Padding	-
--checkbox-padding-h	theme.spacing.horizontal.h0	左右Padding	-
--checkbox-label-color	theme.color.gray.texticon.900	Label文字，颜色	-
--checkbox-direction	row	-	-
--checkbox-icon-color	theme.color.brand.1000	背景颜色	-
--checkbox-icon-revert-color	theme.color.gray.texticon.invert	-	-
--checkbox-icon-wrap-padding-v	0	-	-
--checkbox-icon-wrap-padding-h	0	-	-
--checkbox-label-font-size	theme.fontSize.t6	Label文字，字号	-
--checkbox-label-font-weight	theme.fontWeight.regular	Label文字，字重	-
--checkbox-label-line-height	theme.lineHeight.single.t6	Label文字，行高	-
--checkbox-icon-border-color	theme.color.gray.border.100	图标 border 颜色	-

TiCheckboxButton API

属性 Properties

名称	类型	必填	默认值	说明	备注
label	string	否	-	文字内容	-
value	string	否	-	标识 Checkbox 名称	-
checked	boolean	否	false	指定当前是否选中, 此模式下为控制型组件	-
default-checked	boolean	否	false	初始是否选中, 此模式下为非控制型组件	-
disabled	boolean	否	false	是否禁用	-
icon	string	否	-	自定义右侧图标名称	-
left-icon	string	否	-	自定义左侧图标名称	-
color	string	否	-	自定义图标颜色	-
ext-style	string | Record<string, string>	否	-	根节点额外扩展样式	属性值如果是带单位的话，要带上单位，如：{margin: '10px'}

事件 Events

名称	参数列表	描述	备注
change	(e: CustomEvent<boolean>) => void	多选框选中时发生的回调	当被 TiCheckboxGroup 包裹时，只有 TiCheckboxGroup 的 change 会被触发

插槽 Slots

名称	说明	备注
prefix	自定义文字前面内容	-
suffix	自定义文字后面内容	-

可扩展样式名 External Class

名称	说明	备注
ext-class	根节点可扩展的类名	-

CSS 变量 CSS Variables

变量	默认值	说明	备注
--checkbox-button-height	56px	-	-
--checkbox-button-padding-v	0	-	-
--checkbox-button-padding-h	0	-	-
--checkbox-button-text-color	theme.color.gray.texticon.550	-	-
--checkbox-button-disabled-text-color	theme.color.gray.texticon.250	-	-
--checkbox-button-disabled-border-color	theme.color.brand.300	-	-
--checkbox-button-bg-color	theme.color.gray.background.20	-	-
--checkbox-button-padding	theme.spacing.horizontal.h3 theme.spacing.vertical.v5	-	-
--checkbox-button-radius	theme.borderRadius.r2	-	-
--checkbox-button-checked-bg-color	theme.color.brand.100	-	-
--checkbox-button-checked-border-color	theme.color.brand.300	-	-
--checkbox-button-checked-text-color	theme.color.brand.1000	-	-
--checkbox-button-font-size	theme.fontSize.t5	-	-
--checkbox-button-font-weight	theme.fontWeight.regular	-	-
--checkbox-button-line-height	theme.lineHeight.multiline.t2	-	-

TiCheckboxGroup API

属性 Properties

名称	类型	是否必填	默认值	说明	备注
value	Array<string | number >	否	-	用于设置当前选中的值	-
default-value	Array<string | number >	否	-	默认选中的值	-
disabled	boolean	否	false	指定当前是否禁用	-
direction	horizontal | vertical	否	horizontal	排列方向	-
shape	circle | square	否	circle	图标形状，可选值为 circle、square	-
label-disabled	boolean	否	false	是否禁用文本点击效果	-
icon	string	否	-	自定义图标名称	-
options	Array<Option>	否	-	以配置形式设置子元素	-
size	number	否	-	自定义图标尺寸	-
color	string	否	-	自定义图标颜色	-
max	number	否	Number.MAX_SAFE_INTEGER	最大选中数量	-
ext-style	string | Record<string, string>	否	-	根节点额外扩展样式	属性值如果是带单位的话，要带上单位，如：{margin: '10px'}

Options

interface Option {
  label: string;
  value: string;
  disabled?: boolean;
}

事件 Events

名称	参数列表	描述	备注
change	(e: CustomEvent<Array<string | number>>) => void	多选框选中时发生的回调	-
handle-max	<code>(e: CustomEvent<never>) => void`	达到最大值时发生的回调	-

可扩展样式名 External Class

类名	说明	备注
ext-class	扩展样式类名	-