数据组件

字典级联选择器 AsamDictCascader

在级联选择器上管理字典选项、重载和请求取消。

字典级联选择器 ​

在级联选择器上管理字典选项、重载和请求取消。

基础用法 ​

示例通过本地 provider 获取字典,支持模型更新、暂停与重载。所有请求都留在演示内部。

本地字典与生命周期

展开源码

数据来源与覆盖 ​

dictType 与 dataSource 只选一种;dataSource 使用 defineAsamDictSource 创建,不能再传 dictValueType。 完整说明。

单选值模式使用标量或 null;对象模式使用规范化 AsamOption。多选的数组与分隔字符串模式由 multiple、valueMode、multipleValueMode 联合约束;对象模式不能使用字符串存储。切换值策略时同时调整模型类型。

省略顶层 multiple 时使用公开配置 props.multiple;显式顶层 false 或 true 优先。 动态改变多选配置时同时更新模型,来源校验与显示控件采用同一有效策略。

对象单选清空统一发布 null;合法原生 valueOnClear 为 false 或 0、且 emptyValues 包含该值时,也保留 update:modelValue、change 与 clear 事件。 完整说明。

层级来源一次返回完整树;children 通过字段映射规范化。数据层不开放 lazy/load 或 props.lazy/props.lazyLoad,不能从基础页的节点懒加载示例推导本组件支持。值模型保留 ASAM 标量/对象策略,不开放 native 值模式。

生命周期、事件与实例 ​

active=false 暂停请求并保留上次成功数据;reload({ force: true }) 请求新数据,cancel() 取消当前请求。 完整说明。

immediate 控制初始化是否请求,active 控制请求是否启用。初始化和默认值以本页自动 API 的原始来源为准。

插槽与基础能力 ​

default 插槽保留对应级联或树节点的 data/node 与可选 option;tag、label 等以对应基础入口和本页公开 slots 为准。

本站继承关系 ​

本页数据来源、模型、事件和实例的覆盖规则优先;本站链接不扩大本组件公开契约。尺寸使用基础组件的 ASAM 尺寸规则,示例使用 default。

字典刷新与示例 Provider ​

强制重载会先调用 provider.dict.refresh,再重新读取字典。示例 provider 同时提供 get 和 refresh,并检查请求取消信号;使用固定字典数据,不连接真实后端。宿主接入时应在 refresh 中实现实际缓存更新。

完整树与对象多选 ​

示例一次返回完整组织树,使用 multiple 与 valueMode=object 保存规范化对象及 raw 成员;禁用成员不能勾选。 完整说明。

示例逐次保存 update:modelValue、change、success 和 error 的载荷快照:模型与成功结果保留规范化对象及原始 raw 树;失败记录错误种类和消息。 完整说明。

完整树、对象多选与失败恢复

展开源码

数据入口的原生事件边界 ​

Cascader 使用原生 visibleChange、expandChange 和 removeTag 名称;没有 Tree 拖放、check、popup-scroll 或 end-reached 事件。数据包装增加 success/error,模型事件沿用本文的值/对象模式。

层级展示与勾选策略 ​

完整示例使用原始字符串数组模型;数据来源一次提供完整树,保留禁用节点,并通过 default 插槽读取节点 data/node 和规范化 option.raw。 完整说明。

示例明确设置 height=180、itemSize=30、fitInputWidth=360。 完整说明。

当前固定版本存在原生兼容限制:已有勾选项时,仅动态修改 showCheckedStrategy 不会立即刷新已显示的标签;模型和勾选节点保持不变。此限制在原生与数据入口的相同输入中均复现,不能将策略属性变化视为已有标签已更新。

父子显示、标签和虚拟滚动

展开源码

局部请求错误插槽 ​

可选 error 插槽仅在当前请求错误存在时调用,接收只读 { error, stale, retry }。 完整说明。

retry 不接收参数,返回强制 reload 的 Promise,并遵守取消和卸载规则。 完整说明。

提供该插槽时,自有内容替换整个默认局部错误区;返回空内容也表示主动替换。 未提供时继续显示原错误文字、过期提示和默认重试按钮。无 error 的单独 stale 状态 不调用此插槽;empty、loading 和其他基础插槽继续使用原作用域。

以下完整 TS/JS 示例先制造失败,再等待插槽 retry 的返回结果;成功后可再次制造 更新失败,观察旧结果与模型保留。每次挂载使用独立子 app 和本地 provider。

局部错误定制、等待重试与过期恢复

展开源码

局部与全局浮层 ​

基础示例使用默认的全局挂载;局部挂载示例展示显式配置的 teleported 或 appendTo。先打开控件浮层,再观察其所在容器。挂载位置与控件值、请求协议互相独立。

API

属性 AsamDictCascaderProps

属性名说明类型默认值
effectTooltip 主题,内置了 dark / light 两种enum"light" | "dark"完整类型:(AsamDictCascaderProps<V, I>)["effect"]—
popperClass级联下拉面板的自定义类名。(AsamDictCascaderProps<V, I>)["popperClass"]—
popperStyle级联下拉面板的自定义样式。(AsamDictCascaderProps<V, I>)["popperStyle"]—
fallbackPlacements下拉面板可采用的位置列表。(AsamDictCascaderProps<V, I>)["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"完整类型:(AsamDictCascaderProps<V, I>)["placement"]—
persistent当下拉框未被激活并且persistent设置为false,下拉框容器会被删除。boolean | undefined—
teleported弹层是否使用 teleportboolean | undefinedfalse
disabled指定选项的禁用为选项对象的某个属性值boolean | undefinedfalse
size—enum"large" | "big" | "default" | "small"完整类型:AsamControlSize | undefined—
height虚拟滚动菜单高度。number | undefined—
itemSize虚拟滚动节点高度。number | undefined—
separator用于分隔选项的字符string | undefined—
modelValue—
查看完整类型string | undefined | V | null | undefined | AsamHierarchyOption<V, I> | null | undefined | readonly V[] | undefined | readonly AsamHierarchyOption<V, I>[] | undefined
false
filterMethod自定义搜索逻辑,第一个参数是node,第二个参数是keyword,返回的布尔值表示是否保留该选项((node: AsamCascaderNode, keyword: string) => boolean) | undefined—
checkOnClickNode点击节点时是否选中或取消选中该节点boolean | undefined—
multiple—true | false | undefined | true | undefinedfalse
valueMode—enum"value" | "object"完整类型:"value" | undefined | "object"—
multipleValueMode—enum"string" | "array"完整类型:"string" | undefined | "array" | undefined—
emptyValues组件支持的空值集合。unknown[] | undefined—
valueOnClear清空时返回的值;需要 undefined 时使用 () => undefined。(AsamDictCascaderProps<V, I>)["valueOnClear"]—
validateEvent是否触发表单验证boolean | undefined—
virtualScroll是否为大数据启用虚拟滚动boolean | undefined—
clearable是否支持清空选项boolean | undefinedfalse
clearIcon自定义清除图标(AsamDictCascaderProps<V, I>)["clearIcon"]—
placeholder输入框占位文本string | undefined—
filterable该选项是否可以被搜索boolean | undefinedfalse
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—
props—Omit<AsamCascaderNativeConfig, "lazy" | "lazyLoad"> | undefined—
immediate—boolean | undefinedtrue
active—boolean | undefinedtrue
dictType—string | undefined—
dictValueType—enum"string" | "number" | "boolean"完整类型:AsamDictValueType | undefined | undefined—
dataSource—undefined | AsamOptionsSource<V, I, "dict">—

事件 AsamCascaderDataEmits

属性名说明类型默认值
clear—(AsamCascaderDataEmits<V, I>)["clear"]—
focus—[event: FocusEvent]—
success—[data: readonly AsamOption<V, I>[]]—
change—[value: string | V | AsamOption<V, I> | readonly AsamOption<V, I>[] | readonly V[] | null]—
error—[error: AsamDataError]—
update:modelValue—[value: string | V | AsamOption<V, I> | readonly AsamOption<V, I>[] | readonly V[] | null]—
blur—[event: FocusEvent]—
visibleChange—[visible: boolean]—
expandChange—(AsamCascaderDataEmits<V, I>)["expandChange"]—
removeTag—(AsamCascaderDataEmits<V, I>)["removeTag"]—

插槽 AsamCascaderDataSlots

属性名说明类型默认值
tag—((scope: { data: AsamCascaderTag[]; deleteTag: (tag: AsamCascaderTag) => void; }) => unknown) | undefined—
prefix—(() => unknown) | undefined—
footer—(() => unknown) | undefined—
header—(() => unknown) | undefined—
empty—(() => unknown) | undefined—
suggestion-item—((scope: { item: AsamCascaderNode; }) => unknown) | undefined—
error替换本地错误区域;重试返回现有强制重新加载的 Promise。(AsamCascaderDataSlots<V, I>)["error"]—
default—
查看完整类型((scope: Omit<{ option?: AsamHierarchyOption; data: AsamCascaderOption; node: AsamCascaderNode; }, "option"> & { option: AsamOption<V, I> | undefined; }) => unknown) | undefined
—

实例方法与状态 AsamDictCascaderExpose

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

用法与契约补充说明 ​

数据来源与覆盖 ​

dictType 与 dataSource 只选一种;dataSource 使用 defineAsamDictSource 创建,不能再传 dictValueType。短来源的 dictValueType 可将字典值转换为 string、number 或 boolean。应用通过 provideAsamData 注入 dict.get,演示在独立子应用中使用本地字典,切换语言或离开时卸载。

数据来源与覆盖 ​

对象单选清空统一发布 null;合法原生 valueOnClear 为 false 或 0、且 emptyValues 包含该值时,也保留 update:modelValue、change 与 clear 事件。多选清空发布空数组。 合法清空回调返回 [] 或 [null]、且 emptyValues 包含对应数组时,对象单选同样 发布 null;原生清空数组不会进入公开的单对象模型。 dictValueType 为 number 或 boolean 时,业务节点 0 或 false 仍保存完整 AsamOption 和 raw,不当成清空值;原生实例的节点键为 number:0、boolean:false。

生命周期、事件与实例 ​

active=false 暂停请求并保留上次成功数据;reload({ force: true }) 请求新数据,cancel() 取消当前请求。success 返回规范化选项数组,error 返回 AsamDataError;旧成功数据更新失败时组件显示过期状态。reload 的 status 为 success、error 或 cancelled;不能把取消当作成功。

完整树与对象多选 ​

示例一次返回完整组织树,使用 multiple 与 valueMode=object 保存规范化对象及 raw 成员;禁用成员不能勾选。展示节点、header/footer、过滤、清空、原生 getCheckedNodes、刷新失败的旧数据保留与取消慢请求。读取节点时只保存数量,避免序列化级联节点的循环引用。演示使用独立 Vue 应用安装 provider,卸载时释放应用。 不包含节点懒加载。

完整树与对象多选 ​

示例逐次保存 update:modelValue、change、success 和 error 的载荷快照:模型与成功结果保留规范化对象及原始 raw 树;失败记录错误种类和消息。default 读取规范化 option.raw 与原生 data.label,header/footer 直接展示内容。取消请求不会伪造一次成功事件,失败刷新不清空调用方模型。

层级展示与勾选策略 ​

完整示例使用原始字符串数组模型;数据来源一次提供完整树,保留禁用节点,并通过 default 插槽读取节点 data/node 和规范化 option.raw。折叠标签显示实际提示,自定义 tag 通过原生 deleteTag 回调删除,removeTag 原样转发基础组件的原生事件载荷;模型仍保留原始标量值。禁用后不能删除或勾选。checkStrictly 控制父节点是否独立选择,读取公开勾选实例只序列化键,避免节点循环引用。原生实例和原生节点事件使用节点键,取 default 插槽的 data.value 或 getCheckedNodes(false) 返回节点的 value;业务值取 v-model 或 option.value,不能直接把业务模型值当作原生实例键。showCheckedStrategy 设置 parent/child 标签显示策略,virtualScroll 用于大型分组的现有完整子树;fitInputWidth 配置过滤后的搜索面板:数字固定宽度,true 与输入同宽,false 使用自然宽度并保留输入宽度的最小值。常规多列树面板的宽度不能作为此属性的证据。示例在搜索框输入“成员”后可切换三种宽度,并用 suggestion-item 定制完整树匹配结果。虚拟渲染不会添加 lazy/lazyLoad 数据请求。

层级展示与勾选策略 ​

示例明确设置 height=180、itemSize=30、fitInputWidth=360。height 传入 AsamCascader 的原生虚拟列表;本站固定原生版本 2.14.7 当前样式的上下 margin 各为 6px,min-height 与父级伸展使实际视口为 192px,不能把 height 当成包含全部外部样式的固定面板高度。完整树的 200 个子节点只渲染可视窗口,关闭 virtualScroll 后渲染全部子节点。

局部请求错误插槽 ​

可选 error 插槽仅在当前请求错误存在时调用,接收只读 { error, stale, retry }。 error 与本实例 error 事件中的 AsamDataError 为同一对象,保留 cause、kind、 message 与 notified;渲染插槽不会再次通知 provider。stale 表示保留的数据已过期。

更多参数与事件说明 ​

局部请求错误插槽 ​

retry() 不接收参数,直接返回现有 reload({ force: true }) 的 Promise,结果为 AsamReloadResult<readonly AsamOption<V, I>[]> 的 success、error 或 cancelled 分支。 重试遵守 active、当前来源、取消和卸载规则,不改写模型。字典强刷沿用 provider 的 refresh 后 get;缺少 refresh 仍是原配置错误。

继承能力

本入口的独有 API 见上表,基础能力见本站对应页面。

参数与事件补充说明

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

参数与事件说明

effect

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

effect 参数与事件数据

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

枚举:"light" / "dark"

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

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

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

popperClass

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

popperClass 参数与事件数据

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

枚举:false

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

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

popperStyle

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

popperStyle 参数与事件数据

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

枚举:false

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

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

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

fallbackPlacements

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

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

固定上游文档默认:未声明(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(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

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

persistent

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

persistent 参数与事件数据

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

枚举:false / true

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

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

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

teleported

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

teleported 参数与事件数据

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

枚举:false / true

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

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

disabled 参数与事件数据

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

枚举:false / true

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

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

size 参数与事件数据

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

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

height

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

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

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

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

itemSize

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

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

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

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

separator

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

modelValue

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

默认值与来源
false(隐式 Boolean 默认;已安装组件)
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

multiple

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

multiple 参数与事件数据

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

枚举:true

枚举:false

枚举:true

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

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

valueMode 参数与事件数据

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

枚举:"value"

枚举:"object"

multipleValueMode

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

multipleValueMode 参数与事件数据

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

枚举:"string"

枚举:"array"

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 源码 / 安装包为准)

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

virtualScroll

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

virtualScroll 参数与事件数据

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

枚举:false / true

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

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

clearable

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

clearable 参数与事件数据

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

枚举:false / true

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

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

clearIcon 参数与事件数据

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

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

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

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

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

placeholder

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

filterable

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

filterable 参数与事件数据

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

枚举:false / true

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

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

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

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

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

collapseTags

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

collapseTags 参数与事件数据

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

枚举:false / true

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

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

collapseTagsTooltip

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

collapseTagsTooltip 参数与事件数据

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

枚举:false / true

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

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

maxCollapseTags

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

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

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

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

fitInputWidth

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

fitInputWidth 参数与事件数据

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

枚举:false / true

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

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

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

tagType

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

tagType 参数与事件数据

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

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

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

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

tagEffect

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

tagEffect 参数与事件数据

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

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

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

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

showAllLevels

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

showAllLevels 参数与事件数据

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

枚举:false / 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(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

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

showPrefix

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

showPrefix 参数与事件数据

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

枚举:false / true

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

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

props

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

props 参数与事件数据

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

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

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

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

    枚举:false / true

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

    枚举:false / true

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

    枚举:false / true

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

    枚举:false / true

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

    枚举:false / true

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

    枚举:"hover" / "click"

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

    枚举:false / true

  • props.children: string | undefined — 上游声明
  • props.leaf: PublicMember<NonNullable<Omit<AsamCascaderNativeConfig, "lazy" | "lazyLoad"> | undefined>, "leaf"> — 上游声明

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

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

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

immediate 参数与事件数据

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

枚举:false / true

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

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

active 参数与事件数据

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

枚举:false / true

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

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

dictValueType

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

dictValueType 参数与事件数据

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

枚举:"string" / "number" / "boolean"

dataSource

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

dataSource 参数与事件数据

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

  • dataSource.kind: "dict" — 数据 / provider 协议

    枚举:"dict"

  • dataSource.__@sourceBrand@58165: { readonly value: V; readonly raw: I; } — 数据 / provider 协议
    • dataSource.__@sourceBrand@58165.value: V — 数据 / provider 协议
    • dataSource.__@sourceBrand@58165.raw: I — 数据 / provider 协议
AsamDictCascaderProps 公开类型视图
ts
import type { Attrs } from 'vue';
import type { AsamDictCascaderProps, AsamValue, AsamRecord, AsamHierarchyRuntimeProps, AsamControlSize, AsamCascaderNode, AsamCascaderNativeConfig, AsamCascaderOption, AsamDictValueType, AsamOptionsSource, AsamHierarchyOption } from '@asam-ui/ui';

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

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

只承接 Cascader 基础事件;此入口不接收 Tree 的拖拽、放置、勾选或滚动事件。

参数与事件说明

clear

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

focus

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

success

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

change

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

error

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

update:modelValue

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

blur

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

visibleChange

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

expandChange

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

removeTag

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

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

// AsamCascaderDataEmits
type PublicContract<V extends AsamValue = AsamValue, I extends object = object> = {
	"clear": (AsamCascaderDataEmits<V, I>)["clear"];
	"focus": [event: FocusEvent];
	"success": [data: readonly AsamOption<V, I>[]];
	"change": [value: string | V | AsamOption<V, I> | readonly AsamOption<V, I>[] | readonly V[] | null];
	"error": [error: AsamDataError];
	"update:modelValue": [value: string | V | AsamOption<V, I> | readonly AsamOption<V, I>[] | readonly V[] | null];
	"blur": [event: FocusEvent];
	"visibleChange": [visible: boolean];
	"expandChange": (AsamCascaderDataEmits<V, I>)["expandChange"];
	"removeTag": (AsamCascaderDataEmits<V, I>)["removeTag"];
};

参数与事件说明

tag

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

tag 参数与事件数据

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

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

prefix

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

prefix 参数与事件数据

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

事件参数:(): unknown

footer

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

footer 参数与事件数据

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

事件参数:(): unknown

header

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

header 参数与事件数据

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

事件参数:(): unknown

empty

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

empty 参数与事件数据

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

事件参数:(): unknown

suggestion-item

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

suggestion-item 参数与事件数据

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

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

error

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

error 参数与事件数据

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

事件参数:(scope: Parameters<Extract<NonNullable<(AsamCascaderDataSlots<V, I>)["error"]>, (...args: never[]) => unknown>>[0]): unknown

default

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

default 参数与事件数据

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

事件参数:(scope: Omit<{ option?: AsamHierarchyOption; data: AsamCascaderOption; node: AsamCascaderNode; }, "option"> & { option: AsamOption<V, I> | undefined; }): unknown

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

// AsamCascaderDataSlots
type PublicContract<V extends AsamValue = AsamValue, I extends object = object> = {
	"tag"?: ((scope: { data: AsamCascaderTag[]; deleteTag: (tag: AsamCascaderTag) => void; }) => unknown) | undefined;
	"prefix"?: (() => unknown) | undefined;
	"footer"?: (() => unknown) | undefined;
	"header"?: (() => unknown) | undefined;
	"empty"?: (() => unknown) | undefined;
	"suggestion-item"?: ((scope: { item: AsamCascaderNode; }) => unknown) | undefined;
	"error"?: (AsamCascaderDataSlots<V, I>)["error"];
	"default"?: ((scope: Omit<{ option?: AsamHierarchyOption; data: AsamCascaderOption; node: AsamCascaderNode; }, "option"> & { option: AsamOption<V, I> | undefined; }) => unknown) | undefined;
};

参数与事件说明

focus

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

focus 参数与事件数据

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

事件参数:(): void

getCheckedNodes

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

getCheckedNodes 参数与事件数据

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

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

contentRef

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

contentRef 参数与事件数据

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

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

blur

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

blur 参数与事件数据

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

事件参数:(): void

cascaderPanelRef

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

togglePopperVisible

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

togglePopperVisible 参数与事件数据

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

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

presentText

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

reload

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

reload 参数与事件数据

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

事件参数:(options?: { readonly force?: boolean; } | undefined): Promise<AsamReloadResult<readonly AsamOption<V, I>[]>>

cancel

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

cancel 参数与事件数据

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

事件参数:(): void

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

// AsamDictCascaderExpose
type PublicContract<V extends AsamValue = AsamValue, I extends object = object> = {
	"focus": () => void;
	"getCheckedNodes": (leafOnly: boolean) => AsamCascaderNode[] | undefined;
	"contentRef": HTMLElement | undefined;
	"blur": () => void;
	"cascaderPanelRef": (AsamDictCascaderExpose<V, I>)["cascaderPanelRef"];
	"togglePopperVisible": (visible?: boolean) => void;
	"presentText": string;
	"reload": (options?: { readonly force?: boolean; }) => Promise<AsamReloadResult<readonly AsamOption<V, I>[]>>;
	"cancel": () => void;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭