选择与表单

级联选择器 AsamCascader

从静态层级 options 选择节点。

使用场景 ​

从静态层级 options 选择节点。规范化节点保留 raw 和 children,以逐级菜单展示路径。ASAM 值模式返回节点值而非整条路径;需要原始模型时显式 native。

层级选择与自定义节点 ​

value/object 模式的 default 插槽收到 data、node 和对应规范化 option;native 模式原样传递原生 data、node。filterable 提供本地筛选。高级模式清空单选回到 null,native 模式保留原生清空值。

层级选择与自定义节点

展开源码

多选与对象值 ​

multiple + valueMode=object 返回规范化节点数组。字符串存储只用于 value 模式,separator 不得与节点值冲突;所有节点值保持唯一。

多选与对象值

展开源码

原始节点字段与实例 ​

native 使用原始 options;props.emitPath=true 保存路径数组。getCheckedNodes 可读取已选节点;CascaderPanel 是独立常驻面板。

原始节点字段与实例

展开源码

四档尺寸与上下文继承 ​

四个实例分别显式使用 large、big、default、small。下面省略 size 的实例随 ConfigProvider 响应切换;显式 size 覆盖祖先。面板本身没有 size 契约的入口不附加虚构尺寸属性。

四档尺寸与上下文继承

展开源码

ASAM 扩展与迁移 ​

ASAM 扩展包括四档密度及 value/object、array/string 模型策略。 完整说明。

模型与 change 载荷由值模式和单多选策略共同决定。 完整说明。

迁移旧挂载属性:popper-append-to-body 已淘汰,当前组件没有此属性。 完整说明。

native 模式的 TS 父模型使用 ref<AsamCascaderNativeProps['modelValue']>,保留原生标量、路径、多选和空值声明;初始 [] 不应推断成 never[] 或仅路径数组。辅助 Checkbox 的模型使用其公开事件参数类型,Switch 输出传给布尔属性前作明确转换。

受控回写边界 ​

打开面板后,点击节点会产生候选值并发出 update:modelValue 和 change。 完整说明。

父级随后传入实际变化的 modelValue 时由原生组件重新同步显示和节点。 完整说明。

SSR 使用限制 ​

高级 lazy 的未知标量预填也受原生同步能力限制:叶节点在加载前尚不可解析时,加载后原生实例可能仍无标签和已选节点。ASAM 保留宿主值与未解析值装饰,不短暂重绑定 modelValue 来修补上游;需要显示已选叶节点时,应提供可解析的初始 options,或在节点加载后由宿主传入实际变化的模型。

注意:固定版本连续 SSR 渲染常驻级联弹层时,可能出现 DOM ID 水合不一致。 完整说明。

API 阅读方式 ​

下方 Props、Events、Slots、Exposes 按当前实际公开类型与运行默认值生成。组合属性按分支生效,不能任意混搭值模式。标为“未知 / 未声明”的默认值不代表 false 或空值。源码区域提供对应语言的独立 Demo.vue,可直接复制或下载;本地辅助组件、数据和素材已内联到当前文件。

原生协议完整用法与 API ​

以下用法对应固定 2.14.7。Cascader 与 TreeSelect 的示例显式使用 value-mode="native";其原生值、路径、字段映射和回调不能直接套到标准化模式。API 表保留原生默认值,ASAM 覆盖值与四档尺寸以下列约定为准。

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

基础用法 ​

有两种触发子菜单的方式

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

基础用法

展开源码

有禁用选项 ​

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

本例中,options指定的数组中的第一个元素含有disabled: true键值对,因此是禁用的。 完整说明。

有禁用选项

展开源码

可清空 ​

为 AsamCascader 设置 clearable 后,已选择内容且鼠标悬停时会显示清除图标。

可清空

展开源码

自定义清除图标 ​

你可以通过clear-icon属性自定义清除图标

自定义清除图标

展开源码

仅显示最后一级 ​

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

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

仅显示最后一级

展开源码

多选 ​

使用 value-mode="native" 配合 props.multiple=true 开启原生多选模式。将配置保存为具名对象,便于复用:

vue
<template>
	<AsamCascader value-mode="native" :props="props" />
</template>

<script lang="ts" setup>
import { AsamCascader } from '@asam-ui/ui';
const props = { multiple: true };
</script>

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

多选

展开源码

选择任意一级选项 ​

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

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

选择任意一级选项

展开源码

动态加载 ​

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

通过lazy开启动态加载,并通过lazyload来设置加载数据源的方法。 完整说明。

动态加载

展开源码

可筛选 ​

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

为 AsamCascader 设置 filterable 可开启筛选。在原生模式下,会按 show-all-levels 匹配节点或父节点标签中包含输入关键字的项。可通过 filter-method 自定义搜索:接收 node 与 keyword,返回布尔值表示节点是否匹配。

可筛选

展开源码

自定义节点内容 ​

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

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

自定义节点内容

展开源码

自定义建议项 ​

你可以通过 suggestion-item 插槽自定义建议项。你可以在作用域中访问 item,它代表建议项。

自定义建议项

展开源码

级联面板 ​

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

与原生模式的 AsamCascader 一样,AsamCascaderPanel 接收 options,并通过 props 配置节点行为;详细说明见其 API 文档。

独立面板示例见 AsamCascaderPanel。

自定义级联标签 ​

您可以自定义标签。

通过 AsamCascader 的 tag 插槽自定义标签。使用此自定义渲染时,collapse-tags、collapse-tags-tooltip 和 max-collapse-tags 不再生效。

自定义级联标签

展开源码

选中项显示策略 ​

控制在多选模式下已选值的显示方式。

在多选模式下,你可以使用 show-checked-strategy 来控制已选值的显示方式。默认策略为 child,即显示所有已选中的子节点。 parent 策略仅在其所有子节点都被选中时显示父节点。

选中项显示策略

展开源码

示例前两个多选实例显式设置 persistent=false,并提供 native 路径预选值。 完整说明。

后面的受控回写实例固定 persistent=true,提供 native/value/object 模式和接受、忽略、非幂等转换三种宿主处理。 完整说明。

点击节点选择 ​

此功能适用于启用 multiple 或 checkStrictly 的情况。

设置 checkOnClickNode 后,除前缀图标外,点击节点本身也能切换选中状态。 使用 showPrefix 控制前缀的显示。 使用提示 checkOnClickLeaf 控制是否仅在点击叶子节点时触发选择,默认启用。

点击节点选择

展开源码

自定义头部与底部 ​

你可以通过插槽来自定义下拉菜单的头部和底部。

使用插槽自定义内容。

虚拟滚动 ​

当处理大量数据时,您可以启用虚拟滚动以提高性能。

将 virtual-scroll 设置为 true 以启用虚拟滚动。 您还可以使用 height 自定义菜单高度,并使用 item-size 自定义节点高度。 默认高度为 204px,默认节点大小为 34px。

虚拟滚动

展开源码

自定义建议列表宽度 ​

建议面板(筛选时)的宽度默认会根据匹配到的选项中的最大宽度自动计算。 完整说明。

使用提示

fit-input-width 属性仅控制搜索时建议面板的宽度,不影响默认的级联面板。

自定义建议列表宽度

展开源码

Cascader API ​

属性 ​

名称 说明 类型 默认值
model-value / v-model 选中项绑定值 string / number /arraystring[] | number[] | any —
options 选项的数据源, value 和 label 可以通过 CascaderProps 自定义. arrayAsamCascaderOption[] —
props 配置选项, 请参阅下面 CascaderProps 表。 objectCascaderProps —
size 输入框尺寸 enum'large' | 'default' | 'small' —
placeholder 输入框占位文本 string —
disabled 指定选项的禁用为选项对象的某个属性值 boolean —
clearable 是否支持清空选项 boolean —
clear-icon 自定义清除图标 string / objectComponent CircleClose
show-all-levels 输入框中是否显示选中值的完整路径 boolean true
collapse-tags 多选模式下是否折叠Tag boolean —
collapse-tags-tooltip 当鼠标悬停于折叠标签的文本时,是否显示所有选中的标签。要使用此属性,collapse-tags属性必须设定为 true boolean false
max-collapse-tags-tooltip-height collapse tags 的最大高度 string / number —
separator 用于分隔选项的字符 string ' / '
filterable 该选项是否可以被搜索 boolean —
filter-method 自定义搜索逻辑,第一个参数是node,第二个参数是keyword,返回的布尔值表示是否保留该选项 Function(node: AsamCascaderNode, keyword: string) => boolean —
debounce 搜索关键词正在输入时的去抖延迟,单位为毫秒 number 300
before-filter 过滤函数调用前,所要调用的钩子函数,该函数接收要过滤的值作为参数。如果该函数的返回值是 false 或者是一个被拒绝的 Promise,那么接下来的过滤逻辑便不会执行。 Function(value: string) => boolean —
popper-class Cascader 下拉菜单和标签提示的自定义类名 string ''
popper-style Cascader 下拉菜单和标签提示的自定义样式 string / object —
teleported 弹层是否使用 teleport boolean true
effect Tooltip 主题,内置了 dark / light 两种 enum'dark' | 'light' / string light
tag-type 标签类型 enum'success' | 'info' | 'warning' | 'danger' info
tag-effect tag effect enum'light' | 'dark' | 'plain' light
validate-event 是否触发表单验证 boolean true
max-collapse-tags 需要显示的 Tag 的最大数量要使用此功能,collapse-tags的值必须为true number 1
empty-values 组件的空值集合, 参见配置容器 array —
value-on-clear 清空操作的返回值, 参见配置容器 string / number / boolean / Function —
persistent 当下拉框未被激活并且persistent设置为false,下拉框容器会被删除。 boolean true
fallback-placements 文字提示可用的位置列表 popper.js arrayPlacement[] —
placement 下拉框出现的位置 enum'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end' | 'right' | 'right-start' | 'right-end' bottom-start
show-checked-strategy 多选模式下已选节点的展示策略。当你想让显示更简洁时,使用 parent。当你想显示每个子项时,使用 child。 enum'parent' | 'child' child
virtual-scroll 是否为大数据启用虚拟滚动 boolean false
fit-input-width 建议面板的宽度是否与输入框一致;如果值为 number,则宽度为固定值。 boolean / number false
item-size 虚拟滚动的节点高度 (px) number 34
height 虚拟滚动的菜单高度 (px) number 204

事件 ​

名称 说明 类型
change 当绑定值变化时触发的事件 Function(value: AsamCascaderNativeProps['modelValue']) => void
expand-change 当展开节点发生变化时触发 Function(value: AsamCascaderNativeProps['modelValue']) => void
blur 当失去焦点时触发 Function(event: FocusEvent) => void
focus 当获得焦点时触发 Function(event: FocusEvent) => void
clear 可清空的单选模式下用户点击清空按钮时触发 Function() => void
visible-change 下拉框出现/隐藏时触发 Function(value: boolean) => void
remove-tag 在多选模式下,移除Tag时触发 Function(value: AsamCascaderNode['valueByOption']) => void

插槽 ​

名称 说明 类型
default 下级节点的自定义内容,它们分别是当前节点对象和节点数据。 object{ node: any, data: any }
empty 无匹配选项时的内容 —
prefix 输入框头部内容 —
suggestion-item 搜索时自定义建议项内容 object{ item: AsamCascaderNode }
tag 自定义tag样式 object{ data: AsamCascaderTag[], deleteTag: (tag: AsamCascaderTag) => void }
header 下拉列表顶部的内容 —
footer 下拉列表底部的内容 —

实例方法与状态 ​

名称 说明 类型
getCheckedNodes 获取一个当前选中节点的数组。(仅仅是传单) 是否只返回叶选中的节点,默认是 false Function(leafOnly: boolean) => AsamCascaderNode[] | undefined
cascaderPanelRef cascader 面板的 ref objectComputedRef<any>
togglePopperVisible 切换 popper 可见状态 Function(visible?: boolean) => void
contentRef cascader 内容的 ref objectComputedRef<any>
presentText 选中的内容文本 objectComputedRef<string>
focus 使 input 获取焦点 Function() => void
blur 使 input 失去焦点 Function() => void

级联配置类型(CascaderProps) ​

属性 说明 类型 默认值
expandTrigger 次级菜单的展开方式 enum'click' | 'hover' click
multiple 是否多选 boolean false
checkStrictly 是否严格的遵守父子节点不互相关联 boolean false
emitPath 在选中节点改变时,是否返回由该节点所在的各级菜单的值所组成的数组,若设置 false,则只返回该节点的值 boolean true
lazy 是否动态加载子节点,需与 lazyLoad 方法结合使用 boolean false
lazyLoad 加载子节点数据的方法,仅在 lazy 为 true 时生效;支持通过 reject 回调拒绝加载。 Function(node: Node, resolve: Resolve, reject: () => void) => void —
value 指定选项的值为选项对象的某个属性值 string value
label 指定节点标签为节点对象的某个属性值 string label
children 指定选项的子选项为选项对象的某个属性值 string children
disabled 指定选项的禁用为选项对象的某个属性值 string disabled
leaf 指定选项的叶子节点的标志位为选项对象的某个属性值 string leaf
hoverThreshold hover 时展开菜单的灵敏度阈值 number 500
checkOnClickNode 点击节点时是否选中或取消选中该节点 boolean false
checkOnClickLeaf 点击叶节点(最后一个子节点)时是否检查或取消节点 boolean true
showPrefix 是否显示单选框或复选框的前缀(图标) boolean true

ASAM 模式与默认值 ​

默认 valueMode="value",单选返回叶值或 TreeSelect 节点值,清空为 null;valueMode="object" 返回带 raw 的节点对象,多选清空为 []。 完整说明。

标准化多选默认数组;value 模式可显式 multipleValueMode="string" 与 separator。 完整说明。

控件尺寸使用 large/big/default/small 四档及 ConfigProvider 的继承值。 完整说明。

标准化懒加载 ​

load/lazyLoad 返回 { value, label, raw, children?, leaf?, isLeaf? },不是原生任意对象。 完整说明。

三模式动态模型、回填与源切换

展开源码

局部与全局挂载 ​

切换公开挂载参数后,再打开浮层观察内容位于当前组件附近或挂载到 body。 开关显示当前模式,两个模式均可操作;关闭后可以再次切换。

局部与全局挂载

展开源码

API

属性 AsamCascaderProps

属性名说明类型默认值
options规范化静态选项。懒加载回调返回相同选项结构;远程来源使用独立组件。readonly AsamHierarchyOption<V, I>[] | undefined | AsamCascaderOption[] | undefined() => []
separator用于分隔选项的字符string | undefinedundefined
disabled指定选项的禁用为选项对象的某个属性值boolean | undefinedundefined
placeholder输入框占位文本string | undefined'请选择'
filterable该选项是否可以被搜索boolean | undefinedfalse
clearable是否支持清空选项boolean | undefinedtrue
teleported弹层是否使用 teleportboolean | undefinedtrue
size输入框尺寸enum"large" | "big" | "default" | "small"完整类型:AsamControlSize | undefinedundefined
modelValue指定选项的值为选项对象的某个属性值
查看完整类型string | undefined | V | null | undefined | AsamHierarchyOption<V, I> | null | undefined | readonly V[] | undefined | readonly AsamHierarchyOption<V, I>[] | undefined | (AsamCascaderProps<V, I>)["modelValue"]
undefined
multiple—true | false | undefined | true | undefinedundefined
valueMode—enum"value" | "object" | "native"完整类型:"value" | undefined | "object" | "native"'value'
multipleValueMode—enum"string" | "array"完整类型:"string" | undefined | "array" | undefinedundefined
effectTooltip 主题,内置了 dark / light 两种enum"light" | "dark"完整类型:(AsamCascaderProps<V, I>)["effect"]"light"
popperClass级联下拉面板的自定义类名。(AsamCascaderProps<V, I>)["popperClass"]undefined
popperStyle级联下拉面板的自定义样式。(AsamCascaderProps<V, I>)["popperStyle"]undefined
fallbackPlacements下拉面板可采用的位置列表。(AsamCascaderProps<V, I>)["fallbackPlacements"]["bottom-start","bottom","top-start","top","right","left"]
placement下拉框出现的位置enum"auto" | "auto-start" | "auto-end" | "top" | "bottom" | "right" | "left" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end"完整类型:(AsamCascaderProps<V, I>)["placement"]"bottom-start"
persistent当下拉框未被激活并且persistent设置为false,下拉框容器会被删除。boolean | undefinedtrue
height虚拟滚动菜单高度。number | undefined204
itemSize虚拟滚动节点高度。number | undefined34
filterMethod自定义搜索逻辑,第一个参数是node,第二个参数是keyword,返回的布尔值表示是否保留该选项((node: AsamCascaderNode, keyword: string) => boolean) | undefined函数默认值(作为值传递)
checkOnClickNode点击节点时是否选中或取消选中该节点boolean | undefinedfalse
emptyValues组件支持的空值集合。unknown[] | undefined—
valueOnClear清空时返回的值;需要 undefined 时使用 () => undefined。(AsamCascaderProps<V, I>)["valueOnClear"]undefined
validateEvent是否触发表单验证boolean | undefinedtrue
virtualScroll是否为大数据启用虚拟滚动boolean | undefinedfalse
clearIcon自定义清除图标(AsamCascaderProps<V, I>)["clearIcon"]{"name":"CircleClose","__name":"circle-close"}
debounce搜索关键词正在输入时的去抖延迟,单位为毫秒number | undefined300
collapseTags多选模式下是否折叠Tagboolean | undefinedfalse
collapseTagsTooltip当鼠标悬停于折叠标签的文本时,是否显示所有选中的标签。要使用此功能,collapse-tags的值必须为trueboolean | undefinedfalse
maxCollapseTags需要显示的 Tag 的最大数量。只有当 collapse-tags 设置为 true 时才会生效。number | undefined1
fitInputWidth建议面板的宽度是否与输入框一致;如果值为 number,则宽度为固定值。number | boolean | undefinedfalse
tagType标签类型enum"primary" | "success" | "danger" | "warning" | "info"完整类型:"primary" | "success" | "danger" | "warning" | "info" | undefined"info"
tagEffect标签效果enum"light" | "dark" | "plain"完整类型:"light" | "dark" | "plain" | undefined"light"
showAllLevels输入框中是否显示选中值的完整路径boolean | undefinedtrue
maxCollapseTagsTooltipHeight折叠标签提示的最大像素高度,需要启用 collapse-tags-tooltip。string | number | undefined—
beforeFilter过滤函数调用前,所要调用的钩子函数,该函数接收要过滤的值作为参数。如果该函数的返回值是 false 或者是一个被拒绝的 Promise,那么接下来的过滤逻辑便不会执行。((value: string) => boolean | Promise<any>) | undefined函数默认值(作为值传递)
showCheckedStrategyparent 策略适合显示汇总父项;child 策略适合逐项展示所选子节点。enum"parent" | "child"完整类型:"parent" | "child" | undefined"child"
showPrefix是否显示单选框或复选框的前缀(图标)boolean | undefinedtrue
props配置选项, 请参阅下面 CascaderProps 表。
查看完整类型AsamCascaderSelectionProps<V, I> | undefined | Omit<AsamCascaderNativeConfig, "lazyLoad"> & { readonly lazyLoad?: AsamCascaderLazyLoad<V, I> | undefined; } & { readonly multiple: true; } | AsamCascaderNativeConfig | undefined
工厂函数(每个实例创建)

事件 AsamCascaderEmits

属性名说明类型默认值
update:modelValue—(AsamCascaderEmits)["update:modelValue"]—
change—(AsamCascaderEmits)["change"]—
clear—(AsamCascaderEmits)["clear"]—
focus—[event: FocusEvent]—
blur—[event: FocusEvent]—
visibleChange—[val: boolean]—
expandChange—(AsamCascaderEmits)["expandChange"]—
removeTag—(AsamCascaderEmits)["removeTag"]—

插槽 AsamCascaderSlots

属性名说明类型默认值
default—
查看完整类型((scope: { /** Present in normalized modes; native mode retains only the upstream slot fields. */ option?: AsamHierarchyOption; data: AsamCascaderOption; node: AsamCascaderNode; }) => unknown) | undefined
—
empty—(() => unknown) | undefined—
prefix—(() => unknown) | undefined—
header—(() => unknown) | undefined—
footer—(() => unknown) | undefined—
tag—((scope: { data: AsamCascaderTag[]; deleteTag: (tag: AsamCascaderTag) => void; }) => unknown) | undefined—
suggestion-item—((scope: { item: AsamCascaderNode; }) => unknown) | undefined—

实例方法与状态 AsamCascaderExpose

属性名说明类型默认值
focus—() => void—
getCheckedNodes获取一个当前选中节点的数组。(仅仅是传单) 是否只返回叶选中的节点,默认是 false(leafOnly: boolean) => AsamCascaderNode[] | undefined—
contentRefcascader 内容的 refHTMLElement | undefined—
blur—() => void—
cascaderPanelRefcascader 面板的 ref(AsamCascaderExpose)["cascaderPanelRef"]—
togglePopperVisible切换浮层可见状态。(visible?: boolean) => void—
presentText选中的内容文本string—

类型 AsamHierarchyOption

属性名说明类型默认值
label—string—
value—V—
disabled—boolean | undefined—
raw—I—
children—(readonly AsamOption<V, I>[] & readonly AsamHierarchyOption<V, I>[]) | undefined—
leaf懒加载叶节点标记;自定义原生映射也可从 raw 读取字段。boolean | undefined—
isLeaf—boolean | undefined—

类型 AsamCascaderLazyLoad

ts
(node: AsamCascaderNode, resolve: (options?: readonly AsamHierarchyOption<V, I>[]) => void, reject: () => void): void

类型 AsamCascaderSelectionProps

属性名说明类型默认值
disabled—(AsamCascaderSelectionProps<V, I>)["disabled"]—
lazy—boolean | undefined—
value—string | undefined—
label—string | undefined—
checkStrictly—boolean | undefined—
checkOnClickNode—boolean | undefined—
checkOnClickLeaf—boolean | undefined—
multiple—boolean | undefined—
showPrefix—boolean | undefined—
expandTrigger—enum"hover" | "click"完整类型:(AsamCascaderSelectionProps<V, I>)["expandTrigger"]—
emitPath—boolean | undefined—
children—string | undefined—
leaf—(AsamCascaderSelectionProps<V, I>)["leaf"]—
hoverThreshold—number | undefined—
lazyLoad—AsamCascaderLazyLoad<V, I> | undefined—

类型 AsamCascaderNativeProps

属性名说明类型默认值
effectTooltip 主题,内置了 dark / light 两种enum"light" | "dark"完整类型:(AsamCascaderNativeProps)["effect"]—
popperClass级联下拉面板的自定义类名。(AsamCascaderNativeProps)["popperClass"]—
popperStyle级联下拉面板的自定义样式。(AsamCascaderNativeProps)["popperStyle"]—
fallbackPlacements下拉面板可采用的位置列表。(AsamCascaderNativeProps)["fallbackPlacements"]—
placement下拉框出现的位置enum"auto" | "auto-start" | "auto-end" | "top" | "bottom" | "right" | "left" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end"完整类型:(AsamCascaderNativeProps)["placement"]—
persistent当下拉框未被激活并且persistent设置为false,下拉框容器会被删除。boolean | undefined—
teleported弹层是否使用 teleportboolean | undefined—
disabled指定选项的禁用为选项对象的某个属性值boolean | undefined—
size输入框尺寸enum"" | "large" | "default" | "small"完整类型:"" | "large" | "default" | "small" | undefined—
height虚拟滚动菜单高度。number | undefined—
props配置选项, 请参阅下面 CascaderProps 表。AsamCascaderNativeConfig | undefined—
itemSize虚拟滚动节点高度。number | undefined—
separator用于分隔选项的字符string | undefined—
modelValue指定选项的值为选项对象的某个属性值(AsamCascaderNativeProps)["modelValue"]—
filterMethod自定义搜索逻辑,第一个参数是node,第二个参数是keyword,返回的布尔值表示是否保留该选项((node: AsamCascaderNode, keyword: string) => boolean) | undefined—
checkOnClickNode点击节点时是否选中或取消选中该节点boolean | undefined—
options选项的数据源, value 和 label 可以通过 CascaderProps 自定义.AsamCascaderOption[] | undefined—
emptyValues组件支持的空值集合。unknown[] | undefined—
valueOnClear清空时返回的值;需要 undefined 时使用 () => undefined。(AsamCascaderNativeProps)["valueOnClear"]—
validateEvent是否触发表单验证boolean | undefined—
virtualScroll是否为大数据启用虚拟滚动boolean | undefined—
clearable是否支持清空选项boolean | undefined—
clearIcon自定义清除图标(AsamCascaderNativeProps)["clearIcon"]—
placeholder输入框占位文本string | undefined—
filterable该选项是否可以被搜索boolean | undefined—
debounce搜索关键词正在输入时的去抖延迟,单位为毫秒number | undefined—
collapseTags多选模式下是否折叠Tagboolean | undefined—
collapseTagsTooltip当鼠标悬停于折叠标签的文本时,是否显示所有选中的标签。要使用此功能,collapse-tags的值必须为trueboolean | undefined—
maxCollapseTags需要显示的 Tag 的最大数量。只有当 collapse-tags 设置为 true 时才会生效。number | undefined—
fitInputWidth建议面板的宽度是否与输入框一致;如果值为 number,则宽度为固定值。number | boolean | undefined—
tagType标签类型enum"primary" | "success" | "danger" | "warning" | "info"完整类型:"primary" | "success" | "danger" | "warning" | "info" | undefined—
tagEffect标签效果enum"light" | "dark" | "plain"完整类型:"light" | "dark" | "plain" | undefined—
showAllLevels输入框中是否显示选中值的完整路径boolean | undefined—
maxCollapseTagsTooltipHeight折叠标签提示的最大像素高度,需要启用 collapse-tags-tooltip。string | number | undefined—
beforeFilter过滤函数调用前,所要调用的钩子函数,该函数接收要过滤的值作为参数。如果该函数的返回值是 false 或者是一个被拒绝的 Promise,那么接下来的过滤逻辑便不会执行。((value: string) => boolean | Promise<any>) | undefined—
showCheckedStrategyparent 策略适合显示汇总父项;child 策略适合逐项展示所选子节点。enum"parent" | "child"完整类型:"parent" | "child" | undefined—
showPrefix是否显示单选框或复选框的前缀(图标)boolean | undefined—

用法与契约补充说明 ​

ASAM 扩展与迁移 ​

ASAM 扩展包括四档密度及 value/object、array/string 模型策略。静态组件不处理 request/dictType;未知值保留回显,选项到达后重新解析。native 模式直接使用原始 options/data 和字段映射,禁止混入规范化字符串存储。树选择提供公开树实例方法,级联提供 focus/blur、节点读取和弹层操作;具体列表见 API。

ASAM 扩展与迁移 ​

迁移旧挂载属性:popper-append-to-body 已淘汰,当前组件没有此属性。使用 teleported 控制级联弹层是否传送到组件外(默认 true);false 将弹层留在原位置。appendTo / append-to 是支持它的弹层入口用于指定传送目标的属性,固定版本的 Cascader 未公开此属性,不能直接传入级联组件;它与 teleported 的开关语义不同。

受控回写边界 ​

打开面板后,点击节点会产生候选值并发出 update:modelValue 和 change。固定 2.14.7 下,宿主忽略这次回写,或将候选转换回未发生变化的旧模型时,persistent=true 的面板可能继续显示候选值,getCheckedNodes 也可能返回该候选;关闭再打开不会自动回滚。此现象在原生级联、ASAM native、value 和 object 模式的对照中均已观察到,不能仅凭宿主模型未变就认为界面已经复位。

受控回写边界 ​

父级随后传入实际变化的 modelValue 时由原生组件重新同步显示和节点。persistent=false 关闭后销毁面板,公开 cascaderPanelRef 与 getCheckedNodes 遵循原生当前面板生命周期;ASAM 不再保存独立选择快照,也不补写原生标签删除或受控回滚算法。下方策略示例展示宿主模型、实际显示与公开节点的对照。

有禁用选项 ​

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

动态加载 ​

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

选中项显示策略 ​

示例前两个多选实例显式设置 persistent=false,并提供 native 路径预选值。关闭会销毁弹层面板,重新打开由原生组件按当前宿主值重建;parent 与 child 保留各自展示策略。关闭状态下标签、删除、清空以及 getCheckedNodes 的结果以 AsamCascader 当前公开实例为准,不保证销毁面板后仍有节点快照。宿主拒绝回写时的显示也遵循原生行为。

选中项显示策略 ​

后面的受控回写实例固定 persistent=true,提供 native/value/object 模式和接受、忽略、非幂等转换三种宿主处理。宿主模型、实际显示、公开节点和模型事件分别展示;先选择节点2,可观察忽略或第一次转换回旧值3的边界,再关闭/重开并将宿主实际改为4观察同步。这些按钮只调用公开弹层方法或改变宿主模型,没有切换 persistent 或强制重建组件来回滚。

自定义建议列表宽度 ​

建议面板(筛选时)的宽度默认会根据匹配到的选项中的最大宽度自动计算。 如果您通过 suggestion-item 插槽自定义建议选项,选项中显示的文本很可能不等于 label 的值,从而导致计算错误。 在这种情况下,您可以使用 fit-input-width 属性来固定其宽度。 当值为 number 时,宽度为固定的具体像素值。

ASAM 模式与默认值 ​

默认 valueMode="value",单选返回叶值或 TreeSelect 节点值,清空为 null;valueMode="object" 返回带 raw 的节点对象,多选清空为 []。0、false 与空字符串都是有效值。标准化 Cascader 固定 emitPath=false,需要完整路径使用 native。Cascader 顶层 multiple 显式值优先,未指定时读取 props.multiple。TreeSelect 默认 checkStrictly=true,显式 false 恢复父子联动;默认多选显示勾选框,显式 showCheckbox=false 可关闭。

ASAM 模式与默认值 ​

标准化多选默认数组;value 模式可显式 multipleValueMode="string" 与 separator。分隔符不能为空,值不能包含分隔符,全树序列化 token 不得冲突。object 与 native 不接受字符串存储策略。未知选中值保留回填,已加载节点提供实际显示标签,不主动改写宿主旧对象。loader/options/valueMode 变更隔离迟到回调。

ASAM 模式与默认值 ​

控件尺寸使用 large/big/default/small 四档及 ConfigProvider 的继承值。原生表中的 large/default/small 是底层尺寸,不能作为 ASAM 尺寸全集。基础组件只接收 options 或宿主 lazy 回调;Remote/Dict 的 provider、搜索及完整树获取属于对应数据入口。

标准化懒加载 ​

load/lazyLoad 返回 { value, label, raw, children?, leaf?, isLeaf? },不是原生任意对象。Cascader 默认读取 leaf,TreeSelect 默认读取 isLeaf;自定义字段通过 props.leaf/props.isLeaf 映射,额外业务字段可来自 raw。内部实例 key 为带类型字符串,业务 v-model 保留原值;原生模式使用原始 key。每次 loader 的 resolve 仅接收一次,重复值、循环树或不合法字符串序列化会抛类型错误;reject 保留原生失败重试语义。内联 props 重建但 loader 本身未变时不会重复初始化动态节点。validateEvent=false 停止包装层的 change 验证,表单 disabled 继续由原生上下文继承。

更多参数与事件说明 ​

ASAM 扩展与迁移 ​

模板中的 update:modelValue 与 change 按当前 valueMode、顶层或级联嵌套 multiple、multipleValueMode 推断:单值为节点值或 null,单对象为规范化节点或 null,多选为可写值数组或对象数组,字符串存储为 string(清空为 '')。camelCase 与 kebab-case 属性遵循同一约束;单选父 ref 必须允许 null,不得用全模式 union 代替当前模式。native 保留原生声明的模型 union 和原生清空值,不能将路径/多选示例的初始数组视为所有返回形状。TS 示例中的窄类型声明可直接复制。

SSR 使用限制 ​

固定 2.14.7 下,同一 SSR 服务进程连续渲染常驻级联弹层(persistent=true)时,可能出现节点 DOM ID 的 hydration mismatch;原生级联与 AsamCascader 均已实际复现。首次水合检查覆盖同一个新建 SSR 应用,不保证上述连续请求场景。模型值和标签显示正常也不代表水合没有警告。

参数与事件补充说明

组合契约按分支生效;请同时查看公开类型。

参数与事件说明

options

必填:否;声明来源:ASAM 声明。

默认值与来源
() => [](源码表达式;ASAM 声明)

来源分支 9

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码工厂(未执行):() => [] as CascaderOption[](2.14.7;源码事实,未作为 ASAM 运行实测)

separator

必填:否;声明来源:ASAM 声明。

默认值与来源
undefined(源码表达式;ASAM 声明)

来源分支 9

固定上游文档默认:' / '(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:' / '(2.14.7;源码事实,未作为 ASAM 运行实测)

disabled

必填:否;声明来源:ASAM 声明。

disabled 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

枚举:false / true

默认值与来源
undefined(已安装运行时;已安装组件)

来源分支 9

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:undefined(2.14.7;源码事实,未作为 ASAM 运行实测)

placeholder

必填:否;声明来源:ASAM 声明。

默认值与来源
'请选择'(源码表达式;ASAM 声明)

来源分支 9

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

filterable

必填:否;声明来源:ASAM 声明。

filterable 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

来源分支 9

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

clearable

必填:否;声明来源:ASAM 声明。

clearable 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

枚举:false / true

默认值与来源
true(源码表达式;ASAM 声明)

来源分支 9

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

teleported

必填:否;声明来源:ASAM 声明。

teleported 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

枚举:false / true

默认值与来源
true(已安装运行时;已安装组件)

来源分支 9

固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

size

必填:否;声明来源:ASAM 声明。

size 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"large" / "big" / "default" / "small"

默认值与来源
undefined(源码表达式;ASAM 声明)
modelValue

必填:否;声明来源:ASAM 声明。

默认值与来源
undefined(源码表达式;ASAM 声明)

来源分支 9

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

multiple

必填:按分支;声明来源:ASAM 声明。

multiple 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

契约分支 1

枚举:true

契约分支 2

枚举:false

契约分支 6

枚举:true

默认值与来源
undefined(源码表达式;ASAM 声明)
valueMode

必填:否;声明来源:ASAM 声明。

valueMode 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"value"

枚举:"object"

枚举:"native"

默认值与来源
'value'(源码表达式;ASAM 声明)
multipleValueMode

必填:否;声明来源:ASAM 声明。

multipleValueMode 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"string"

枚举:"array"

默认值与来源
undefined(源码表达式;ASAM 声明)
effect

必填:否;声明来源:上游声明。

effect 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"light" / "dark"

默认值与来源
"light"(已安装运行时;已安装组件)

固定上游文档默认:light(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:'light'(2.14.7;源码事实,未作为 ASAM 运行实测)

popperClass

必填:否;声明来源:上游声明。

popperClass 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false

默认值与来源
undefined(已安装运行时;已安装组件)

固定上游文档默认:''(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

popperStyle

必填:否;声明来源:上游声明。

popperStyle 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

默认值与来源
undefined(已安装运行时;已安装组件)

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

fallbackPlacements

必填:否;声明来源:上游声明。

默认值与来源
["bottom-start","bottom","top-start","top","right","left"](已安装运行时;已安装组件)

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:['bottom-start', 'bottom', 'top-start', 'top', 'right', 'left'](2.14.7;源码事实,未作为 ASAM 运行实测)

placement

必填:否;声明来源:上游声明。

placement 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"auto" / "auto-start" / "auto-end" / "top" / "bottom" / "right" / "left" / "top-start" / "top-end" / "bottom-start" / "bottom-end" / "right-start" / "right-end" / "left-start" / "left-end"

默认值与来源
"bottom-start"(已安装运行时;已安装组件)

固定上游文档默认:bottom-start(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:'bottom-start'(2.14.7;源码事实,未作为 ASAM 运行实测)

persistent

必填:否;声明来源:上游声明。

persistent 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
true(已安装运行时;已安装组件)

固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

height

必填:否;声明来源:上游声明。

默认值与来源
204(已安装运行时;已安装组件)

固定上游文档默认:204(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:CASCADER_PANEL_HEIGHT(2.14.7;源码事实,未作为 ASAM 运行实测)

itemSize

必填:否;声明来源:上游声明。

默认值与来源
34(已安装运行时;已安装组件)

固定上游文档默认:34(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:CASCADER_PANEL_ITEM_SIZE(2.14.7;源码事实,未作为 ASAM 运行实测)

filterMethod

必填:否;声明来源:上游声明。

filterMethod 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(node: AsamCascaderNode, keyword: string): boolean

默认值与来源
函数默认值(作为值传递)(函数值(不执行);已安装组件)

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码函数默认值(作为值,不执行):(node: CascaderNode, keyword: string) => node.text.includes(keyword)(2.14.7;源码事实,未作为 ASAM 运行实测)

checkOnClickNode

必填:否;声明来源:上游声明。

checkOnClickNode 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)
emptyValues

必填:否;声明来源:上游声明。

valueOnClear

必填:否;声明来源:上游声明。

valueOnClear 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

  • valueOnClear.apply: (this: Function, thisArg: any, argArray?: any) => any — 依赖声明

    调用函数,以指定对象作为 this,并使用指定数组作为函数参数。

    事件参数:(this: Function, thisArg: any, argArray?: any): any

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • valueOnClear.call: (this: Function, thisArg: any, ...argArray: any[]) => any — 依赖声明

    调用对象方法,并以另一个对象作为当前 this。

    事件参数:(this: Function, thisArg: any, ...argArray: any[]): any

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • valueOnClear.bind: (this: Function, thisArg: any, ...argArray: any[]) => any — 依赖声明

    创建具有相同函数体的绑定函数,将 this 绑定到指定对象,并设置初始参数。

    事件参数:(this: Function, thisArg: any, ...argArray: any[]): any

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • valueOnClear.toString: () => string — 依赖声明

    返回函数的字符串表示。

    事件参数:(): string

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • valueOnClear.prototype: any — 依赖声明
  • valueOnClear.length: number — 依赖声明
  • valueOnClear.arguments: any — 依赖声明
  • valueOnClear.caller: Function — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • valueOnClear.name: string — 依赖声明

    返回函数名称;函数名称只读,不能修改。

  • valueOnClear.__@hasInstance@8888: (value: any) => boolean — 依赖声明

    当函数用作构造函数时,判断指定值是否继承自该函数;构造函数可以覆盖此方法,控制 instanceof 对实例的识别。

    事件参数:(value: any): boolean

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

默认值与来源
undefined(已安装运行时;已安装组件)
validateEvent

必填:否;声明来源:上游声明。

validateEvent 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
true(已安装运行时;已安装组件)

固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

virtualScroll

必填:否;声明来源:上游声明。

virtualScroll 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

clearIcon

必填:否;声明来源:上游声明。

clearIcon 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(props: any, ctx: Parameters<Extract<NonNullable<(AsamCascaderProps<V, I>)["clearIcon"]>, (...args: never[]) => unknown>>[1]): any

  • clearIcon.__isFragment: undefined — 依赖声明
  • clearIcon.__isTeleport: undefined — 依赖声明
  • clearIcon.__isSuspense: undefined — 依赖声明
默认值与来源
{"name":"CircleClose","__name":"circle-close"}(已安装运行时;已安装组件)

固定上游文档默认:CircleClose(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:CircleClose(2.14.7;源码事实,未作为 ASAM 运行实测)

debounce

必填:否;声明来源:上游声明。

默认值与来源
300(已安装运行时;已安装组件)

固定上游文档默认:300(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:300(2.14.7;源码事实,未作为 ASAM 运行实测)

collapseTags

必填:否;声明来源:上游声明。

collapseTags 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

collapseTagsTooltip

必填:否;声明来源:上游声明。

collapseTagsTooltip 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(隐式 Boolean 默认;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

maxCollapseTags

必填:否;声明来源:上游声明。

默认值与来源
1(已安装运行时;已安装组件)

固定上游文档默认:1(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:1(2.14.7;源码事实,未作为 ASAM 运行实测)

fitInputWidth

必填:否;声明来源:上游声明。

fitInputWidth 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
false(已安装运行时;已安装组件)

固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:false(2.14.7;源码事实,未作为 ASAM 运行实测)

tagType

必填:否;声明来源:上游声明。

tagType 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"primary" / "success" / "danger" / "warning" / "info"

默认值与来源
"info"(已安装运行时;已安装组件)

固定上游文档默认:info(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

tagEffect

必填:否;声明来源:上游声明。

tagEffect 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"light" / "dark" / "plain"

默认值与来源
"light"(已安装运行时;已安装组件)

固定上游文档默认:light(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

showAllLevels

必填:否;声明来源:上游声明。

showAllLevels 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
true(已安装运行时;已安装组件)

固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

maxCollapseTagsTooltipHeight

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

beforeFilter

必填:否;声明来源:上游声明。

beforeFilter 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: string): boolean | Promise<any>

默认值与来源
函数默认值(作为值传递)(函数值(不执行);已安装组件)

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码函数默认值(作为值,不执行):() => true(2.14.7;源码事实,未作为 ASAM 运行实测)

showCheckedStrategy

必填:否;声明来源:上游声明。

showCheckedStrategy 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"parent" / "child"

默认值与来源
"child"(已安装运行时;已安装组件)

固定上游文档默认:child(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码默认表达式:'child'(2.14.7;源码事实,未作为 ASAM 运行实测)

showPrefix

必填:否;声明来源:上游声明。

showPrefix 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
true(已安装运行时;已安装组件)

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

props

必填:否;声明来源:ASAM 声明。

props 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • props.expandTrigger: PublicMember<NonNullable<AsamCascaderNativeConfig | undefined>, "expandTrigger"> — 上游声明

    次级菜单的展开方式

    固定上游文档默认:click(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:"hover" / "click"

  • props.multiple: boolean | undefined — 上游声明

    是否多选

    固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

  • props.checkStrictly: boolean | undefined — 上游声明

    是否严格的遵守父子节点不互相关联

    固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

  • props.emitPath: boolean | undefined — 上游声明

    在选中节点改变时,是否返回由该节点所在的各级菜单的值所组成的数组,若设置 false,则只返回该节点的值

    固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

  • props.lazy: boolean | undefined — 上游声明

    是否动态加载子节点,需与 lazyLoad 方法结合使用

    固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

  • props.lazyLoad: PublicMember<NonNullable<AsamCascaderNativeConfig | undefined>, "lazyLoad"> — 上游声明

    加载动态数据的方法,仅在 lazy 为 true 时有效 reject 参数在 2.11.5 版本及以上支持。

    固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    事件参数:(node: AsamCascaderNode, resolve: Parameters<Extract<NonNullable<PublicMember<NonNullable<AsamCascaderNativeConfig | undefined>, "lazyLoad">>, (...args: never[]) => unknown>>[1], reject: () => void): void

  • props.value: string | undefined — 上游声明

    指定选项的值为选项对象的某个属性值

    固定上游文档默认:value(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

  • props.label: string | undefined — 上游声明

    指定节点标签为节点对象的某个属性值

    固定上游文档默认:label(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

  • props.children: string | undefined — 上游声明

    指定选项的子选项为选项对象的某个属性值

    固定上游文档默认:children(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

  • props.disabled: PublicMember<NonNullable<AsamCascaderNativeConfig | undefined>, "disabled"> — 上游声明

    指定选项的禁用为选项对象的某个属性值

    固定上游文档默认:disabled(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    事件参数:(data: AsamCascaderOption, node: AsamCascaderNode): boolean

  • props.leaf: PublicMember<NonNullable<AsamCascaderNativeConfig | undefined>, "leaf"> — 上游声明

    指定选项的叶子节点的标志位为选项对象的某个属性值

    固定上游文档默认:leaf(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    事件参数:(data: AsamCascaderOption, node: AsamCascaderNode): boolean

  • props.hoverThreshold: number | undefined — 上游声明

    hover 时展开菜单的灵敏度阈值

    固定上游文档默认:500(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

  • props.checkOnClickNode: boolean | undefined — 上游声明

    点击节点时是否选中或取消选中该节点

    固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

  • props.checkOnClickLeaf: boolean | undefined — 上游声明

    点击叶节点(最后一个子节点)时是否检查或取消节点

    固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

  • props.showPrefix: boolean | undefined — 上游声明

    是否显示单选框或复选框的前缀(图标)

    固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

默认值与来源
工厂函数(每个实例创建)(实例工厂;已安装组件)

来源分支 9

固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

固定上游源码工厂(未执行):() => ({}) as CascaderProps(2.14.7;源码事实,未作为 ASAM 运行实测)

AsamCascaderProps 公开类型视图
ts
import type { Attrs } from 'vue';
import type { AsamCascaderProps, AsamValue, AsamHierarchyOption, AsamHierarchyRuntimeProps, AsamControlSize, AsamCascaderNode, AsamCascaderSelectionProps, AsamCascaderNativeConfig, AsamCascaderLazyLoad, AsamCascaderOption } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamCascaderProps
type PublicContract<V extends AsamValue = AsamValue, I extends object = object> = AsamCascaderProps<V, I>;

参数与事件说明

update:modelValue

必填:是;声明来源:ASAM 声明。

change

必填:是;声明来源:ASAM 声明。

clear

必填:是;声明来源:ASAM 声明。

focus

必填:是;声明来源:ASAM 声明。

blur

必填:是;声明来源:ASAM 声明。

visibleChange

必填:是;声明来源:ASAM 声明。

expandChange

必填:是;声明来源:ASAM 声明。

removeTag

必填:是;声明来源:ASAM 声明。

AsamCascaderEmits 公开类型视图
ts
import type { AsamCascaderEmits, AsamValue, AsamHierarchyOption, AsamHierarchyEmits } from '@asam-ui/ui';

// AsamCascaderEmits
type PublicContract = {
	"update:modelValue": (AsamCascaderEmits)["update:modelValue"];
	"change": (AsamCascaderEmits)["change"];
	"clear": (AsamCascaderEmits)["clear"];
	"focus": [event: FocusEvent];
	"blur": [event: FocusEvent];
	"visibleChange": [val: boolean];
	"expandChange": (AsamCascaderEmits)["expandChange"];
	"removeTag": (AsamCascaderEmits)["removeTag"];
};

参数与事件说明

default

必填:否;声明来源:ASAM 声明。

default 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(scope: { /** Present in normalized modes; native mode retains only the upstream slot fields. */ option?: AsamHierarchyOption; data: AsamCascaderOption; node: AsamCascaderNode; }): unknown

empty

必填:否;声明来源:ASAM 声明。

empty 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): unknown

prefix

必填:否;声明来源:ASAM 声明。

prefix 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): unknown

header

必填:否;声明来源:ASAM 声明。

header 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): unknown

footer

必填:否;声明来源:ASAM 声明。

footer 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): unknown

tag

必填:否;声明来源:ASAM 声明。

tag 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(scope: { data: AsamCascaderTag[]; deleteTag: (tag: AsamCascaderTag) => void; }): unknown

suggestion-item

必填:否;声明来源:ASAM 声明。

suggestion-item 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(scope: { item: AsamCascaderNode; }): unknown

AsamCascaderSlots 公开类型视图
ts
import type { AsamCascaderSlots, AsamHierarchyOption, AsamCascaderOption, AsamCascaderNode, AsamCascaderTag } from '@asam-ui/ui';

// AsamCascaderSlots
type PublicContract = {
	"default"?: ((scope: { 
/** Present in normalized modes; native mode retains only the upstream slot fields. */
option?: AsamHierarchyOption; data: AsamCascaderOption; node: AsamCascaderNode; }) => unknown) | undefined;
	"empty"?: (() => unknown) | undefined;
	"prefix"?: (() => unknown) | undefined;
	"header"?: (() => unknown) | undefined;
	"footer"?: (() => unknown) | undefined;
	"tag"?: ((scope: { data: AsamCascaderTag[]; deleteTag: (tag: AsamCascaderTag) => void; }) => unknown) | undefined;
	"suggestion-item"?: ((scope: { item: AsamCascaderNode; }) => unknown) | undefined;
};

参数与事件说明

focus

必填:是;声明来源:上游声明。

focus 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

getCheckedNodes

必填:是;声明来源:上游声明。

getCheckedNodes 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(leafOnly: boolean): AsamCascaderNode[] | undefined

contentRef

必填:是;声明来源:上游声明。

contentRef 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

嵌套展开边界:大型实例类型;完整类型见公开类型视图。

blur

必填:是;声明来源:上游声明。

blur 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(): void

cascaderPanelRef

必填:是;声明来源:上游声明。

togglePopperVisible

必填:是;声明来源:上游声明。

togglePopperVisible 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(visible?: boolean | undefined): void

presentText

必填:是;声明来源:上游声明。

AsamCascaderExpose 公开类型视图
ts
import type { AsamCascaderExpose, AsamCascaderNode, AsamHierarchyRuntimeProps } from '@asam-ui/ui';

// AsamCascaderExpose
type PublicContract = {
	"focus": () => void;
	"getCheckedNodes": (leafOnly: boolean) => AsamCascaderNode[] | undefined;
	"contentRef": HTMLElement | undefined;
	"blur": () => void;
	"cascaderPanelRef": (AsamCascaderExpose)["cascaderPanelRef"];
	"togglePopperVisible": (visible?: boolean) => void;
	"presentText": string;
};

参数与事件说明

label

必填:是;声明来源:数据 / provider 协议。

value

必填:是;声明来源:数据 / provider 协议。

disabled

必填:否;声明来源:数据 / provider 协议。

disabled 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

raw

必填:是;声明来源:数据 / provider 协议。

children

必填:否;声明来源:数据 / provider 协议。

leaf

必填:否;声明来源:ASAM 声明。

leaf 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

isLeaf

必填:否;声明来源:ASAM 声明。

isLeaf 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

AsamHierarchyOption 公开类型视图
ts
import type { AsamHierarchyOption, AsamValue, AsamOption } from '@asam-ui/ui';

// AsamHierarchyOption
type PublicContract<V extends AsamValue = AsamValue, I extends object = object> = {
	readonly "label": string;
	readonly "value": V;
	readonly "disabled"?: boolean | undefined;
	readonly "raw": I;
	readonly "children"?: (readonly AsamOption<V, I>[] & readonly AsamHierarchyOption<V, I>[]) | undefined;
	readonly "leaf"?: boolean | undefined;
	readonly "isLeaf"?: boolean | undefined;
};
AsamCascaderLazyLoad 公开类型视图
ts
import type { AsamCascaderLazyLoad, AsamValue, AsamCascaderNode, AsamHierarchyOption } from '@asam-ui/ui';

// AsamCascaderLazyLoad
type PublicContract<V extends AsamValue = AsamValue, I extends object = object> = {
	(node: AsamCascaderNode, resolve: (options?: readonly AsamHierarchyOption<V, I>[]) => void, reject: () => void): void;
};

参数与事件说明

disabled

必填:否;声明来源:上游声明。

disabled 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: AsamCascaderOption, node: AsamCascaderNode): boolean

lazy

必填:否;声明来源:上游声明。

lazy 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

value

必填:否;声明来源:上游声明。

label

必填:否;声明来源:上游声明。

checkStrictly

必填:否;声明来源:上游声明。

checkStrictly 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

checkOnClickNode

必填:否;声明来源:上游声明。

checkOnClickNode 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

checkOnClickLeaf

必填:否;声明来源:上游声明。

checkOnClickLeaf 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

multiple

必填:否;声明来源:上游声明。

multiple 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

showPrefix

必填:否;声明来源:上游声明。

showPrefix 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

expandTrigger

必填:否;声明来源:上游声明。

expandTrigger 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"hover" / "click"

emitPath

必填:否;声明来源:上游声明。

emitPath 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

children

必填:否;声明来源:上游声明。

leaf

必填:否;声明来源:上游声明。

leaf 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(data: AsamCascaderOption, node: AsamCascaderNode): boolean

hoverThreshold

必填:否;声明来源:上游声明。

lazyLoad

必填:否;声明来源:ASAM 声明。

lazyLoad 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(node: AsamCascaderNode, resolve: (options?: readonly AsamHierarchyOption<V, I>[] | undefined) => void, reject: () => void): void

AsamCascaderSelectionProps 公开类型视图
ts
import type { AsamCascaderSelectionProps, AsamValue, AsamCascaderOption, AsamCascaderNode, AsamHierarchyRuntimeProps, AsamCascaderLazyLoad, AsamHierarchyOption } from '@asam-ui/ui';

// AsamCascaderSelectionProps
type PublicContract<V extends AsamValue = AsamValue, I extends object = object> = {
	"disabled"?: (AsamCascaderSelectionProps<V, I>)["disabled"];
	"lazy"?: boolean | undefined;
	"value"?: string | undefined;
	"label"?: string | undefined;
	"checkStrictly"?: boolean | undefined;
	"checkOnClickNode"?: boolean | undefined;
	"checkOnClickLeaf"?: boolean | undefined;
	"multiple"?: boolean | undefined;
	"showPrefix"?: boolean | undefined;
	"expandTrigger"?: (AsamCascaderSelectionProps<V, I>)["expandTrigger"];
	"emitPath"?: boolean | undefined;
	"children"?: string | undefined;
	"leaf"?: (AsamCascaderSelectionProps<V, I>)["leaf"];
	"hoverThreshold"?: number | undefined;
	readonly "lazyLoad"?: AsamCascaderLazyLoad<V, I> | undefined;
};

参数与事件说明

effect

必填:否;声明来源:上游声明。

effect 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"light" / "dark"

默认值与来源
未知 / 未声明

固定上游源码默认表达式:'light'(2.14.7;源码事实,未作为 ASAM 运行实测)

popperClass

必填:否;声明来源:上游声明。

popperClass 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false

popperStyle

必填:否;声明来源:上游声明。

popperStyle 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false

嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

fallbackPlacements

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:['bottom-start', 'bottom', 'top-start', 'top', 'right', 'left'](2.14.7;源码事实,未作为 ASAM 运行实测)

placement

必填:否;声明来源:上游声明。

placement 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"auto" / "auto-start" / "auto-end" / "top" / "bottom" / "right" / "left" / "top-start" / "top-end" / "bottom-start" / "bottom-end" / "right-start" / "right-end" / "left-start" / "left-end"

默认值与来源
未知 / 未声明

固定上游源码默认表达式:'bottom-start'(2.14.7;源码事实,未作为 ASAM 运行实测)

persistent

必填:否;声明来源:上游声明。

persistent 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
未知 / 未声明

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

teleported

必填:否;声明来源:上游声明。

teleported 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

disabled

必填:否;声明来源:上游声明。

disabled 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
未知 / 未声明

固定上游源码默认表达式:undefined(2.14.7;源码事实,未作为 ASAM 运行实测)

size

必填:否;声明来源:上游声明。

size 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"" / "large" / "default" / "small"

height

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:CASCADER_PANEL_HEIGHT(2.14.7;源码事实,未作为 ASAM 运行实测)

props

必填:否;声明来源:上游声明。

props 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

  • props.expandTrigger: PublicMember<NonNullable<AsamCascaderNativeConfig | undefined>, "expandTrigger"> — 上游声明

    次级菜单的展开方式

    固定上游文档默认:click(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:"hover" / "click"

  • props.multiple: boolean | undefined — 上游声明

    是否多选

    固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

  • props.checkStrictly: boolean | undefined — 上游声明

    是否严格的遵守父子节点不互相关联

    固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

  • props.emitPath: boolean | undefined — 上游声明

    在选中节点改变时,是否返回由该节点所在的各级菜单的值所组成的数组,若设置 false,则只返回该节点的值

    固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

  • props.lazy: boolean | undefined — 上游声明

    是否动态加载子节点,需与 lazyLoad 方法结合使用

    固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

  • props.lazyLoad: PublicMember<NonNullable<AsamCascaderNativeConfig | undefined>, "lazyLoad"> — 上游声明

    加载动态数据的方法,仅在 lazy 为 true 时有效 reject 参数在 2.11.5 版本及以上支持。

    固定上游文档默认:未声明(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    事件参数:(node: AsamCascaderNode, resolve: Parameters<Extract<NonNullable<PublicMember<NonNullable<AsamCascaderNativeConfig | undefined>, "lazyLoad">>, (...args: never[]) => unknown>>[1], reject: () => void): void

  • props.value: string | undefined — 上游声明

    指定选项的值为选项对象的某个属性值

    固定上游文档默认:value(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

  • props.label: string | undefined — 上游声明

    指定节点标签为节点对象的某个属性值

    固定上游文档默认:label(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

  • props.children: string | undefined — 上游声明

    指定选项的子选项为选项对象的某个属性值

    固定上游文档默认:children(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

  • props.disabled: PublicMember<NonNullable<AsamCascaderNativeConfig | undefined>, "disabled"> — 上游声明

    指定选项的禁用为选项对象的某个属性值

    固定上游文档默认:disabled(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    事件参数:(data: AsamCascaderOption, node: AsamCascaderNode): boolean

  • props.leaf: PublicMember<NonNullable<AsamCascaderNativeConfig | undefined>, "leaf"> — 上游声明

    指定选项的叶子节点的标志位为选项对象的某个属性值

    固定上游文档默认:leaf(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    事件参数:(data: AsamCascaderOption, node: AsamCascaderNode): boolean

  • props.hoverThreshold: number | undefined — 上游声明

    hover 时展开菜单的灵敏度阈值

    固定上游文档默认:500(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

  • props.checkOnClickNode: boolean | undefined — 上游声明

    点击节点时是否选中或取消选中该节点

    固定上游文档默认:false(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

  • props.checkOnClickLeaf: boolean | undefined — 上游声明

    点击叶节点(最后一个子节点)时是否检查或取消节点

    固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

  • props.showPrefix: boolean | undefined — 上游声明

    是否显示单选框或复选框的前缀(图标)

    固定上游文档默认:true(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

    枚举:false / true

默认值与来源
未知 / 未声明

固定上游源码工厂(未执行):() => ({}) as CascaderProps(2.14.7;源码事实,未作为 ASAM 运行实测)

itemSize

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:CASCADER_PANEL_ITEM_SIZE(2.14.7;源码事实,未作为 ASAM 运行实测)

separator

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:' / '(2.14.7;源码事实,未作为 ASAM 运行实测)

modelValue

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

filterMethod

必填:否;声明来源:上游声明。

filterMethod 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(node: AsamCascaderNode, keyword: string): boolean

默认值与来源
未知 / 未声明

固定上游源码函数默认值(作为值,不执行):(node: CascaderNode, keyword: string) => node.text.includes(keyword)(2.14.7;源码事实,未作为 ASAM 运行实测)

checkOnClickNode

必填:否;声明来源:上游声明。

checkOnClickNode 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

options

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码工厂(未执行):() => [] as CascaderOption[](2.14.7;源码事实,未作为 ASAM 运行实测)

emptyValues

必填:否;声明来源:上游声明。

valueOnClear

必填:否;声明来源:上游声明。

valueOnClear 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

  • valueOnClear.apply: (this: Function, thisArg: any, argArray?: any) => any — 依赖声明

    调用函数,以指定对象作为 this,并使用指定数组作为函数参数。

    事件参数:(this: Function, thisArg: any, argArray?: any): any

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • valueOnClear.call: (this: Function, thisArg: any, ...argArray: any[]) => any — 依赖声明

    调用对象方法,并以另一个对象作为当前 this。

    事件参数:(this: Function, thisArg: any, ...argArray: any[]): any

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • valueOnClear.bind: (this: Function, thisArg: any, ...argArray: any[]) => any — 依赖声明

    创建具有相同函数体的绑定函数,将 this 绑定到指定对象,并设置初始参数。

    事件参数:(this: Function, thisArg: any, ...argArray: any[]): any

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • valueOnClear.toString: () => string — 依赖声明

    返回函数的字符串表示。

    事件参数:(): string

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • valueOnClear.prototype: any — 依赖声明
  • valueOnClear.length: number — 依赖声明
  • valueOnClear.arguments: any — 依赖声明
  • valueOnClear.caller: Function — 依赖声明

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

  • valueOnClear.name: string — 依赖声明

    返回函数名称;函数名称只读,不能修改。

  • valueOnClear.__@hasInstance@8888: (value: any) => boolean — 依赖声明

    当函数用作构造函数时,判断指定值是否继承自该函数;构造函数可以覆盖此方法,控制 instanceof 对实例的识别。

    事件参数:(value: any): boolean

    嵌套展开边界:框架 / 平台类型;完整类型见公开类型视图。

validateEvent

必填:否;声明来源:上游声明。

validateEvent 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
未知 / 未声明

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

virtualScroll

必填:否;声明来源:上游声明。

virtualScroll 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

clearable

必填:否;声明来源:上游声明。

clearable 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

clearIcon

必填:否;声明来源:上游声明。

clearIcon 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(props: any, ctx: Parameters<Extract<NonNullable<(AsamCascaderNativeProps)["clearIcon"]>, (...args: never[]) => unknown>>[1]): any

  • clearIcon.__isFragment: undefined — 依赖声明
  • clearIcon.__isTeleport: undefined — 依赖声明
  • clearIcon.__isSuspense: undefined — 依赖声明
默认值与来源
未知 / 未声明

固定上游源码默认表达式:CircleClose(2.14.7;源码事实,未作为 ASAM 运行实测)

placeholder

必填:否;声明来源:上游声明。

filterable

必填:否;声明来源:上游声明。

filterable 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

debounce

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:300(2.14.7;源码事实,未作为 ASAM 运行实测)

collapseTags

必填:否;声明来源:上游声明。

collapseTags 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

collapseTagsTooltip

必填:否;声明来源:上游声明。

collapseTagsTooltip 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

maxCollapseTags

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码默认表达式:1(2.14.7;源码事实,未作为 ASAM 运行实测)

fitInputWidth

必填:否;声明来源:上游声明。

fitInputWidth 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
未知 / 未声明

固定上游源码默认表达式:false(2.14.7;源码事实,未作为 ASAM 运行实测)

tagType

必填:否;声明来源:上游声明。

tagType 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"primary" / "success" / "danger" / "warning" / "info"

tagEffect

必填:否;声明来源:上游声明。

tagEffect 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"light" / "dark" / "plain"

showAllLevels

必填:否;声明来源:上游声明。

showAllLevels 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
未知 / 未声明

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

maxCollapseTagsTooltipHeight

必填:否;声明来源:上游声明。

默认值与来源
未知 / 未声明

固定上游源码未声明 default(2.14.7;源码事实,未作为 ASAM 运行实测)

beforeFilter

必填:否;声明来源:上游声明。

beforeFilter 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

事件参数:(value: string): boolean | Promise<any>

默认值与来源
未知 / 未声明

固定上游源码函数默认值(作为值,不执行):() => true(2.14.7;源码事实,未作为 ASAM 运行实测)

showCheckedStrategy

必填:否;声明来源:上游声明。

showCheckedStrategy 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:"parent" / "child"

默认值与来源
未知 / 未声明

固定上游源码默认表达式:'child'(2.14.7;源码事实,未作为 ASAM 运行实测)

showPrefix

必填:否;声明来源:上游声明。

showPrefix 参数与事件数据

下列为声明可读视图;可导入类型以公开类型视图为准。分支条件与父属性一致。

枚举:false / true

默认值与来源
未知 / 未声明

固定上游源码默认表达式:true(2.14.7;源码事实,未作为 ASAM 运行实测)

AsamCascaderNativeProps 公开类型视图
ts
import type { Attrs } from 'vue';
import type { AsamCascaderNativeProps, AsamHierarchyRuntimeProps, AsamCascaderNativeConfig, AsamCascaderNode, AsamCascaderOption } from '@asam-ui/ui';

type PublicMember<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] : never : never;

// AsamCascaderNativeProps
type PublicContract = {
	readonly "effect"?: (AsamCascaderNativeProps)["effect"];
	readonly "popperClass"?: (AsamCascaderNativeProps)["popperClass"];
	readonly "popperStyle"?: (AsamCascaderNativeProps)["popperStyle"];
	readonly "fallbackPlacements"?: (AsamCascaderNativeProps)["fallbackPlacements"];
	readonly "placement"?: (AsamCascaderNativeProps)["placement"];
	readonly "persistent"?: boolean | undefined;
	readonly "teleported"?: boolean | undefined;
	readonly "disabled"?: boolean | undefined;
	readonly "size"?: "" | "large" | "default" | "small" | undefined;
	readonly "height"?: number | undefined;
	readonly "props"?: AsamCascaderNativeConfig | undefined;
	readonly "itemSize"?: number | undefined;
	readonly "separator"?: string | undefined;
	readonly "modelValue"?: (AsamCascaderNativeProps)["modelValue"];
	readonly "filterMethod"?: ((node: AsamCascaderNode, keyword: string) => boolean) | undefined;
	readonly "checkOnClickNode"?: boolean | undefined;
	readonly "options"?: AsamCascaderOption[] | undefined;
	readonly "emptyValues"?: unknown[] | undefined;
	readonly "valueOnClear"?: (AsamCascaderNativeProps)["valueOnClear"];
	readonly "validateEvent"?: boolean | undefined;
	readonly "virtualScroll"?: boolean | undefined;
	readonly "clearable"?: boolean | undefined;
	readonly "clearIcon"?: (AsamCascaderNativeProps)["clearIcon"];
	readonly "placeholder"?: string | undefined;
	readonly "filterable"?: boolean | undefined;
	readonly "debounce"?: number | undefined;
	readonly "collapseTags"?: boolean | undefined;
	readonly "collapseTagsTooltip"?: boolean | undefined;
	readonly "maxCollapseTags"?: number | undefined;
	readonly "fitInputWidth"?: number | boolean | undefined;
	readonly "tagType"?: "primary" | "success" | "danger" | "warning" | "info" | undefined;
	readonly "tagEffect"?: "light" | "dark" | "plain" | undefined;
	readonly "showAllLevels"?: boolean | undefined;
	readonly "maxCollapseTagsTooltipHeight"?: string | number | undefined;
	readonly "beforeFilter"?: ((value: string) => boolean | Promise<any>) | undefined;
	readonly "showCheckedStrategy"?: "parent" | "child" | undefined;
	readonly "showPrefix"?: boolean | undefined;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭