基础输入与操作

提及输入 AsamMention

在文本中通过触发字符选择人员或主题。

使用场景 ​

用于评论、消息中的 @人员、#主题等提及,模型保存完整输入内容。 完整说明。

触发与选择 ​

输入 @ 后显示候选。select 同时返回选项与触发字符,search 返回检索片段与字符。

触发与选择

展开源码

多触发字符与自定义标签 ​

prefix 可使用一个字符或字符数组,每项必须恰好一个字符;split 也必须是单字符。label 插槽接收 item、index。

多触发字符与自定义标签

展开源码

多行提及与公开状态 ​

提及场景自身支持 textarea 类型和 autosize;普通多行文本请使用专用 Textarea。实例公开 input、tooltip、dropdownVisible。

多行提及与公开状态

展开源码

四档密度与继承 ​

large / big / default / small 分别为四档密度。显式 size 覆盖继承;省略 size 时按组件、组、表单、ConfigProvider 到 default 解析。通过切换 provider 验证继承响应。

四档密度与继承

展开源码

ASAM 扩展与迁移 ​

ASAM 四档 size 继承适用于提及控件。whole/checkIsWhole 控制退格整项删除,filterOption 可自定义检索,props 可映射自定义选项字段;loading/loading 插槽由应用驱动。密码职责见 Password,普通单行和多行分别见 Input、Textarea。

选项字段映射与异步加载 ​

props 映射 value/label/disabled 字段,select 返回原始选项。应用维护 options/loading;未配置 filterOption 时按 label 或 value 默认过滤,显式 false 关闭过滤。远程结果应丢弃过期请求;loading 插槽展示加载状态。

应用异步选项与字段映射

展开源码

组合输入与 input 事件 ​

input 的 payload 为字符串;compositionstart/update/end 为原生 CompositionEvent,由实际 input/textarea 传入。组合输入阶段不应提前提交尚未完成的内容。此处示例可用于目标操作系统输入法验证。

组合输入与完整事件负载

展开源码

完整继承输入事件 ​

提及事件与原生输入事件分别透传,模型更新可能包含字符串或数字。 完整说明。

完整继承输入事件

展开源码

readonly 与 disabled 原样传给原生。候选选择、clear、whole-remove 及继承输入事件不由 ASAM 再次过滤,公开实例行为以原生结果为准。

表单与整项删除 ​

提及的表单语义承接输入框:disabled 继承、validateEvent 控制 change/blur 校验。whole 整项删除可以通过 checkIsWhole 缩小允许删除的 token。prefix 多触发字符各为单字符,split 为单字符。

提及与表单校验

展开源码

API 阅读方式 ​

下方 API 来自当前公开类型与运行默认值。默认值标为“未知 / 未声明”时,不代表 false、空值或未支持。省略 size 保留祖先上下文继承。省略 disabled 保留表单禁用继承;validateEvent 控制校验事件,不用 disabled 代替。

完整继承输入组合 ​

min/max/step、formatter/parser、modelModifiers 与 textarea 参数原样交给 底层输入。 完整说明。

完整继承输入组合

展开源码

实际单行装饰槽与嵌套输入实例 ​

下方完整 TS/JS 示例同时实例化单行与多行 Mention。单行实际展示 prefix、suffix、prepend、append、password-icon 五槽,点击密码图标观察 visible 状态;这些输入装饰槽不由 textarea 模式渲染。

通过公开 mention.input 调用 focus、blur、select、clear;多行回填后调用 resizeTextarea 重新测量。 完整说明。

单行装饰槽与嵌套输入实例

展开源码

动态原生类型与状态保留 ​

切换 text、password 与 number 时观察原生模型、焦点和前缀插槽。number 的文本选区限制、未提交 lazy 值与 textarea DOM 切换遵循原生实现,本入口不改写 DOM 方法或修复光标行为。

动态原生类型与状态保留

展开源码

原生委托与事件记录 ​

下方完整 TS/JS 示例记录模型及事件顺序,并可切换禁用、只读和自动校验状态。 完整说明。

原生委托与事件记录

展开源码

API

属性 AsamMentionProps

属性名说明类型默认值
id等价于原生 input id 属性string | undefined—
min原生输入边界与步长,包括继承的数字输入模式。(string | number) | undefined—
max—(string | number) | undefined—
step—(string | number) | undefined—
size显式控件密度;省略时继承按钮组、表单和配置提供器。enum"large" | "big" | "default" | "small"完整类型:AsamControlSize | undefined—
disabled是否禁用boolean | undefinedfalse
modelModifiersv-model 修饰符,参考 Vue 修饰符(AsamMentionProps<T>)["modelModifiers"]—
maxlength等价于原生 maxlength 属性string | number | undefined—
minlength等价于原生 minlength 属性string | number | undefined—
type输入类型,更多信息请参见 MDNenum"number" | "text" | "email" | "search" | "tel" | "url" | "textarea" | "password"完整类型:(AsamMentionProps<T>)["type"]—
resize控制是否能被用户缩放enum"horizontal" | "vertical" | "none" | "both"完整类型:"horizontal" | "vertical" | "none" | "both" | undefined—
autosize文本域是否具有自适应高度。(AsamMentionProps<T>)["autosize"]false
autocomplete原生输入自动完成;联合类型包含大量字面量时可能触发 TS2590,详见 Vue 问题 10514。string | undefined—
formatter格式化显示内容。((value: string) => string) | undefined—
parser解析显示内容。((value: string) => string) | undefined—
placeholder输入框占位文本string | undefined—
form原生输入的表单关联。string | undefined—
readonly原生输入的只读状态。boolean | undefinedfalse
clearable是否显示清除按钮boolean | undefinedfalse
clearIcon自定义清除图标(AsamMentionProps<T>)["clearIcon"]—
showPassword可切换显示状态的密码输入。boolean | undefinedfalse
showWordLimit字符计数。boolean | undefinedfalse
wordLimitPosition字数统计的位置,仅当 show-word-limit 为 true 时生效。enum"outside" | "inside"完整类型:"outside" | "inside" | undefined—
suffixIcon后缀图标。(AsamMentionProps<T>)["suffixIcon"]—
prefixIcon前缀图标。(AsamMentionProps<T>)["prefixIcon"]—
containerRole容器角色;原生内部属性用于选择器组件。string | undefined—
tabindex等价于原生 tabindex 属性string | number | undefined—
validateEvent是否触发表单验证boolean | undefinedfalse
inputStyle输入框或文本域元素样式。import("vue").StyleValuefalse
autofocus原生输入自动聚焦。boolean | undefinedfalse
rows输入框行数,仅 type 为 'textarea' 时有效number | undefined—
ariaLabel原生 aria-label属性string | undefined—
inputmode原生虚拟键盘输入模式。enum"text" | "email" | "search" | "tel" | "url" | "none" | "numeric" | "decimal"完整类型:"text" | "email" | "search" | "tel" | "url" | "none" | "numeric" | "decimal" | undefined—
name原生属性string | undefined—
countGraphemes按字素统计输入长度;设置后不使用原生 maxlength 和 minlength。((value: string) => number) | undefined—
options提及选项列表T[] | undefined—
prefix触发字段的前缀。字符串长度必须且只能为 1string | string[] | undefined—
split用于拆分提及的字符。字符串长度必须且只能为 1string | undefined—
filterOption定制筛选器选项逻辑false | ((pattern: string, option: T) => boolean) | undefinedfalse
placement设置弹出位置enum"top" | "bottom"完整类型:"top" | "bottom" | undefined—
showArrow下拉菜单的内容是否有箭头boolean | undefinedfalse
offset下拉面板偏移量number | undefined—
whole当退格键被按下做删除操作时,是否将提及部分作为整体删除boolean | undefinedfalse
checkIsWhole当退格键被按下做删除操作时,检查是否将提及部分作为整体删除((pattern: string, prefix: string) => boolean) | undefined—
modelValue输入值string | undefined—
loading自定义 loading内容boolean | undefinedfalse
popperClass自定义浮层类名AsamMentionProps<T>["popperClass"]false
popperStyle自定义浮层类名import("vue").StyleValuefalse
popperOptionspopper.js 参数(AsamMentionProps<T>)["popperOptions"]—
propsoptions 的配置(AsamMentionProps<T>)["props"]—

事件 AsamMentionEmits

属性名说明类型默认值
update:modelValue—[value: string | number]—
input—[value: string]—
change继承原生输入 change;原事件参数可省略。[value: string, event?: Event | undefined]—
clear—[event?: MouseEvent | undefined]—
mouseenter—[event: MouseEvent]—
mouseleave—[event: MouseEvent]—
keydown浏览器自动填充可能产生 Event,而非 KeyboardEvent。[event: Event | KeyboardEvent]—
compositionstart内部输入框或文本域的原生输入法组合事件。[event: CompositionEvent]—
compositionupdate—[event: CompositionEvent]—
compositionend—[event: CompositionEvent]—
search—[pattern: string, prefix: string]—
select—[option: T, prefix: string]—
whole-remove—[pattern: string, prefix: string]—
focus—[event: FocusEvent]—
blur—[event: FocusEvent]—

插槽 AsamMentionSlots

属性名说明类型默认值
prefix—(() => unknown) | undefined—
suffix—(() => unknown) | undefined—
prepend—(() => unknown) | undefined—
append—(() => unknown) | undefined—
password-icon—((props: { visible: boolean; }) => unknown) | undefined—
header—(() => unknown) | undefined—
footer—(() => unknown) | undefined—
loading—(() => unknown) | undefined—
label—((props: { item: T; index: number; }) => unknown) | undefined—

实例方法与状态 AsamMentionExpose

属性名说明类型默认值
input—(AsamMentionExpose)["input"]—
tooltip—(AsamMentionExpose)["tooltip"]—
dropdownVisible—boolean—

用法与契约补充说明 ​

使用场景 ​

用于评论、消息中的 @人员、#主题等提及,模型保存完整输入内容。modelValue 对齐原生 MentionProps 的字符串模型;update:modelValue 保留 string | number,Vue 的 number 修饰符可能让监听器收到数字。options 描述 value、label、disabled 等信息;扩展字段通过泛型保留。

完整继承输入组合 ​

min/max/step、formatter/parser、modelModifiers 与 textarea 参数原样交给 底层输入。trim/number/lazy 的实际更新和整项删除由原生处理;ASAM 不转换 modelValue、不保存独立草稿、不安排失焦后备提交,也不自行调度 change/blur 表单校验。直接 v-model.number 将数字写回字符串 prop 时,可能出现与原生相同的类型警告。建议保留文本模型,在应用或高级数据层处理业务数值;更新事件不能因此静默丢弃数字。旧 string | number 的 prop 用法迁移为字符串,数字输入 type=number 也使用文本模型。

实际单行装饰槽与嵌套输入实例 ​

通过公开 mention.input 调用 focus、blur、select、clear;多行回填后调用 resizeTextarea 重新测量。输出实际 input/textarea/ref、textareaStyle、autosize、passwordVisible 和 isComposing 状态,展示本入口的嵌套 InputInstance 路由。tooltip 与 dropdownVisible 继续按本页公开类型及现有多行/事件示例使用。

原生委托与事件记录 ​

下方完整 TS/JS 示例记录模型及事件顺序,并可切换禁用、只读和自动校验状态。省略的基础参数使用原生 defaults;显式 undefined/null/false 原样传入,合法值范围见 API。四档 size 是 ASAM 的视觉桥接;Password 额外固定 type=password,并在省略 showPassword 时启用显隐入口。

更多参数与事件说明 ​

完整继承输入事件 ​

除提及自己的 search、select、whole-remove,所有输入事件均由实际 input/textarea 承接:update:modelValue 为 string | number;input 为字符串;change 为字符串及可选原生 Event; clear 为可选 MouseEvent;focus/blur 为 FocusEvent;mouseenter/mouseleave 为 MouseEvent;keydown 为 KeyboardEvent 或浏览器自动填充触发的 Event; compositionstart/update/end 为 CompositionEvent。显式公开的监听器逐项转发, 每次原生触发只通知一次,不同时在外层 DOM 再挂同名监听器。

参数与事件补充说明

参数与事件说明

id

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

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

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

min

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

max

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

step

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

size

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

size 参数与事件数据

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

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

disabled

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

disabled 参数与事件数据

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

枚举:false / true

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

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

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

modelModifiers

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

modelModifiers 参数与事件数据

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

  • modelModifiers.lazy: true | undefined — 上游声明

    枚举:true

  • modelModifiers.number: true | undefined — 上游声明

    枚举:true

  • modelModifiers.trim: true | undefined — 上游声明

    枚举:true

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

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

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

maxlength

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

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

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

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

minlength

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

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

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

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

type

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

type 参数与事件数据

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

枚举:"number" / "text" / "email" / "search" / "tel" / "url" / "textarea" / "password"

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

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

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

resize

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

resize 参数与事件数据

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

枚举:"horizontal" / "vertical" / "none" / "both"

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

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

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

autosize

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

autosize 参数与事件数据

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

枚举:false / true

  • autosize.minRows: number | undefined — 上游声明
  • autosize.maxRows: number | undefined — 上游声明
默认值与来源
false(隐式 Boolean 默认;已安装组件)

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

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

autocomplete

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

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

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

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

formatter

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

formatter 参数与事件数据

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

事件参数:(value: string): string

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

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

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

parser

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

parser 参数与事件数据

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

事件参数:(value: string): string

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

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

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

placeholder

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

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

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

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

form

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

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

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

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

readonly

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

readonly 参数与事件数据

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

枚举:false / true

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

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

clearable

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

clearable 参数与事件数据

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

枚举:false / true

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

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

clearIcon

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

clearIcon 参数与事件数据

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

事件参数:(props: any, ctx: Parameters<Extract<NonNullable<(AsamMentionProps<T>)["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 运行实测)

showPassword

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

showPassword 参数与事件数据

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

枚举:false / true

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

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

showWordLimit

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

showWordLimit 参数与事件数据

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

枚举:false / true

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

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

wordLimitPosition

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

wordLimitPosition 参数与事件数据

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

枚举:"outside" / "inside"

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

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

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

suffixIcon

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

suffixIcon 参数与事件数据

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

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

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

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

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

prefixIcon

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

prefixIcon 参数与事件数据

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

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

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

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

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

containerRole

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

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

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

tabindex

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

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

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

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

validateEvent

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

validateEvent 参数与事件数据

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

枚举:false / true

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

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

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

inputStyle

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

inputStyle 参数与事件数据

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

枚举:false

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

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

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

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

autofocus

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

autofocus 参数与事件数据

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

枚举:false / true

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

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

rows

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

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

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

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

ariaLabel

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

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

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

inputmode

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

inputmode 参数与事件数据

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

枚举:"text" / "email" / "search" / "tel" / "url" / "none" / "numeric" / "decimal"

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

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

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

name

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

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

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

countGraphemes

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

countGraphemes 参数与事件数据

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

事件参数:(value: string): number

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

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

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

options

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

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

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

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

prefix

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

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

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

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

split

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

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

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

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

filterOption

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

filterOption 参数与事件数据

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

枚举:false

事件参数:(pattern: string, option: T): boolean

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

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

placement 参数与事件数据

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

枚举:"top" / "bottom"

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

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

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

showArrow

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

showArrow 参数与事件数据

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

枚举:false / true

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

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

offset

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

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

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

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

whole

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

whole 参数与事件数据

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

枚举:false / true

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

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

checkIsWhole

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

checkIsWhole 参数与事件数据

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

事件参数:(pattern: string, prefix: string): boolean

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

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

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

modelValue

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

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

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

loading

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

loading 参数与事件数据

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

枚举:false / true

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

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

popperClass

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

popperClass 参数与事件数据

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

枚举:false

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

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

popperStyle

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

popperStyle 参数与事件数据

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

枚举:false

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

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

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

popperOptions

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

popperOptions 参数与事件数据

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

  • popperOptions.placement: PublicMember<NonNullable<(AsamMentionProps<T>)["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<(AsamMentionProps<T>)["popperOptions"]>, "modifiers"> — 依赖声明
  • popperOptions.strategy: PublicMember<NonNullable<(AsamMentionProps<T>)["popperOptions"]>, "strategy"> — 依赖声明

    枚举:"fixed" / "absolute"

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

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

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

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

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

props

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

props 参数与事件数据

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

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

    选项值的字段名;这是字段别名,不是选项本身的值。

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

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

    选项标签的字段名;这是字段别名,不是选项本身的值。

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

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

    选项禁用状态的字段名;这是字段别名,不是选项本身的值。

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

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

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

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

AsamMentionProps 公开类型视图
ts
import type { Attrs } from 'vue';
import type { AsamMentionProps, AsamMentionOption, AsamControlSize } from '@asam-ui/ui';

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

// AsamMentionProps
type PublicContract<T extends AsamMentionOption = AsamMentionOption> = {
	readonly "id"?: string | undefined;
	readonly "min"?: (string | number) | undefined;
	readonly "max"?: (string | number) | undefined;
	readonly "step"?: (string | number) | undefined;
	readonly "size"?: AsamControlSize | undefined;
	readonly "disabled"?: boolean | undefined;
	readonly "modelModifiers"?: (AsamMentionProps<T>)["modelModifiers"];
	readonly "maxlength"?: string | number | undefined;
	readonly "minlength"?: string | number | undefined;
	readonly "type"?: (AsamMentionProps<T>)["type"];
	readonly "resize"?: "horizontal" | "vertical" | "none" | "both" | undefined;
	readonly "autosize"?: (AsamMentionProps<T>)["autosize"];
	readonly "autocomplete"?: string | undefined;
	readonly "formatter"?: ((value: string) => string) | undefined;
	readonly "parser"?: ((value: string) => string) | undefined;
	readonly "placeholder"?: string | undefined;
	readonly "form"?: string | undefined;
	readonly "readonly"?: boolean | undefined;
	readonly "clearable"?: boolean | undefined;
	readonly "clearIcon"?: (AsamMentionProps<T>)["clearIcon"];
	readonly "showPassword"?: boolean | undefined;
	readonly "showWordLimit"?: boolean | undefined;
	readonly "wordLimitPosition"?: "outside" | "inside" | undefined;
	readonly "suffixIcon"?: (AsamMentionProps<T>)["suffixIcon"];
	readonly "prefixIcon"?: (AsamMentionProps<T>)["prefixIcon"];
	readonly "containerRole"?: string | undefined;
	readonly "tabindex"?: string | number | undefined;
	readonly "validateEvent"?: boolean | undefined;
	readonly "inputStyle"?: import("vue").StyleValue;
	readonly "autofocus"?: boolean | undefined;
	readonly "rows"?: number | undefined;
	readonly "ariaLabel"?: string | undefined;
	readonly "inputmode"?: "text" | "email" | "search" | "tel" | "url" | "none" | "numeric" | "decimal" | undefined;
	readonly "name"?: string | undefined;
	readonly "countGraphemes"?: ((value: string) => number) | undefined;
	readonly "options"?: T[] | undefined;
	readonly "prefix"?: string | string[] | undefined;
	readonly "split"?: string | undefined;
	readonly "filterOption"?: false | ((pattern: string, option: T) => boolean) | undefined;
	readonly "placement"?: "top" | "bottom" | undefined;
	readonly "showArrow"?: boolean | undefined;
	readonly "offset"?: number | undefined;
	readonly "whole"?: boolean | undefined;
	readonly "checkIsWhole"?: ((pattern: string, prefix: string) => boolean) | undefined;
	readonly "modelValue"?: string | undefined;
	readonly "loading"?: boolean | undefined;
	readonly "popperClass"?: AsamMentionProps<T>["popperClass"];
	readonly "popperStyle"?: import("vue").StyleValue;
	readonly "popperOptions"?: (AsamMentionProps<T>)["popperOptions"];
	readonly "props"?: (AsamMentionProps<T>)["props"];
};

参数与事件说明

update:modelValue

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

input

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

change

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

clear

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

mouseenter

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

mouseleave

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

keydown

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

compositionstart

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

compositionupdate

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

compositionend

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

search

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

select

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

whole-remove

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

focus

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

blur

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

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

// AsamMentionEmits
type PublicContract<T extends AsamMentionOption = AsamMentionOption> = {
	"update:modelValue": [value: string | number];
	"input": [value: string];
	"change": [value: string, event?: Event | undefined];
	"clear": [event?: MouseEvent | undefined];
	"mouseenter": [event: MouseEvent];
	"mouseleave": [event: MouseEvent];
	"keydown": [event: Event | KeyboardEvent];
	"compositionstart": [event: CompositionEvent];
	"compositionupdate": [event: CompositionEvent];
	"compositionend": [event: CompositionEvent];
	"search": [pattern: string, prefix: string];
	"select": [option: T, prefix: string];
	"whole-remove": [pattern: string, prefix: string];
	"focus": [event: FocusEvent];
	"blur": [event: FocusEvent];
};

参数与事件说明

prefix

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

prefix 参数与事件数据

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

事件参数:(): unknown

suffix

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

suffix 参数与事件数据

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

事件参数:(): unknown

prepend

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

prepend 参数与事件数据

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

事件参数:(): unknown

append

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

append 参数与事件数据

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

事件参数:(): unknown

password-icon

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

password-icon 参数与事件数据

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

事件参数:(props: { visible: boolean; }): unknown

header

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

header 参数与事件数据

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

事件参数:(): unknown

footer

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

footer 参数与事件数据

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

事件参数:(): unknown

loading

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

loading 参数与事件数据

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

事件参数:(): unknown

label

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

label 参数与事件数据

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

事件参数:(props: { item: T; index: number; }): unknown

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

// AsamMentionSlots
type PublicContract<T extends AsamMentionOption = AsamMentionOption> = {
	"prefix"?: (() => unknown) | undefined;
	"suffix"?: (() => unknown) | undefined;
	"prepend"?: (() => unknown) | undefined;
	"append"?: (() => unknown) | undefined;
	"password-icon"?: ((props: { visible: boolean; }) => unknown) | undefined;
	"header"?: (() => unknown) | undefined;
	"footer"?: (() => unknown) | undefined;
	"loading"?: (() => unknown) | undefined;
	"label"?: ((props: { item: T; index: number; }) => unknown) | undefined;
};

参数与事件说明

input

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

tooltip

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

dropdownVisible

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

dropdownVisible 参数与事件数据

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

枚举:false / true

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

// AsamMentionExpose
type PublicContract = {
	readonly "input": (AsamMentionExpose)["input"];
	readonly "tooltip": (AsamMentionExpose)["tooltip"];
	readonly "dropdownVisible": boolean;
};

搜索文档

Tab 选择结果 Enter 打开 Esc 关闭