TreeSelect 分类选择

介绍

用于从一组相关联的数据集合中进行选择。

代码演示

单选模式

item 为分类显示所需的数据,数据格式见下方示例。main-active-index 表示左侧高亮选项的索引,active-id 表示右侧高亮选项的 id。

<z-tree-select
  v-model:active-id="activeId"
  v-model:main-active-index="activeIndex"
  :items="items"
/>
import { ref } from 'vue';

export default {
  setup() {
    const activeId = ref(1);
    const activeIndex = ref(0);
    const items = [
      {
        text: '浙江',
        children: [
          { text: '杭州', id: 1 },
          { text: '温州', id: 2 },
          { text: '宁波', id: 3, disabled: true },
        ],
      },
      {
        text: '江苏',
        children: [
          { text: '南京', id: 4 },
          { text: '无锡', id: 5 },
          { text: '徐州', id: 6 },
        ],
      },
      { text: '福建', disabled: true },
    ];

    return {
      items,
      activeId,
      activeIndex,
    };
  },
};

多选模式

active-id 为数组格式时,可以选中多个右侧选项。

<z-tree-select
  v-model:active-id="activeIds"
  v-model:main-active-index="activeIndex"
  :items="items"
/>
import { ref } from 'vue';

export default {
  setup() {
    const activeIds = ref([1, 2]);
    const activeIndex = ref(0);
    const items = [
      {
        text: '浙江',
        children: [
          { text: '杭州', id: 1 },
          { text: '温州', id: 2 },
          { text: '宁波', id: 3, disabled: true },
        ],
      },
      {
        text: '江苏',
        children: [
          { text: '南京', id: 4 },
          { text: '无锡', id: 5 },
          { text: '徐州', id: 6 },
        ],
      },
      { text: '福建', disabled: true },
    ];

    return {
      items,
      activeIds,
      activeIndex,
    };
  },
};

自定义内容

通过 content 插槽可以自定义右侧区域的内容。

<z-tree-select
  v-model:main-active-index="activeIndex"
  height="300rpx"
  :items="items"
>
    <template #content>
      <view v-if="activeIndex3 === 0" class="custom-content1">
        当前选中的下标{{ activeIndex3 }}
      </view>
      <view v-if="activeIndex3 === 1" class="custom-content2">
        当前选中的下标{{ activeIndex3 }}
      </view>
    </template>
</z-tree-select>
import { ref } from 'vue';

export default {
  setup() {
    const activeIndex = ref(0);
    return {
      activeIndex,
      items: [{ text: '分组 1' }, { text: '分组 2' }],
    };
  },
};

徽标提示

设置 dot 属性后,会在图标右上角展示一个小红点;设置 badge 属性后,会在图标右上角展示相应的徽标。

<z-tree-select
  v-model:main-active-index="activeIndex"
  :items="items"
/>
import { ref } from 'vue';

export default {
  setup() {
    const activeIndex = ref(0);
    return {
      activeIndex,
      items: [
        {
          text: '浙江',
          children: [
            { text: '杭州', id: 1 },
            { text: '温州', id: 2 },
            { text: '宁波', id: 3, disabled: true },
          ],
          dot: true,
        },
        {
          text: '江苏',
          children: [
            { text: '南京', id: 4 },
            { text: '无锡', id: 5 },
            { text: '徐州', id: 6 },
          ],
          badge: 5,
        },
      ],
    };
  },
};

API

Props

参数说明类型默认值
v-model:main-active-index左侧选中项的索引number | string0
v-model:active-id右侧选中项的 id,支持传入数组number | string |
(number | string)
0
items分类显示所需的数据TreeSelectItem[]
height高度,默认单位为pxnumber | string300
max右侧项最大选中个数number | stringInfinity
selected-icon自定义右侧栏选中状态的图标stringcheck

Events

事件名说明回调参数
click-nav点击左侧导航时触发index: number
click-item点击右侧选择项时触发item: TreeSelectChild

Slots

名称说明参数
nav-text自定义导航名称item: TreeSelectChild
content自定义右侧区域内容-

TreeSelectItem 数据结构

TreeSelectItem 整体为一个数组,数组内包含一系列描述分类的对象,每个分类里,text 表示当前分类的名称,children 表示分类里的可选项。

[
  {
    // 导航名称
    text: '所有城市',
    // 导航名称右上角徽标
    badge: 3,
    // 是否在导航名称右上角显示小红点
    dot: true,
    // 该导航下所有的可选项
    children: [
      {
        // 名称
        text: '温州',
        // id,作为匹配选中状态的标识符
        id: 1,
        // 禁用选项
        disabled: true,
      },
      {
        text: '杭州',
        id: 2,
      },
    ],
  },
];

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--z-tree-select-font-sizevar(--z-font-size-md)-
--z-tree-select-nav-backgroundvar(--z-background)-
--z-tree-select-content-backgroundvar(--z-background-2)-
--z-tree-select-nav-item-padding28rpx var(--z-padding-sm)-
--z-tree-select-item-height96rpx-
--z-tree-select-item-active-colorvar(--z-primary-color)-
--z-tree-select-item-disabled-colorvar(--z-gray-5)-
--z-tree-select-item-selected-size32rpx-