配置

全局配置 AsamConfigProvider

向子树提供组件配置和 ASAM 控件密度。

使用场景 ​

向子树提供组件配置和 ASAM 控件密度。

基础用法与状态 ​

下列示例只使用本入口的实际公开能力。

基础用法与状态

展开源码

使用约定 ​

size 接受 large/big/default/small,省略时保留默认密度;配置变化保持响应式。 完整说明。

完整使用场景 ​

i18n 配置 ​

通过 Config Provider 来配置多语言,让你的应用可以随时切换语言。

使用两个属性来提供 i18n 相关配置

i18n 配置

展开源码

对按钮进行配置 ​

下列完整示例包含状态与交互,源码提供 TS 和 JS 两种版本。

AsamButton 的颜色类型按显式 type、最近的 AsamButtonGroup 类型、已配置的 button.type、独立默认 secondary 依次取值。Provider 类型变化会更新未被显式属性或按钮组覆盖的子按钮。

对按钮进行配置

展开源码

对链接进行配置2.9.11 ​

下列完整示例包含状态与交互,源码提供 TS 和 JS 两种版本。

对 Card 进行配置 2.10.5 ​

下列完整示例包含状态与交互,源码提供 TS 和 JS 两种版本。

对 Card 进行配置 2.10.5

展开源码

对 Dialog 进行配置 2.10.7 ​

下列完整示例包含状态与交互,源码提供 TS 和 JS 两种版本。

对 Dialog 进行配置 2.10.7

展开源码

对消息进行配置 ​

下列完整示例包含状态与交互,源码提供 TS 和 JS 两种版本。

对消息进行配置

展开源码

空值配置2.7.0 ​

支持的组件列表
  • 级联选择器(AsamCascader)
  • 颜色选择器(AsamColorPicker) ^(2.10.3)
  • 日期选择器(AsamDatePicker)
  • 选择器(AsamSelect)
  • 虚拟化选择器(AsamSelectV2)
  • 时间选择器(AsamTimePicker)
  • 时间选择(AsamTimeSelect)
  • 树形选择器(AsamTreeSelect)

设置 empty-values 来配置组件的默认空值。默认值是 ['', null, undefined]。如果认为空字符串不是一个空值,可以设置成 [undefined, null]。

设置 value-on-clear 以设置清空选项的值。组件默认值是 undefined。在日期组件中是 null。如果想设置成 undefined,请使用 () => undefined。

native 模式保留原生清空值;默认 value 模式将单选 undefined 归一为 null。 完整说明。

空值配置2.7.0

展开源码

表格配置 2.13.3 ​

下列完整示例包含状态与交互,源码提供 TS 和 JS 两种版本。

表格配置 2.13.3

展开源码

零层级与响应式密度 ​

zIndex=0 是有效输入,省略配置仍继承上层值。密度按已冻结四档契约继承,显式 size 覆盖 provider。ConfigProvider default 插槽中的 config 是实际配置上下文,可响应更新。

零层级与响应式密度

展开源码

配置类型与本地语言包 ​

ButtonConfigContext、CardConfigContext、LinkConfigContext、TableConfigContext 分别通过 AsamConfigProvider 前缀的公开类型表示。 完整说明。

API

属性 AsamConfigProviderProps

属性名说明类型默认值
zIndex全局初始化 zIndex 的值number | undefined—
dialog对话框配置,参阅对应参数表。(AsamConfigProviderProps)["dialog"]—
button按钮配置,参阅对应参数表。(AsamConfigProviderProps)["button"]—
card—AsamCardConfigContext | undefined—
link链接配置,参阅对应参数表。AsamLinkConfigContext | undefined—
table表格配置,参阅对应参数表。AsamTableConfigContext | undefined—
emptyValues输入类组件空值unknown[] | undefined—
valueOnClear输入类组件清空值(AsamConfigProviderProps)["valueOnClear"]—
a11y—(AsamConfigProviderProps)["a11y"]false
locale翻译文本对象(AsamConfigProviderProps)["locale"]—
experimentalFeatures将要添加的实验阶段的功能,所有功能都是默认设置为 falseAsamConfigProviderExperimentalFeatures | undefined—
keyboardNavigation—(AsamConfigProviderProps)["keyboardNavigation"]false
message消息配置,参阅对应参数表。AsamMessageConfigContext | undefined—
namespace全局组件类名称前缀 (需要配合 $namespace 使用)string | undefined—
size全局组件大小enum"large" | "big" | "default" | "small"完整类型:AsamControlSize | undefined—

插槽 AsamConfigProviderSlots

属性名说明类型默认值
default—((scope: { config: AsamConfigProviderContext | undefined; }) => VNode[]) | undefined—

事件 AsamConfigProviderEmits

实例方法与状态 AsamConfigProviderExpose

类型 AsamConfigProviderInstance

类型 AsamConfigProviderContext

属性名说明类型默认值
a11y—(AsamConfigProviderContext)["a11y"]—
keyboardNavigation—(AsamConfigProviderContext)["keyboardNavigation"]—
namespace—string | undefined—
zIndex—number | undefined—
size—enum"" | "large" | "default" | "small"完整类型:(AsamConfigProviderContext)["size"]—
dialog—(AsamConfigProviderContext)["dialog"]—
button—(AsamConfigProviderContext)["button"]—
card—AsamCardConfigContext | undefined—
link—AsamLinkConfigContext | undefined—
table—AsamTableConfigContext | undefined—
emptyValues—unknown[] | undefined—
valueOnClear—(AsamConfigProviderContext)["valueOnClear"]—
locale—(AsamConfigProviderContext)["locale"]—
experimentalFeatures—AsamConfigProviderExperimentalFeatures | undefined—
message—AsamMessageConfigContext | undefined—

类型 AsamConfigProviderExperimentalFeatures

类型 AsamConfigProviderPropsPublic

属性名说明类型默认值
zIndex—number | undefined—
dialog—(AsamConfigProviderPropsPublic)["dialog"]—
button—(AsamConfigProviderPropsPublic)["button"]—
card—AsamCardConfigContext | undefined—
link—AsamLinkConfigContext | undefined—
table—AsamTableConfigContext | undefined—
emptyValues—unknown[] | undefined—
valueOnClear—(AsamConfigProviderPropsPublic)["valueOnClear"]—
a11y—(AsamConfigProviderPropsPublic)["a11y"]—
locale—(AsamConfigProviderPropsPublic)["locale"]—
experimentalFeatures—AsamConfigProviderExperimentalFeatures | undefined—
keyboardNavigation—(AsamConfigProviderPropsPublic)["keyboardNavigation"]—
message—AsamMessageConfigContext | undefined—
namespace—string | undefined—
size—enum"large" | "big" | "default" | "small"完整类型:AsamControlSize | undefined—

类型 AsamConfigProviderButtonConfigContext

属性名说明类型默认值
type—enum"" | "default" | "text" | "primary" | "success" | "danger" | "warning" | "info"完整类型:"" | "default" | "text" | "primary" | "success" | "danger" | "warning" | "info" | undefined—
plain—boolean | undefined—
text—boolean | undefined—
round—boolean | undefined—
dashed—boolean | undefined—
autoInsertSpace—boolean | undefined—

类型 AsamConfigProviderCardConfigContext

属性名说明类型默认值
shadow—enum"hover" | "always" | "never"完整类型:"hover" | "always" | "never" | undefined—

类型 AsamConfigProviderLinkConfigContext

属性名说明类型默认值
type—enum"default" | "primary" | "success" | "danger" | "warning" | "info"完整类型:"default" | "primary" | "success" | "danger" | "warning" | "info" | undefined—
underline—enum"hover" | "always" | "never"完整类型:boolean | "hover" | "always" | "never" | undefined—

类型 AsamConfigProviderTableConfigContext

属性名说明类型默认值
showOverflowTooltip—(AsamConfigProviderTableConfigContext)["showOverflowTooltip"]—
tooltipEffect—string | undefined—
tooltipOptions—(AsamConfigProviderTableConfigContext)["tooltipOptions"]—
tooltipFormatter—AsamTableOverflowTooltipFormatter<any> | undefined—

用法与契约补充说明 ​

使用约定 ​

size 接受 large/big/default/small,省略时保留默认密度;配置变化保持响应式。子控件显式 size 优先于最近 group、Form、ConfigProvider。locale、namespace、zIndex、button、message 等配置以公开 Props 为准;它提供上下文,不直接请求业务数据。default 插槽提供真实配置上下文,无业务事件。

配置类型与本地语言包 ​

ButtonConfigContext、CardConfigContext、LinkConfigContext、TableConfigContext 分别通过 AsamConfigProvider 前缀的公开类型表示。配置表与示例直接引用这些类型。语言示例从同一个包导入 asamLocaleEn 和 asamLocaleZhCn,既可切换 locale,也可传入符合 locale 参数的其他语言对象。

更多参数与事件说明 ​

空值配置2.7.0 ​

本例第二个 AsamSelectV2 使用 value-mode="native",保留组件覆盖全局配置后清空为 undefined 的原生值语义;第一个 AsamSelect 仍按 provider 配置清空为 null。AsamSelectV2 默认的 value 模式会将单选清空的 undefined 归一为 null,需要原生清空值时显式选择 native 模式。

参数与事件补充说明

完整基础 API,并支持 ASAM 四档尺寸继承。

参数与事件说明

zIndex

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

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

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

dialog

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

dialog 参数与事件数据

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

  • dialog.alignCenter: boolean | undefined — 上游声明

    是否水平垂直对齐对话框

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

    枚举:false / true

  • dialog.draggable: boolean | undefined — 上游声明

    为 Dialog 启用可拖拽功能

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

    枚举:false / true

  • dialog.overflow: boolean | undefined — 上游声明

    拖动范围可以超出可视区

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

    枚举:false / true

  • dialog.transition: AsamDialogTransition — 上游声明

    对话框动画的自定义过渡配置。可以是一个字符串(过渡名称),也可以是一个包含 Vue 过渡属性的对象。

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

    • dialog.transition.name: string | undefined — 依赖声明
    • dialog.transition.type: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "type"> — 依赖声明

      枚举:"transition" / "animation"

    • dialog.transition.css: boolean | undefined — 依赖声明

      枚举:false / true

    • dialog.transition.duration: number | { enter: number; leave: number; } | undefined — 依赖声明
      • dialog.transition.duration.enter: number — 依赖声明

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • dialog.transition.duration.leave: number — 依赖声明

        嵌套展开边界:深度上限;完整类型见公开类型视图。

    • dialog.transition.enterFromClass: string | undefined — 依赖声明
    • dialog.transition.enterActiveClass: string | undefined — 依赖声明
    • dialog.transition.enterToClass: string | undefined — 依赖声明
    • dialog.transition.appearFromClass: string | undefined — 依赖声明
    • dialog.transition.appearActiveClass: string | undefined — 依赖声明
    • dialog.transition.appearToClass: string | undefined — 依赖声明
    • dialog.transition.leaveFromClass: string | undefined — 依赖声明
    • dialog.transition.leaveActiveClass: string | undefined — 依赖声明
    • dialog.transition.leaveToClass: string | undefined — 依赖声明
    • dialog.transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

      枚举:"default" / "in-out" / "out-in"

    • dialog.transition.appear: boolean | undefined — 依赖声明

      枚举:false / true

    • dialog.transition.persisted: boolean | undefined — 依赖声明

      枚举:false / true

    • dialog.transition.onBeforeEnter: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "onBeforeEnter"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onEnter: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "onEnter"> — 依赖声明

      事件参数:(el: Element, done: () => void): void

    • dialog.transition.onAfterEnter: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "onAfterEnter"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onEnterCancelled: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "onEnterCancelled"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onBeforeLeave: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "onBeforeLeave"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onLeave: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "onLeave"> — 依赖声明

      事件参数:(el: Element, done: () => void): void

    • dialog.transition.onAfterLeave: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "onAfterLeave"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onLeaveCancelled: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "onLeaveCancelled"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onBeforeAppear: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "onBeforeAppear"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onAppear: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "onAppear"> — 依赖声明

      事件参数:(el: Element, done: () => void): void

    • dialog.transition.onAfterAppear: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "onAfterAppear"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onAppearCancelled: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderProps)["dialog"]>, "transition">>, "onAppearCancelled"> — 依赖声明

      事件参数:(el: Element): void

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

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

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

button

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

button 参数与事件数据

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

  • button.type: "" | "default" | "text" | "primary" | "success" | "danger" | "warning" | "info" | undefined — 上游声明

    类型

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

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

  • button.plain: boolean | undefined — 上游声明

    是否纯色

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

    枚举:false / true

  • button.text: boolean | undefined — 上游声明

    是否为文字按钮

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

    枚举:false / true

  • button.round: boolean | undefined — 上游声明

    是否为圆角按钮

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

    枚举:false / true

  • button.dashed: boolean | undefined — 上游声明

    是否是虚线按钮

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

    枚举:false / true

  • button.autoInsertSpace: boolean | undefined — 上游声明

    两个中文字符之间自动插入空格(仅当文本长度为 2 且所有字符均为中文时才生效)

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

    枚举:false / true

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

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

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

card

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

card 参数与事件数据

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

  • card.shadow: "hover" | "always" | "never" | undefined — 上游声明

    设置阴影显示时机

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

    枚举:"hover" / "always" / "never"

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

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

link

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

link 参数与事件数据

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

  • link.type: "default" | "primary" | "success" | "danger" | "warning" | "info" | undefined — 上游声明

    类型

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

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

  • link.underline: boolean | "hover" | "always" | "never" | undefined — 上游声明

    控制下划线是否出现

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

    枚举:false / true / "hover" / "always" / "never"

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

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

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

table

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

table 参数与事件数据

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

  • table.showOverflowTooltip: AsamConfigProviderTableConfigContext["showOverflowTooltip"] — 上游声明

    当内容过长被隐藏时显示 tooltip

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

    枚举:false / true

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

  • table.tooltipEffect: string | undefined — 上游声明

    溢出的 tooltip 的 effect

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

  • table.tooltipOptions: AsamConfigProviderTableConfigContext["tooltipOptions"] — 上游声明

    溢出提示配置,参阅提示组件参数。

    固定上游文档默认:^[object]`{ enterable: true, placement: 'top', showArrow: true, hideAfter: 200, popperOptions: { strategy: 'fixed' } }`(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

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

  • table.tooltipFormatter: AsamTableOverflowTooltipFormatter<any> | undefined — 上游声明

    使用 show-overflow-tooltip 时自定义 tooltip 内容

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

    事件参数:(data: { row: any; column: AsamTableColumnCtx<any>; cellValue: any; }): string | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>

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

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

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

emptyValues

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

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

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

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

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

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

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

a11y

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

a11y 参数与事件数据

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

枚举:false / true

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

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

locale

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

locale 参数与事件数据

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

  • locale.name: string — 上游声明
  • locale.el: PublicMember<NonNullable<(AsamConfigProviderProps)["locale"]>, "el"> — 上游声明
默认值与来源
未知 / 未声明

固定上游文档默认:原始表达式见机器资料(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

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

experimentalFeatures

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

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

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

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

keyboardNavigation

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

keyboardNavigation 参数与事件数据

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

枚举:false / true

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

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

message

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

message 参数与事件数据

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

  • message.max: number | undefined — 上游声明

    可同时显示的消息最大数量

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

  • message.grouping: boolean | undefined — 上游声明

    合并内容相同的消息,不支持 VNode 类型的消息

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

    枚举:false / true

  • message.duration: number | undefined — 上游声明

    显示时间,单位为毫秒。设为 0 则不会自动关闭

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

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

    Message 距离窗口顶部的偏移量

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

  • message.showClose: boolean | undefined — 上游声明

    是否显示关闭按钮

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

    枚举:false / true

  • message.plain: boolean | undefined — 上游声明

    是否纯色

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

    枚举:false / true

  • message.placement: string | undefined — 上游声明

    消息放置位置

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

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

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

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

namespace

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

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

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

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

size

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

size 参数与事件数据

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

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

AsamConfigProviderProps 公开类型视图
ts
import type { VNode } from 'vue';
import type { AsamConfigProviderProps, AsamConfigProviderButtonConfigContext, AsamDialogTransition, AsamCardConfigContext, AsamConfigProviderCardConfigContext, AsamLinkConfigContext, AsamConfigProviderLinkConfigContext, AsamTableConfigContext, AsamConfigProviderTableConfigContext, AsamTableOverflowTooltipFormatter, AsamTableColumnCtx, AsamConfigProviderExperimentalFeatures, AsamMessageConfigContext, AsamControlSize } from '@asam-ui/ui';

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

// AsamConfigProviderProps
type PublicContract = {
	readonly "zIndex"?: number | undefined;
	readonly "dialog"?: (AsamConfigProviderProps)["dialog"];
	readonly "button"?: (AsamConfigProviderProps)["button"];
	readonly "card"?: AsamCardConfigContext | undefined;
	readonly "link"?: AsamLinkConfigContext | undefined;
	readonly "table"?: AsamTableConfigContext | undefined;
	readonly "emptyValues"?: unknown[] | undefined;
	readonly "valueOnClear"?: (AsamConfigProviderProps)["valueOnClear"];
	readonly "a11y"?: (AsamConfigProviderProps)["a11y"];
	readonly "locale"?: (AsamConfigProviderProps)["locale"];
	readonly "experimentalFeatures"?: AsamConfigProviderExperimentalFeatures | undefined;
	readonly "keyboardNavigation"?: (AsamConfigProviderProps)["keyboardNavigation"];
	readonly "message"?: AsamMessageConfigContext | undefined;
	readonly "namespace"?: string | undefined;
	"size"?: AsamControlSize | undefined;
};

参数与事件说明

default

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

default 参数与事件数据

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

事件参数:(scope: { config: AsamConfigProviderContext | undefined; }): VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>[]

AsamConfigProviderSlots 公开类型视图
ts
import type { VNode } from 'vue';
import type { AsamConfigProviderSlots, AsamConfigProviderContext } from '@asam-ui/ui';

// AsamConfigProviderSlots
type PublicContract = {
	"default"?: ((scope: { config: AsamConfigProviderContext | undefined; }) => VNode[]) | undefined;
};
AsamConfigProviderEmits 公开类型视图
ts
import type { AsamConfigProviderEmits } from '@asam-ui/ui';

// AsamConfigProviderEmits
type PublicContract = AsamConfigProviderEmits;
AsamConfigProviderExpose 公开类型视图
ts
import type { AsamConfigProviderExpose } from '@asam-ui/ui';

// AsamConfigProviderExpose
type PublicContract = AsamConfigProviderExpose;
AsamConfigProviderInstance 公开类型视图
ts
import type { AsamConfigProviderInstance } from '@asam-ui/ui';

// AsamConfigProviderInstance
type PublicContract = AsamConfigProviderInstance;

参数与事件说明

a11y

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

a11y 参数与事件数据

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

枚举:false / true

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

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

keyboardNavigation

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

keyboardNavigation 参数与事件数据

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

枚举:false / true

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

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

namespace

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

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

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

zIndex

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

size

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

size 参数与事件数据

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

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

dialog

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

dialog 参数与事件数据

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

  • dialog.alignCenter: boolean | undefined — 上游声明

    是否水平垂直对齐对话框

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

    枚举:false / true

  • dialog.draggable: boolean | undefined — 上游声明

    为 Dialog 启用可拖拽功能

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

    枚举:false / true

  • dialog.overflow: boolean | undefined — 上游声明

    拖动范围可以超出可视区

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

    枚举:false / true

  • dialog.transition: AsamDialogTransition — 上游声明

    对话框动画的自定义过渡配置。可以是一个字符串(过渡名称),也可以是一个包含 Vue 过渡属性的对象。

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

    • dialog.transition.name: string | undefined — 依赖声明
    • dialog.transition.type: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "type"> — 依赖声明

      枚举:"transition" / "animation"

    • dialog.transition.css: boolean | undefined — 依赖声明

      枚举:false / true

    • dialog.transition.duration: number | { enter: number; leave: number; } | undefined — 依赖声明
      • dialog.transition.duration.enter: number — 依赖声明

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • dialog.transition.duration.leave: number — 依赖声明

        嵌套展开边界:深度上限;完整类型见公开类型视图。

    • dialog.transition.enterFromClass: string | undefined — 依赖声明
    • dialog.transition.enterActiveClass: string | undefined — 依赖声明
    • dialog.transition.enterToClass: string | undefined — 依赖声明
    • dialog.transition.appearFromClass: string | undefined — 依赖声明
    • dialog.transition.appearActiveClass: string | undefined — 依赖声明
    • dialog.transition.appearToClass: string | undefined — 依赖声明
    • dialog.transition.leaveFromClass: string | undefined — 依赖声明
    • dialog.transition.leaveActiveClass: string | undefined — 依赖声明
    • dialog.transition.leaveToClass: string | undefined — 依赖声明
    • dialog.transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

      枚举:"default" / "in-out" / "out-in"

    • dialog.transition.appear: boolean | undefined — 依赖声明

      枚举:false / true

    • dialog.transition.persisted: boolean | undefined — 依赖声明

      枚举:false / true

    • dialog.transition.onBeforeEnter: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "onBeforeEnter"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onEnter: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "onEnter"> — 依赖声明

      事件参数:(el: Element, done: () => void): void

    • dialog.transition.onAfterEnter: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "onAfterEnter"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onEnterCancelled: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "onEnterCancelled"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onBeforeLeave: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "onBeforeLeave"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onLeave: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "onLeave"> — 依赖声明

      事件参数:(el: Element, done: () => void): void

    • dialog.transition.onAfterLeave: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "onAfterLeave"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onLeaveCancelled: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "onLeaveCancelled"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onBeforeAppear: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "onBeforeAppear"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onAppear: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "onAppear"> — 依赖声明

      事件参数:(el: Element, done: () => void): void

    • dialog.transition.onAfterAppear: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "onAfterAppear"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onAppearCancelled: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderContext)["dialog"]>, "transition">>, "onAppearCancelled"> — 依赖声明

      事件参数:(el: Element): void

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

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

button

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

button 参数与事件数据

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

  • button.type: "" | "default" | "text" | "primary" | "success" | "danger" | "warning" | "info" | undefined — 上游声明

    类型

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

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

  • button.plain: boolean | undefined — 上游声明

    是否纯色

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

    枚举:false / true

  • button.text: boolean | undefined — 上游声明

    是否为文字按钮

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

    枚举:false / true

  • button.round: boolean | undefined — 上游声明

    是否为圆角按钮

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

    枚举:false / true

  • button.dashed: boolean | undefined — 上游声明

    是否是虚线按钮

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

    枚举:false / true

  • button.autoInsertSpace: boolean | undefined — 上游声明

    两个中文字符之间自动插入空格(仅当文本长度为 2 且所有字符均为中文时才生效)

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

    枚举:false / true

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

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

card

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

card 参数与事件数据

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

  • card.shadow: "hover" | "always" | "never" | undefined — 上游声明

    设置阴影显示时机

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

    枚举:"hover" / "always" / "never"

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

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

link

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

link 参数与事件数据

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

  • link.type: "default" | "primary" | "success" | "danger" | "warning" | "info" | undefined — 上游声明

    类型

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

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

  • link.underline: boolean | "hover" | "always" | "never" | undefined — 上游声明

    控制下划线是否出现

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

    枚举:false / true / "hover" / "always" / "never"

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

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

table

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

table 参数与事件数据

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

  • table.showOverflowTooltip: AsamConfigProviderTableConfigContext["showOverflowTooltip"] — 上游声明

    当内容过长被隐藏时显示 tooltip

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

    枚举:false / true

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

  • table.tooltipEffect: string | undefined — 上游声明

    溢出的 tooltip 的 effect

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

  • table.tooltipOptions: AsamConfigProviderTableConfigContext["tooltipOptions"] — 上游声明

    溢出提示配置,参阅提示组件参数。

    固定上游文档默认:^[object]`{ enterable: true, placement: 'top', showArrow: true, hideAfter: 200, popperOptions: { strategy: 'fixed' } }`(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

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

  • table.tooltipFormatter: AsamTableOverflowTooltipFormatter<any> | undefined — 上游声明

    使用 show-overflow-tooltip 时自定义 tooltip 内容

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

    事件参数:(data: { row: any; column: AsamTableColumnCtx<any>; cellValue: any; }): string | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>

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

固定上游源码未声明 default(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

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

locale

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

locale 参数与事件数据

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

  • locale.name: string — 上游声明
  • locale.el: PublicMember<NonNullable<(AsamConfigProviderContext)["locale"]>, "el"> — 上游声明
默认值与来源
未知 / 未声明

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

experimentalFeatures

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

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

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

message

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

message 参数与事件数据

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

  • message.max: number | undefined — 上游声明

    可同时显示的消息最大数量

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

  • message.grouping: boolean | undefined — 上游声明

    合并内容相同的消息,不支持 VNode 类型的消息

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

    枚举:false / true

  • message.duration: number | undefined — 上游声明

    显示时间,单位为毫秒。设为 0 则不会自动关闭

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

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

    Message 距离窗口顶部的偏移量

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

  • message.showClose: boolean | undefined — 上游声明

    是否显示关闭按钮

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

    枚举:false / true

  • message.plain: boolean | undefined — 上游声明

    是否纯色

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

    枚举:false / true

  • message.placement: string | undefined — 上游声明

    消息放置位置

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

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

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

AsamConfigProviderContext 公开类型视图
ts
import type { VNode } from 'vue';
import type { AsamConfigProviderContext, AsamConfigProviderProps, AsamConfigProviderButtonConfigContext, AsamDialogTransition, AsamCardConfigContext, AsamConfigProviderCardConfigContext, AsamLinkConfigContext, AsamConfigProviderLinkConfigContext, AsamTableConfigContext, AsamConfigProviderTableConfigContext, AsamTableOverflowTooltipFormatter, AsamTableColumnCtx, AsamConfigProviderExperimentalFeatures, AsamMessageConfigContext } from '@asam-ui/ui';

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

// AsamConfigProviderContext
type PublicContract = {
	readonly "a11y"?: (AsamConfigProviderContext)["a11y"];
	readonly "keyboardNavigation"?: (AsamConfigProviderContext)["keyboardNavigation"];
	readonly "namespace"?: string | undefined;
	readonly "zIndex"?: number | undefined;
	readonly "size"?: (AsamConfigProviderContext)["size"];
	readonly "dialog"?: (AsamConfigProviderContext)["dialog"];
	readonly "button"?: (AsamConfigProviderContext)["button"];
	readonly "card"?: AsamCardConfigContext | undefined;
	readonly "link"?: AsamLinkConfigContext | undefined;
	readonly "table"?: AsamTableConfigContext | undefined;
	readonly "emptyValues"?: unknown[] | undefined;
	readonly "valueOnClear"?: (AsamConfigProviderContext)["valueOnClear"];
	readonly "locale"?: (AsamConfigProviderContext)["locale"];
	readonly "experimentalFeatures"?: AsamConfigProviderExperimentalFeatures | undefined;
	readonly "message"?: AsamMessageConfigContext | undefined;
};
AsamConfigProviderExperimentalFeatures 公开类型视图
ts
import type { AsamConfigProviderExperimentalFeatures } from '@asam-ui/ui';

// AsamConfigProviderExperimentalFeatures
type PublicContract = AsamConfigProviderExperimentalFeatures;

参数与事件说明

zIndex

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

dialog

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

dialog 参数与事件数据

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

  • dialog.alignCenter: boolean | undefined — 上游声明

    是否水平垂直对齐对话框

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

    枚举:false / true

  • dialog.draggable: boolean | undefined — 上游声明

    为 Dialog 启用可拖拽功能

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

    枚举:false / true

  • dialog.overflow: boolean | undefined — 上游声明

    拖动范围可以超出可视区

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

    枚举:false / true

  • dialog.transition: AsamDialogTransition — 上游声明

    对话框动画的自定义过渡配置。可以是一个字符串(过渡名称),也可以是一个包含 Vue 过渡属性的对象。

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

    • dialog.transition.name: string | undefined — 依赖声明
    • dialog.transition.type: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "type"> — 依赖声明

      枚举:"transition" / "animation"

    • dialog.transition.css: boolean | undefined — 依赖声明

      枚举:false / true

    • dialog.transition.duration: number | { enter: number; leave: number; } | undefined — 依赖声明
      • dialog.transition.duration.enter: number — 依赖声明

        嵌套展开边界:深度上限;完整类型见公开类型视图。

      • dialog.transition.duration.leave: number — 依赖声明

        嵌套展开边界:深度上限;完整类型见公开类型视图。

    • dialog.transition.enterFromClass: string | undefined — 依赖声明
    • dialog.transition.enterActiveClass: string | undefined — 依赖声明
    • dialog.transition.enterToClass: string | undefined — 依赖声明
    • dialog.transition.appearFromClass: string | undefined — 依赖声明
    • dialog.transition.appearActiveClass: string | undefined — 依赖声明
    • dialog.transition.appearToClass: string | undefined — 依赖声明
    • dialog.transition.leaveFromClass: string | undefined — 依赖声明
    • dialog.transition.leaveActiveClass: string | undefined — 依赖声明
    • dialog.transition.leaveToClass: string | undefined — 依赖声明
    • dialog.transition.mode: "default" | "in-out" | "out-in" | undefined — 依赖声明

      枚举:"default" / "in-out" / "out-in"

    • dialog.transition.appear: boolean | undefined — 依赖声明

      枚举:false / true

    • dialog.transition.persisted: boolean | undefined — 依赖声明

      枚举:false / true

    • dialog.transition.onBeforeEnter: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "onBeforeEnter"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onEnter: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "onEnter"> — 依赖声明

      事件参数:(el: Element, done: () => void): void

    • dialog.transition.onAfterEnter: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "onAfterEnter"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onEnterCancelled: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "onEnterCancelled"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onBeforeLeave: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "onBeforeLeave"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onLeave: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "onLeave"> — 依赖声明

      事件参数:(el: Element, done: () => void): void

    • dialog.transition.onAfterLeave: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "onAfterLeave"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onLeaveCancelled: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "onLeaveCancelled"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onBeforeAppear: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "onBeforeAppear"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onAppear: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "onAppear"> — 依赖声明

      事件参数:(el: Element, done: () => void): void

    • dialog.transition.onAfterAppear: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "onAfterAppear"> — 依赖声明

      事件参数:(el: Element): void

    • dialog.transition.onAppearCancelled: PublicMember<NonNullable<PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["dialog"]>, "transition">>, "onAppearCancelled"> — 依赖声明

      事件参数:(el: Element): void

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

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

button

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

button 参数与事件数据

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

  • button.type: "" | "default" | "text" | "primary" | "success" | "danger" | "warning" | "info" | undefined — 上游声明

    类型

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

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

  • button.plain: boolean | undefined — 上游声明

    是否纯色

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

    枚举:false / true

  • button.text: boolean | undefined — 上游声明

    是否为文字按钮

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

    枚举:false / true

  • button.round: boolean | undefined — 上游声明

    是否为圆角按钮

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

    枚举:false / true

  • button.dashed: boolean | undefined — 上游声明

    是否是虚线按钮

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

    枚举:false / true

  • button.autoInsertSpace: boolean | undefined — 上游声明

    两个中文字符之间自动插入空格(仅当文本长度为 2 且所有字符均为中文时才生效)

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

    枚举:false / true

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

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

card

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

card 参数与事件数据

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

  • card.shadow: "hover" | "always" | "never" | undefined — 上游声明

    设置阴影显示时机

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

    枚举:"hover" / "always" / "never"

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

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

link

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

link 参数与事件数据

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

  • link.type: "default" | "primary" | "success" | "danger" | "warning" | "info" | undefined — 上游声明

    类型

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

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

  • link.underline: boolean | "hover" | "always" | "never" | undefined — 上游声明

    控制下划线是否出现

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

    枚举:false / true / "hover" / "always" / "never"

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

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

table

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

table 参数与事件数据

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

  • table.showOverflowTooltip: AsamConfigProviderTableConfigContext["showOverflowTooltip"] — 上游声明

    当内容过长被隐藏时显示 tooltip

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

    枚举:false / true

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

  • table.tooltipEffect: string | undefined — 上游声明

    溢出的 tooltip 的 effect

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

  • table.tooltipOptions: AsamConfigProviderTableConfigContext["tooltipOptions"] — 上游声明

    溢出提示配置,参阅提示组件参数。

    固定上游文档默认:^[object]`{ enterable: true, placement: 'top', showArrow: true, hideAfter: 200, popperOptions: { strategy: 'fixed' } }`(2.14.7;文档事实,实际默认以 ASAM 源码 / 安装包为准)

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

  • table.tooltipFormatter: AsamTableOverflowTooltipFormatter<any> | undefined — 上游声明

    使用 show-overflow-tooltip 时自定义 tooltip 内容

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

    事件参数:(data: { row: any; column: AsamTableColumnCtx<any>; cellValue: any; }): string | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>

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

固定上游源码未声明 default(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

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

a11y

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

a11y 参数与事件数据

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

枚举:false / true

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

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

locale

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

locale 参数与事件数据

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

  • locale.name: string — 上游声明
  • locale.el: PublicMember<NonNullable<(AsamConfigProviderPropsPublic)["locale"]>, "el"> — 上游声明
默认值与来源
未知 / 未声明

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

experimentalFeatures

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

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

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

keyboardNavigation

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

keyboardNavigation 参数与事件数据

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

枚举:false / true

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

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

message

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

message 参数与事件数据

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

  • message.max: number | undefined — 上游声明

    可同时显示的消息最大数量

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

  • message.grouping: boolean | undefined — 上游声明

    合并内容相同的消息,不支持 VNode 类型的消息

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

    枚举:false / true

  • message.duration: number | undefined — 上游声明

    显示时间,单位为毫秒。设为 0 则不会自动关闭

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

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

    Message 距离窗口顶部的偏移量

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

  • message.showClose: boolean | undefined — 上游声明

    是否显示关闭按钮

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

    枚举:false / true

  • message.plain: boolean | undefined — 上游声明

    是否纯色

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

    枚举:false / true

  • message.placement: string | undefined — 上游声明

    消息放置位置

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

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

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

namespace

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

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

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

size

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

size 参数与事件数据

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

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

AsamConfigProviderPropsPublic 公开类型视图
ts
import type { VNode } from 'vue';
import type { AsamConfigProviderPropsPublic, AsamConfigProviderProps, AsamConfigProviderButtonConfigContext, AsamDialogTransition, AsamCardConfigContext, AsamConfigProviderCardConfigContext, AsamLinkConfigContext, AsamConfigProviderLinkConfigContext, AsamTableConfigContext, AsamConfigProviderTableConfigContext, AsamTableOverflowTooltipFormatter, AsamTableColumnCtx, AsamConfigProviderExperimentalFeatures, AsamMessageConfigContext, AsamControlSize } from '@asam-ui/ui';

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

// AsamConfigProviderPropsPublic
type PublicContract = {
	readonly "zIndex"?: number | undefined;
	readonly "dialog"?: (AsamConfigProviderPropsPublic)["dialog"];
	readonly "button"?: (AsamConfigProviderPropsPublic)["button"];
	readonly "card"?: AsamCardConfigContext | undefined;
	readonly "link"?: AsamLinkConfigContext | undefined;
	readonly "table"?: AsamTableConfigContext | undefined;
	readonly "emptyValues"?: unknown[] | undefined;
	readonly "valueOnClear"?: (AsamConfigProviderPropsPublic)["valueOnClear"];
	readonly "a11y"?: (AsamConfigProviderPropsPublic)["a11y"];
	readonly "locale"?: (AsamConfigProviderPropsPublic)["locale"];
	readonly "experimentalFeatures"?: AsamConfigProviderExperimentalFeatures | undefined;
	readonly "keyboardNavigation"?: (AsamConfigProviderPropsPublic)["keyboardNavigation"];
	readonly "message"?: AsamMessageConfigContext | undefined;
	readonly "namespace"?: string | undefined;
	"size"?: AsamControlSize | undefined;
};

参数与事件说明

type

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

type 参数与事件数据

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

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

plain

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

plain 参数与事件数据

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

枚举:false / true

text

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

text 参数与事件数据

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

枚举:false / true

round

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

round 参数与事件数据

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

枚举:false / true

dashed

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

dashed 参数与事件数据

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

枚举:false / true

autoInsertSpace

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

autoInsertSpace 参数与事件数据

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

枚举:false / true

AsamConfigProviderButtonConfigContext 公开类型视图
ts
import type { AsamConfigProviderButtonConfigContext } from '@asam-ui/ui';

// AsamConfigProviderButtonConfigContext
type PublicContract = {
	"type"?: "" | "default" | "text" | "primary" | "success" | "danger" | "warning" | "info" | undefined;
	"plain"?: boolean | undefined;
	"text"?: boolean | undefined;
	"round"?: boolean | undefined;
	"dashed"?: boolean | undefined;
	"autoInsertSpace"?: boolean | undefined;
};

参数与事件说明

shadow

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

shadow 参数与事件数据

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

枚举:"hover" / "always" / "never"

AsamConfigProviderCardConfigContext 公开类型视图
ts
import type { AsamConfigProviderCardConfigContext } from '@asam-ui/ui';

// AsamConfigProviderCardConfigContext
type PublicContract = {
	"shadow"?: "hover" | "always" | "never" | undefined;
};

参数与事件说明

type

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

type 参数与事件数据

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

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

underline

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

underline 参数与事件数据

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

枚举:false / true / "hover" / "always" / "never"

AsamConfigProviderLinkConfigContext 公开类型视图
ts
import type { AsamConfigProviderLinkConfigContext } from '@asam-ui/ui';

// AsamConfigProviderLinkConfigContext
type PublicContract = {
	"type"?: "default" | "primary" | "success" | "danger" | "warning" | "info" | undefined;
	"underline"?: boolean | "hover" | "always" | "never" | undefined;
};

参数与事件说明

showOverflowTooltip

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

showOverflowTooltip 参数与事件数据

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

枚举:false / true

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

tooltipEffect

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

tooltipOptions

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

tooltipOptions 参数与事件数据

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

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

tooltipFormatter

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

tooltipFormatter 参数与事件数据

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

事件参数:(data: { row: any; column: AsamTableColumnCtx<any>; cellValue: any; }): string | VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>

AsamConfigProviderTableConfigContext 公开类型视图
ts
import type { VNode } from 'vue';
import type { AsamConfigProviderTableConfigContext, AsamConfigProviderProps, AsamTableOverflowTooltipFormatter, AsamTableColumnCtx } from '@asam-ui/ui';

// AsamConfigProviderTableConfigContext
type PublicContract = {
	"showOverflowTooltip"?: (AsamConfigProviderTableConfigContext)["showOverflowTooltip"];
	"tooltipEffect"?: string | undefined;
	"tooltipOptions"?: (AsamConfigProviderTableConfigContext)["tooltipOptions"];
	"tooltipFormatter"?: AsamTableOverflowTooltipFormatter<any> | undefined;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭