Cascader 级联选择器

使用

import { KCascader } from "@ksware/ksw-ux";

当一个数据集合有清晰的层级结构时，可通过级联选择器逐级查看并选择。

基础用法

有两种触发子菜单的方式

只需为 Cascader 的options属性指定选项数组即可渲染出一个级联选择器。 通过 props.expandTrigger 属性控制子节点的展开方式

有禁用选项

通过在数据源中设置 disabled 字段来声明该选项是禁用的

本例中，options 指定的数组中的第一个元素含有disabled: true键值对，因此是禁用的。 在默认情况下，Cascader 会检查数据中每一项的disabled字段是否为true，如果你的数据中表示禁用含义的字段名不为disabled，可以通过props.disabled属性来指定（详见下方 API 表格）。 当然，value、label和children这三个字段名也可以通过同样的方式指定。

可清空

通过 clearable 设置输入框可清空

仅显示最后一级

可以仅在输入框中显示选中项最后一级的标签，而不是选中项所在的完整路径。

属性show-all-levels定义了是否显示完整的路径， 将其赋值为 false 则仅显示最后一级。

多选

在标签中添加 :props="props" 并设置 props = { multiple: true } 来开启多选模式。

正确用法

<template>
  <k-cascader :props="props" />
</template>
<script lang="ts" setup>
  const props = { multiple: true }
</script>

错误用法

<template>
  <!--  Object literal binging here is invalid syntax for cascader  -->
  <k-cascader :props="{ multiple: true }" />
</template>

使用多选时，所有选中的标签将默认显示。 您可以设置 collapse = true 将选中的标签折叠。 您可以设置 max-collapse-tags 来显示最大tag数量，默认1。 您可以使用 collapse-tags-tooltip 属性来启用鼠标悬停折叠文字以显示具体所选值的行为。

选择任意一级选项

在单选模式下，你只能选择叶子节点；而在多选模式下，勾选父节点真正选中的都是叶子节点。 启用该功能后，可让父子节点取消关联，选择任意一级选项。

可通过 props.checkStrictly = true 来设置父子节点取消选中关联，从而达到选择任意一级选项的目的。

动态加载

当选中某一级时，动态加载该级下的选项。

通过lazy开启动态加载，并通过lazyload来设置加载数据源的方法。 lazyload方法有两个参数，第一个参数node为当前点击的节点，第二个resolve为数据加载完成的回调(必须调用)。 为了更准确的显示节点的状态，还可以对节点数据添加是否为叶子节点的标志位 (默认字段为leaf，可通过props.leaf修改)。 否则，将以有无子节点来判断其是否为叶子节点。

可搜索

可以快捷地搜索选项并选择。

通过添加filterable来启用过滤。 Cascader 会匹配所有节点的标签和它们的亲节点的标签，是否包含有输入的关键字。 你也可以用filter-method自定义搜索逻辑，接受一个函数，第一个参数是节点node，第二个参数是搜索关键词keyword，通过返回布尔值表示是否命中。

自定义节点内容

可以自定义备选项的节点内容

你可以通过 scoped slot 自定义节点的内容。 您可以访问 scope 中的 node 和 data 属性，分别表示当前节点的 Node 对象和当前节点的数据。

级联面板

级联面板是级联选择器的核心组件，与级联选择器一样，有单选、多选、动态加载等多种功能。

和级联选择器一样，通过 options 来指定选项，也可通过 props 来设置多选、动态加载等功能，具体详情见下方API表格。

API

Props

参数名	描述	类型	默认值
model-value / v-model	选中项绑定值	string | number | string[] | number[]	-
options	选项的数据源	object	any[]
props	选项的数据源，可以通过CascaderProps自定义, 具体参考CascaderProps	object	''
size	输入框尺寸	enum	base
placeholder	输入框占位文本	string	-
disabled	是否禁用	boolean	false
clearable	是否显示清除按钮	boolean	false
show-all-levels	输入框中是否显示选中值的完整路径	boolean	true
collapse-tags	多选模式下是否折叠Tag	boolean	-
collapse-tags-tooltip	当鼠标悬停于折叠标签的文本时，是否显示所有选中的标签。 要使用此属性，collapse-tags属性必须设定为true	boolean	false
separator	选项分隔符	string	'/'
filterable	该选项是否可搜索	boolean	-
filter-method	自定义搜索逻辑，第一个参数是node，第二个参数是keyword，返回的布尔值表示是否保留该选项	Function	-
debounce	输入框的防抖时间，单位为毫秒	number	300
before-filter	过滤函数调用前，所要调用的钩子函数，该函数接收要过滤的值作为参数。如果该函数的返回值是false或者是一个被拒绝的Promise，那么接下来的过滤逻辑便不会执行。	Function	-
popper-class	自定义弹出框的类名	string	''
teleported	是否将弹出框渲染至body下	boolean	true
tag-type	多选模式下Tag的类型	enum	info
max-collapse-tags	多选模式下Tag的最大显示数，collapse-tags为true时生效，超过此数值将折叠	number	1
placement	下拉框出现的位置	enum	bottom-start

Events

事件名	描述	类型
change	绑定值变化时触发	Function
expand-change	当展开节点发生变化时触发	Function
blur	失去焦点时触发	Function
focus	获得焦点时触发	Function
clear	单选模式下，点击清除按钮时触发	Function
visible-change	下拉框出现/隐藏时触发	Function
remove-tag	在多选模式下，移除Tag时触发	Function

Methods

方法名	描述	类型
getCheckedNodes	获取一个当前选中节点的数组。是否只返回叶选中的节点，默认是 false	Function
cascaderPanelRef	cascader面板的ref	object
togglePopperVisible	切换下拉框的显示/隐藏状态	Function
contentRef	cascader内容的ref	object
presentText	选中的内容文本	object

Slots

插槽名	描述	参数
default	自定义备选项的节点内容，分别为当前节点的Node对象和数据	-
empty	无匹配到选项时显示的内容	-