数据组件

字典树选择器 AsamDictTreeSelect

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

字典树选择器 ​

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

基础用法 ​

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

本地字典与生命周期

展开源码

数据来源与覆盖 ​

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

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

层级来源一次返回完整树;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 为准。

本站继承关系 ​

  • 树选择器:适用的基础展示、交互与公开 API。

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

字典刷新与示例 Provider ​

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

完整树与对象多选 ​

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

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

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

展开源码

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

沿用 TreeSelect 原生事件名与参数;选中模型由外层数据来源规范化。 完整说明。

层级展示与勾选策略 ​

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

点击 default 插槽内的“记住父节点键”保存原生 data.value,再使用 setChecked(key, true, deep) 的第三个参数。 完整说明。

checkStrictly=false 时,勾选父节点会按原生规则传播到可用子节点;checkStrictly=true 时父节点独立选择。两个模式保留原始业务值模型,原生实例仍使用节点键。deep 参数决定实例操作是否递归,不能用它替代整个控件的 checkStrictly 配置。

父级选择、标签和树实例

展开源码

示例还保留默认深度(省略第三参数)的独立勾选、按 default 插槽节点 data 的递归勾选,以及不存在数字键的无副作用操作。传入的节点 data 保留原生 value 键,不能用业务 raw 对象代替。

递归勾选后,调用 setChecked(data, false, true) 取消可用后代的勾选,并清空父节点的半选状态。此操作直接验证 setChecked 的 checked=false 分支,与单独调用 setCheckedKeys 清空列表的演示各自对应。

局部请求错误插槽 ​

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

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

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

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

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

展开源码

局部与全局浮层 ​

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

API

属性 AsamDictTreeSelectProps

属性名说明类型默认值
ariaLabel—string | undefined—
id—string | undefined—
effect—enum"light" | "dark"完整类型:(AsamDictTreeSelectProps<V, I>)["effect"]—
popperClass—(AsamDictTreeSelectProps<V, I>)["popperClass"]—
popperStyle—(AsamDictTreeSelectProps<V, I>)["popperStyle"]—
fallbackPlacements—(AsamDictTreeSelectProps<V, I>)["fallbackPlacements"]—
offset—number | undefined—
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"完整类型:(AsamDictTreeSelectProps<V, I>)["placement"]—
popperOptions—(AsamDictTreeSelectProps<V, I>)["popperOptions"]—
showArrow—(AsamDictTreeSelectProps<V, I>)["showArrow"]—
appendTo—(AsamDictTreeSelectProps<V, I>)["appendTo"]—
persistent—(AsamDictTreeSelectProps<V, I>)["persistent"]—
teleported—boolean | undefinedfalse
disabled—boolean | undefinedfalse
tabindex—(AsamDictTreeSelectProps<V, I>)["tabindex"]—
size—enum"large" | "big" | "default" | "small"完整类型:AsamControlSize | undefined—
emptyText—string | undefined—
defaultExpandAll—boolean | undefined—
indent—number | undefined—
props—AsamTreeOptionProps | undefined—
name—string | undefined—
icon—(AsamDictTreeSelectProps<V, I>)["icon"]—
separator—string | undefined—
modelValue—
查看完整类型string | undefined | V | null | undefined | AsamHierarchyOption<V, I> | null | undefined | readonly V[] | undefined | readonly AsamHierarchyOption<V, I>[] | undefined
false
accordion—boolean | undefined—
loading—boolean | undefined—
filterMethod—((query: string) => void) | undefined—
renderAfterExpand—(AsamDictTreeSelectProps<V, I>)["renderAfterExpand"]—
nodeKey—string | undefined—
checkStrictly—boolean | undefined—
expandOnClickNode—(AsamDictTreeSelectProps<V, I>)["expandOnClickNode"]—
checkOnClickNode—boolean | undefined—
checkOnClickLeaf—(AsamDictTreeSelectProps<V, I>)["checkOnClickLeaf"]—
checkDescendants—boolean | undefined—
autoExpandParent—(AsamDictTreeSelectProps<V, I>)["autoExpandParent"]—
defaultCheckedKeys—AsamTreeKey[] | undefined—
defaultExpandedKeys—AsamTreeKey[] | undefined—
currentNodeKey—(AsamDictTreeSelectProps<V, I>)["currentNodeKey"]—
renderContent—AsamTreeRenderContentFunction | undefined—
showCheckbox—boolean | undefined—
draggable—boolean | undefined—
allowDrag—AsamTreeAllowDragFunction | undefined—
allowDrop—AsamTreeAllowDropFunction | undefined—
highlightCurrent—boolean | undefined—
filterNodeMethod—AsamTreeFilterNodeMethodFunction | undefined—
multiple—true | false | undefinedfalse
valueMode—enum"value" | "object"完整类型:"value" | undefined | "object"—
multipleValueMode—enum"string" | "array"完整类型:"string" | undefined | "array" | undefined—
emptyValues—unknown[] | undefined—
valueOnClear—(AsamDictTreeSelectProps<V, I>)["valueOnClear"]—
validateEvent—(AsamDictTreeSelectProps<V, I>)["validateEvent"]—
clearable—boolean | undefinedfalse
automaticDropdown—boolean | undefined—
clearIcon—(AsamDictTreeSelectProps<V, I>)["clearIcon"]—
placeholder—string | undefined—
autocomplete—string | undefined—
filterable—boolean | undefinedfalse
allowCreate—boolean | undefined—
remote—boolean | undefined—
debounce—number | undefined—
loadingText—string | undefined—
noMatchText—string | undefined—
noDataText—string | undefined—
remoteMethod—((query: string) => void) | undefined—
multipleLimit—number | undefined—
defaultFirstOption—boolean | undefined—
reserveKeyword—(AsamDictTreeSelectProps<V, I>)["reserveKeyword"]—
valueKey—string | undefined—
collapseTags—boolean | undefined—
collapseTagsTooltip—boolean | undefined—
tagTooltip—(AsamDictTreeSelectProps<V, I>)["tagTooltip"]—
maxCollapseTags—number | undefined—
fitInputWidth—boolean | undefined—
suffixIcon—(AsamDictTreeSelectProps<V, I>)["suffixIcon"]—
tagType—enum"primary" | "success" | "danger" | "warning" | "info"完整类型:(AsamDictTreeSelectProps<V, I>)["tagType"]—
tagEffect—enum"light" | "dark" | "plain"完整类型:(AsamDictTreeSelectProps<V, I>)["tagEffect"]—
remoteShowSuffix—boolean | undefined—
cacheData—readonly AsamHierarchyOption<V, I>[] | undefined—
immediate—boolean | undefinedtrue
active—boolean | undefinedtrue
dictType—string | undefined—
dictValueType—enum"string" | "number" | "boolean"完整类型:AsamDictValueType | undefined | undefined—
dataSource—undefined | AsamOptionsSource<V, I, "dict">—

事件 AsamTreeSelectDataEmits

属性名说明类型默认值
clear—(AsamTreeSelectDataEmits<V, I>)["clear"]—
focus—[event: FocusEvent]—
current-change—(AsamTreeSelectDataEmits<V, I>)["current-change"]—
success—[data: readonly AsamOption<V, I>[]]—
end-reached—[direction: AsamScrollbarDirection]—
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]—
check-change—[data: any, checked: boolean, indeterminate: boolean]—
node-click—(AsamTreeSelectDataEmits<V, I>)["node-click"]—
node-contextmenu—(AsamTreeSelectDataEmits<V, I>)["node-contextmenu"]—
node-collapse—(AsamTreeSelectDataEmits<V, I>)["node-collapse"]—
node-expand—(AsamTreeSelectDataEmits<V, I>)["node-expand"]—
check—[data: any, checkedInfo: AsamTreeCheckedInfo]—
node-drag-start—(AsamTreeSelectDataEmits<V, I>)["node-drag-start"]—
node-drag-end—(AsamTreeSelectDataEmits<V, I>)["node-drag-end"]—
node-drop—(AsamTreeSelectDataEmits<V, I>)["node-drop"]—
node-drag-leave—(AsamTreeSelectDataEmits<V, I>)["node-drag-leave"]—
node-drag-enter—(AsamTreeSelectDataEmits<V, I>)["node-drag-enter"]—
node-drag-over—(AsamTreeSelectDataEmits<V, I>)["node-drag-over"]—
blur—[event: FocusEvent]—
visible-change—[visible: boolean]—
remove-tag—[value: unknown]—
popup-scroll—[event: { scrollTop: number; scrollLeft: number; }]—

插槽 AsamTreeSelectDataSlots

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

实例方法与状态 AsamDictTreeSelectExpose

属性名说明类型默认值
filter—(value: AsamTreeFilterValue) => void—
updateKeyChildren—(key: AsamTreeKey, data: AsamTreeData) => void—
getCheckedNodes—(leafOnly?: boolean, includeHalfChecked?: boolean) => AsamTreeNodeData[]—
getCheckedKeys—(leafOnly?: boolean) => AsamTreeKey[]—
getCurrentNode—() => AsamTreeNodeData | null—
getCurrentKey—() => AsamTreeKey | null—
setCheckedNodes—(AsamDictTreeSelectExpose<V, I>)["setCheckedNodes"]—
setCheckedKeys—(keys: AsamTreeKey[], leafOnly?: boolean) => void—
setChecked—(data: AsamTreeKey | AsamTreeNodeData, checked: boolean, deep?: boolean) => void—
getHalfCheckedNodes—() => AsamTreeNodeData[]—
getHalfCheckedKeys—() => AsamTreeKey[]—
setCurrentNode—(AsamDictTreeSelectExpose<V, I>)["setCurrentNode"]—
setCurrentKey—(key?: AsamTreeKey | null, shouldAutoExpandParent?: boolean) => void—
getNode—(AsamDictTreeSelectExpose<V, I>)["getNode"]—
remove—(AsamDictTreeSelectExpose<V, I>)["remove"]—
append—(AsamDictTreeSelectExpose<V, I>)["append"]—
insertBefore—(AsamDictTreeSelectExpose<V, I>)["insertBefore"]—
insertAfter—(AsamDictTreeSelectExpose<V, I>)["insertAfter"]—
focus—() => void—
blur—() => void—
selectedLabel—string | string[]—
treeRef—(AsamDictTreeSelectExpose<V, I>)["treeRef"]—
selectRef—(AsamDictTreeSelectExpose<V, I>)["selectRef"]—
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,演示在独立子应用中使用本地字典,切换语言或离开时卸载。

生命周期、事件与实例 ​

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 回调删除,remove-tag 原样转发基础组件的原生事件载荷;模型仍保留原始标量值。禁用后不能删除或勾选。checkStrictly 控制父节点是否独立选择,读取公开勾选实例只序列化键,避免节点循环引用。原生实例和原生节点事件使用节点键,取 default 插槽的 data.value 或 getCheckedKeys 返回值;业务值取 v-model 或 option.value,不能直接把业务模型值当作原生实例键。showCheckbox、checkOnClickNode 和 renderAfterExpand 保持 TreeSelect 公开语义,宽度通过 popperStyle.minWidth 设置。勾选接口来自 Tree,标签和弹层来自 Select;不从本例推导节点懒加载支持。

层级展示与勾选策略 ​

点击 default 插槽内的“记住父节点键”保存原生 data.value,再使用 setChecked(key, true, deep) 的第三个参数。checkStrictly=true 时,deep=false 仅勾选父节点;deep=true 勾选两个可用子节点,禁用子节点保持未选,因此父节点在 getHalfCheckedKeys 中半选。模型业务值从 option.value 或 v-model 取得;AsamOption 没有公开 key 字段。原生实例读写使用插槽提供的节点键,示例先检查其为 string/number。

局部请求错误插槽 ​

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

更多参数与事件说明 ​

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

TreeSelect 使用原生 visible-change、remove-tag、popup-scroll 和 end-reached 名称;末端事件保留原生滚动方向类型(top/bottom/left/right),不能把 popup-scroll 改名。Tree 节点事件保留其参数;remove-tag 和节点原生载荷可包含基础层的类型键(例如数字值 1 对应 number:1),不能把它等同于规范化的 modelValue/change 值。数据包装增加 success/error,模型事件沿用本文的值/对象模式。

局部请求错误插槽 ​

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

继承能力

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

参数与事件补充说明

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

参数与事件说明

ariaLabel

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

id

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

effect

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

effect 参数与事件数据

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

枚举:"light" / "dark"

popperClass

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

popperClass 参数与事件数据

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

枚举:false

popperStyle

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

popperStyle 参数与事件数据

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

枚举:false

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

fallbackPlacements

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

offset

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

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"

popperOptions

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

popperOptions 参数与事件数据

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

  • popperOptions.placement: PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["popperOptions"]>, "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"

  • popperOptions.modifiers: PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["popperOptions"]>, "modifiers"> — 依赖声明
  • popperOptions.strategy: PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["popperOptions"]>, "strategy"> — 依赖声明

    枚举:"fixed" / "absolute"

  • popperOptions.onFirstUpdate: PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["popperOptions"]>, "onFirstUpdate"> — 依赖声明

    事件参数:(arg0: Parameters<Extract<NonNullable<PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["popperOptions"]>, "onFirstUpdate">>, (...args: never[]) => unknown>>[0]): void

showArrow

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

showArrow 参数与事件数据

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

枚举:false / true

appendTo

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

appendTo 参数与事件数据

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

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

persistent

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

persistent 参数与事件数据

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

枚举:false / true

teleported

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

teleported 参数与事件数据

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

枚举:false / true

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

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

disabled 参数与事件数据

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

枚举:false / true

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

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

size

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

size 参数与事件数据

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

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

emptyText

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

defaultExpandAll

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

defaultExpandAll 参数与事件数据

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

枚举:false / true

indent

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

props

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

props 参数与事件数据

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

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

    指定子树为节点对象的某个属性值

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

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

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

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

    事件参数:(data: AsamTreeNodeData, node: Parameters<Extract<NonNullable<PublicMember<NonNullable<AsamTreeOptionProps | undefined>, "label">>, (...args: never[]) => unknown>>[1]): string

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

    指定节点选择框是否禁用为节点对象的某个属性值

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

    事件参数:(data: AsamTreeNodeData, node: Parameters<Extract<NonNullable<PublicMember<NonNullable<AsamTreeOptionProps | undefined>, "disabled">>, (...args: never[]) => unknown>>[1]): boolean

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

    指定节点是否为叶子节点,仅在指定了 lazy 属性的情况下生效

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

    事件参数:(data: AsamTreeNodeData, node: Parameters<Extract<NonNullable<PublicMember<NonNullable<AsamTreeOptionProps | undefined>, "isLeaf">>, (...args: never[]) => unknown>>[1]): boolean

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

    自定义节点类名

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

    事件参数:(data: AsamTreeNodeData, node: Parameters<Extract<NonNullable<PublicMember<NonNullable<AsamTreeOptionProps | undefined>, "class">>, (...args: never[]) => unknown>>[1]): string | { [key: string]: boolean; }

name

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

icon

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

icon 参数与事件数据

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

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

  • icon.__isFragment: undefined — 依赖声明
  • icon.__isTeleport: undefined — 依赖声明
  • icon.__isSuspense: undefined — 依赖声明
separator

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

modelValue

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

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

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

accordion 参数与事件数据

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

枚举:false / true

loading

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

loading 参数与事件数据

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

枚举:false / true

filterMethod

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

filterMethod 参数与事件数据

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

事件参数:(query: string): void

renderAfterExpand

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

renderAfterExpand 参数与事件数据

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

枚举:false / true

nodeKey

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

checkStrictly

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

checkStrictly 参数与事件数据

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

枚举:false / true

expandOnClickNode

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

expandOnClickNode 参数与事件数据

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

枚举:false / true

checkOnClickNode

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

checkOnClickNode 参数与事件数据

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

枚举:false / true

checkOnClickLeaf

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

checkOnClickLeaf 参数与事件数据

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

枚举:false / true

checkDescendants

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

checkDescendants 参数与事件数据

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

枚举:false / true

autoExpandParent

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

autoExpandParent 参数与事件数据

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

枚举:false / true

defaultCheckedKeys

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

defaultExpandedKeys

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

currentNodeKey

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

renderContent

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

renderContent 参数与事件数据

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

事件参数:(h: Parameters<Extract<NonNullable<AsamTreeRenderContentFunction | undefined>, (...args: never[]) => unknown>>[0], context: AsamTreeRenderContentContext): VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }> | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>[]

showCheckbox

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

showCheckbox 参数与事件数据

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

枚举:false / true

draggable

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

draggable 参数与事件数据

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

枚举:false / true

allowDrag

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

allowDrag 参数与事件数据

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

事件参数:(node: Parameters<Extract<NonNullable<AsamTreeAllowDragFunction | undefined>, (...args: never[]) => unknown>>[0]): boolean

allowDrop

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

allowDrop 参数与事件数据

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

事件参数:(draggingNode: Parameters<Extract<NonNullable<AsamTreeAllowDropFunction | undefined>, (...args: never[]) => unknown>>[0], dropNode: Parameters<Extract<NonNullable<AsamTreeAllowDropFunction | undefined>, (...args: never[]) => unknown>>[1], type: AsamTreeAllowDropType): boolean

highlightCurrent

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

highlightCurrent 参数与事件数据

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

枚举:false / true

filterNodeMethod

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

filterNodeMethod 参数与事件数据

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

事件参数:(value: any, data: AsamTreeNodeData, child: Parameters<Extract<NonNullable<AsamTreeFilterNodeMethodFunction | undefined>, (...args: never[]) => unknown>>[2]): boolean

multiple

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

multiple 参数与事件数据

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

枚举:true

枚举:false

默认值与来源
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

clearable

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

clearable 参数与事件数据

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

枚举:false / true

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

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

automaticDropdown 参数与事件数据

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

枚举:false / true

clearIcon

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

clearIcon 参数与事件数据

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

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

  • clearIcon.__isFragment: undefined — 依赖声明
  • clearIcon.__isTeleport: undefined — 依赖声明
  • clearIcon.__isSuspense: undefined — 依赖声明
placeholder

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

autocomplete

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

filterable

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

filterable 参数与事件数据

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

枚举:false / true

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

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

allowCreate 参数与事件数据

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

枚举:false / true

remote

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

remote 参数与事件数据

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

枚举:false / true

debounce

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

loadingText

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

noMatchText

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

noDataText

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

remoteMethod

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

remoteMethod 参数与事件数据

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

事件参数:(query: string): void

multipleLimit

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

defaultFirstOption

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

defaultFirstOption 参数与事件数据

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

枚举:false / true

reserveKeyword

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

reserveKeyword 参数与事件数据

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

枚举:false / true

valueKey

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

collapseTags

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

collapseTags 参数与事件数据

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

枚举:false / true

collapseTagsTooltip

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

collapseTagsTooltip 参数与事件数据

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

枚举:false / true

tagTooltip

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

tagTooltip 参数与事件数据

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

  • tagTooltip.appendTo: string | HTMLElement | undefined — 上游声明

    指示 Tooltip 的内容将附加在哪一个网页元素上

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

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

  • tagTooltip.placement: PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["tagTooltip"]>, "placement"> — 上游声明

    Tooltip 组件出现的位置

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

    枚举:"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"

  • tagTooltip.fallbackPlacements: PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["tagTooltip"]>, "fallbackPlacements"> — 上游声明

    提示浮层可采用的位置列表,参阅 Popper 的 fallbackPlacements。

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

  • tagTooltip.effect: PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["tagTooltip"]>, "effect"> — 上游声明

    Tooltip 主题,内置了 dark / light 两种

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

    枚举:"light" / "dark"

  • tagTooltip.popperClass: PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["tagTooltip"]>, "popperClass"> — 上游声明

    为 Tooltip 的 popper 添加自定义类名

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

    枚举:false

  • tagTooltip.popperStyle: PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["tagTooltip"]>, "popperStyle"> — 上游声明

    为 Tooltip 的 popper 添加自定义样式

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

    枚举:false

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

  • tagTooltip.transition: string | undefined — 上游声明

    动画名称

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

  • tagTooltip.teleported: boolean | undefined — 上游声明

    是否使用 teleport。设置成 true则会被追加到 append-to 的位置

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

    枚举:false / true

  • tagTooltip.popperOptions: PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["tagTooltip"]>, "popperOptions"> — 上游声明

    Popper 配置参数。

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

    • tagTooltip.popperOptions.placement: PublicMember<NonNullable<PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["tagTooltip"]>, "popperOptions">>, "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"

    • tagTooltip.popperOptions.modifiers: PublicMember<NonNullable<PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["tagTooltip"]>, "popperOptions">>, "modifiers"> — 依赖声明
    • tagTooltip.popperOptions.strategy: PublicMember<NonNullable<PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["tagTooltip"]>, "popperOptions">>, "strategy"> — 依赖声明

      枚举:"fixed" / "absolute"

    • tagTooltip.popperOptions.onFirstUpdate: PublicMember<NonNullable<PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["tagTooltip"]>, "popperOptions">>, "onFirstUpdate"> — 依赖声明

      事件参数:(arg0: Parameters<Extract<NonNullable<PublicMember<NonNullable<PublicMember<NonNullable<(AsamDictTreeSelectProps<V, I>)["tagTooltip"]>, "popperOptions">>, "onFirstUpdate">>, (...args: never[]) => unknown>>[0]): void

  • tagTooltip.showAfter: number | undefined — 上游声明

    在触发后多久显示内容,单位毫秒

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

  • tagTooltip.hideAfter: number | undefined — 上游声明

    关闭时的延迟

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

  • tagTooltip.autoClose: number | undefined — 上游声明

    tooltip 出现后自动隐藏延时,单位毫秒

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

  • tagTooltip.offset: number | undefined — 上游声明

    Tooltip 出现位置的偏移量

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

maxCollapseTags

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

fitInputWidth

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

fitInputWidth 参数与事件数据

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

枚举:false / true

suffixIcon

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

suffixIcon 参数与事件数据

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

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

  • suffixIcon.__isFragment: undefined — 依赖声明
  • suffixIcon.__isTeleport: undefined — 依赖声明
  • suffixIcon.__isSuspense: undefined — 依赖声明
tagType

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

tagType 参数与事件数据

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

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

tagEffect

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

tagEffect 参数与事件数据

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

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

remoteShowSuffix

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

remoteShowSuffix 参数与事件数据

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

枚举:false / true

cacheData

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

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 协议
AsamDictTreeSelectProps 公开类型视图
ts
import type { Attrs, VNode, Component } from 'vue';
import type { AsamDictTreeSelectProps, AsamValue, AsamRecord, AsamHierarchyRuntimeProps, AsamControlSize, AsamTreeOptionProps, AsamTreeNodeData, AsamTreeKey, AsamTreeRenderContentFunction, AsamTreeRenderContentContext, AsamTreeAllowDragFunction, AsamTreeAllowDropFunction, AsamTreeAllowDropType, AsamTreeFilterNodeMethodFunction, AsamHierarchyOption, AsamDictValueType, AsamOptionsSource } from '@asam-ui/ui';

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

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

TreeSelect 使用基础 Select 的连字符命名,并保留 end-reached 的实际方向。

参数与事件说明

clear

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

focus

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

current-change

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

success

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

end-reached

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

change

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

error

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

update:modelValue

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

check-change

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

node-click

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

node-contextmenu

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

node-collapse

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

node-expand

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

check

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

node-drag-start

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

node-drag-end

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

node-drop

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

node-drag-leave

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

node-drag-enter

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

node-drag-over

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

blur

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

visible-change

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

remove-tag

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

popup-scroll

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

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

// AsamTreeSelectDataEmits
type PublicContract<V extends AsamValue = AsamValue, I extends object = object> = {
	"clear": (AsamTreeSelectDataEmits<V, I>)["clear"];
	"focus": [event: FocusEvent];
	"current-change": (AsamTreeSelectDataEmits<V, I>)["current-change"];
	"success": [data: readonly AsamOption<V, I>[]];
	"end-reached": [direction: AsamScrollbarDirection];
	"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];
	"check-change": [data: any, checked: boolean, indeterminate: boolean];
	"node-click": (AsamTreeSelectDataEmits<V, I>)["node-click"];
	"node-contextmenu": (AsamTreeSelectDataEmits<V, I>)["node-contextmenu"];
	"node-collapse": (AsamTreeSelectDataEmits<V, I>)["node-collapse"];
	"node-expand": (AsamTreeSelectDataEmits<V, I>)["node-expand"];
	"check": [data: any, checkedInfo: AsamTreeCheckedInfo];
	"node-drag-start": (AsamTreeSelectDataEmits<V, I>)["node-drag-start"];
	"node-drag-end": (AsamTreeSelectDataEmits<V, I>)["node-drag-end"];
	"node-drop": (AsamTreeSelectDataEmits<V, I>)["node-drop"];
	"node-drag-leave": (AsamTreeSelectDataEmits<V, I>)["node-drag-leave"];
	"node-drag-enter": (AsamTreeSelectDataEmits<V, I>)["node-drag-enter"];
	"node-drag-over": (AsamTreeSelectDataEmits<V, I>)["node-drag-over"];
	"blur": [event: FocusEvent];
	"visible-change": [visible: boolean];
	"remove-tag": [value: unknown];
	"popup-scroll": [event: { scrollTop: number; scrollLeft: number; }];
};

参数与事件说明

label

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

label 参数与事件数据

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

事件参数:(scope: Pick<any, "value" | "label"> & { index: number; }): unknown

tag

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

tag 参数与事件数据

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

事件参数:(scope: { data: AsamTreeSelectTagOption[]; selectDisabled: boolean; deleteTag: (event: MouseEvent, option: AsamTreeSelectTagOption) => void; }): unknown

prefix

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

prefix 参数与事件数据

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

事件参数:(): unknown

loading

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

loading 参数与事件数据

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

事件参数:(): unknown

footer

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

footer 参数与事件数据

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

事件参数:(): unknown

header

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

header 参数与事件数据

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

事件参数:(): unknown

empty

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

empty 参数与事件数据

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

事件参数:(): unknown

error

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

error 参数与事件数据

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

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

default

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

default 参数与事件数据

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

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

AsamTreeSelectDataSlots 公开类型视图
ts
import type { AsamTreeSelectDataSlots, AsamValue, AsamTreeSelectTagOption, AsamHierarchySlots, AsamDataError, AsamOption, AsamReloadResult, AsamTreeRenderContentContext, AsamHierarchyOption } from '@asam-ui/ui';

// AsamTreeSelectDataSlots
type PublicContract<V extends AsamValue = AsamValue, I extends object = object> = {
	"label"?: (AsamTreeSelectDataSlots<V, I>)["label"];
	"tag"?: ((scope: { data: AsamTreeSelectTagOption[]; selectDisabled: boolean; deleteTag: (event: MouseEvent, option: AsamTreeSelectTagOption) => void; }) => unknown) | undefined;
	"prefix"?: (() => unknown) | undefined;
	"loading"?: (() => unknown) | undefined;
	"footer"?: (() => unknown) | undefined;
	"header"?: (() => unknown) | undefined;
	"empty"?: (() => unknown) | undefined;
	"error"?: (AsamTreeSelectDataSlots<V, I>)["error"];
	"default"?: ((scope: Omit<Pick<AsamTreeRenderContentContext, "data" | "store" | "node"> & { option?: AsamHierarchyOption; }, "option"> & { option: AsamOption<V, I> | undefined; }) => unknown) | undefined;
};

参数与事件说明

filter

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

filter 参数与事件数据

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

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

updateKeyChildren

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

updateKeyChildren 参数与事件数据

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

事件参数:(key: AsamTreeKey, data: AsamTreeData): void

getCheckedNodes

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

getCheckedNodes 参数与事件数据

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

事件参数:(leafOnly?: boolean | undefined, includeHalfChecked?: boolean | undefined): AsamTreeNodeData[]

getCheckedKeys

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

getCheckedKeys 参数与事件数据

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

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

getCurrentNode

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

getCurrentNode 参数与事件数据

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

事件参数:(): AsamTreeNodeData | null

getCurrentKey

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

getCurrentKey 参数与事件数据

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

事件参数:(): AsamTreeKey | null

setCheckedNodes

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

setCheckedNodes 参数与事件数据

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

事件参数:(nodes: Parameters<Extract<NonNullable<(AsamDictTreeSelectExpose<V, I>)["setCheckedNodes"]>, (...args: never[]) => unknown>>[0], leafOnly?: boolean | undefined): void

setCheckedKeys

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

setCheckedKeys 参数与事件数据

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

事件参数:(keys: AsamTreeKey[], leafOnly?: boolean | undefined): void

setChecked

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

setChecked 参数与事件数据

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

事件参数:(data: AsamTreeNodeData | AsamTreeKey, checked: boolean, deep?: boolean | undefined): void

getHalfCheckedNodes

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

getHalfCheckedNodes 参数与事件数据

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

事件参数:(): AsamTreeNodeData[]

getHalfCheckedKeys

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

getHalfCheckedKeys 参数与事件数据

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

事件参数:(): AsamTreeKey[]

setCurrentNode

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

setCurrentNode 参数与事件数据

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

事件参数:(node: Parameters<Extract<NonNullable<(AsamDictTreeSelectExpose<V, I>)["setCurrentNode"]>, (...args: never[]) => unknown>>[0], shouldAutoExpandParent?: boolean | undefined): void

setCurrentKey

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

setCurrentKey 参数与事件数据

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

事件参数:(key?: AsamTreeKey | null | undefined, shouldAutoExpandParent?: boolean | undefined): void

getNode

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

getNode 参数与事件数据

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

事件参数:(data: AsamTreeNodeData | AsamTreeKey): ReturnType<Extract<NonNullable<(AsamDictTreeSelectExpose<V, I>)["getNode"]>, (...args: never[]) => unknown>>

remove

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

remove 参数与事件数据

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

事件参数:(data: Parameters<Extract<NonNullable<(AsamDictTreeSelectExpose<V, I>)["remove"]>, (...args: never[]) => unknown>>[0]): void

append

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

append 参数与事件数据

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

事件参数:(data: AsamTreeNodeData, parentNode: Parameters<Extract<NonNullable<(AsamDictTreeSelectExpose<V, I>)["append"]>, (...args: never[]) => unknown>>[1]): void

insertBefore

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

insertBefore 参数与事件数据

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

事件参数:(data: AsamTreeNodeData, refNode: Parameters<Extract<NonNullable<(AsamDictTreeSelectExpose<V, I>)["insertBefore"]>, (...args: never[]) => unknown>>[1]): void

insertAfter

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

insertAfter 参数与事件数据

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

事件参数:(data: AsamTreeNodeData, refNode: Parameters<Extract<NonNullable<(AsamDictTreeSelectExpose<V, I>)["insertAfter"]>, (...args: never[]) => unknown>>[1]): void

focus

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

focus 参数与事件数据

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

事件参数:(): void

blur

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

blur 参数与事件数据

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

事件参数:(): void

selectedLabel

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

treeRef

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

selectRef

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

reload

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

reload 参数与事件数据

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

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

cancel

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

cancel 参数与事件数据

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

事件参数:(): void

AsamDictTreeSelectExpose 公开类型视图
ts
import type { AsamDictTreeSelectExpose, AsamValue, AsamTreeFilterValue, AsamTreeKey, AsamTreeData, AsamTreeNodeData, AsamHierarchyRuntimeProps, AsamOption, AsamReloadResult } from '@asam-ui/ui';

// AsamDictTreeSelectExpose
type PublicContract<V extends AsamValue = AsamValue, I extends object = object> = {
	"filter": (value: AsamTreeFilterValue) => void;
	"updateKeyChildren": (key: AsamTreeKey, data: AsamTreeData) => void;
	"getCheckedNodes": (leafOnly?: boolean, includeHalfChecked?: boolean) => AsamTreeNodeData[];
	"getCheckedKeys": (leafOnly?: boolean) => AsamTreeKey[];
	"getCurrentNode": () => AsamTreeNodeData | null;
	"getCurrentKey": () => AsamTreeKey | null;
	"setCheckedNodes": (AsamDictTreeSelectExpose<V, I>)["setCheckedNodes"];
	"setCheckedKeys": (keys: AsamTreeKey[], leafOnly?: boolean) => void;
	"setChecked": (data: AsamTreeKey | AsamTreeNodeData, checked: boolean, deep?: boolean) => void;
	"getHalfCheckedNodes": () => AsamTreeNodeData[];
	"getHalfCheckedKeys": () => AsamTreeKey[];
	"setCurrentNode": (AsamDictTreeSelectExpose<V, I>)["setCurrentNode"];
	"setCurrentKey": (key?: AsamTreeKey | null, shouldAutoExpandParent?: boolean) => void;
	"getNode": (AsamDictTreeSelectExpose<V, I>)["getNode"];
	"remove": (AsamDictTreeSelectExpose<V, I>)["remove"];
	"append": (AsamDictTreeSelectExpose<V, I>)["append"];
	"insertBefore": (AsamDictTreeSelectExpose<V, I>)["insertBefore"];
	"insertAfter": (AsamDictTreeSelectExpose<V, I>)["insertAfter"];
	"focus": () => void;
	"blur": () => void;
	"selectedLabel": string | string[];
	"treeRef": (AsamDictTreeSelectExpose<V, I>)["treeRef"];
	"selectRef": (AsamDictTreeSelectExpose<V, I>)["selectRef"];
	"reload": (options?: { readonly force?: boolean; }) => Promise<AsamReloadResult<readonly AsamOption<V, I>[]>>;
	"cancel": () => void;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭