Elements

组件

标签输入 Tags Input

TagsInput:标签输入。一个字段容器中,标签平时显示为低调墨色,编辑时只轻微提升色调。部件:Root、Label、Control、Input、ClearTrigger、Item、ItemPreview、ItemText、ItemInput、ItemDeleteTrigger、HiddenInput、Context。

#基础用法

tags-input/basic Vue React
Qinghua
Celadon

#属性

#ClearTrigger

纯造型的部件——自身没有属性,沿用部件结构的共享样式。

#Control

纯造型的部件——自身没有属性,沿用部件结构的共享样式。

#HiddenInput

纯造型的部件——自身没有属性,沿用部件结构的共享样式。

#Input

纯造型的部件——自身没有属性,沿用部件结构的共享样式。

#ItemContext

纯造型的部件——自身没有属性,沿用部件结构的共享样式。

#ItemDeleteTrigger

纯造型的部件——自身没有属性,沿用部件结构的共享样式。

#ItemInput

纯造型的部件——自身没有属性,沿用部件结构的共享样式。

#ItemPreview

纯造型的部件——自身没有属性,沿用部件结构的共享样式。

#ItemText

纯造型的部件——自身没有属性,沿用部件结构的共享样式。

#Item

属性类型默认值描述
disabledboolean | undefined—
indexstring | number—
valuestring—

#Label

纯造型的部件——自身没有属性,沿用部件结构的共享样式。

#Root

属性类型默认值描述
sizeString as PropType<"sm" | "md" | "lg">"md"标签输入框静止状态的高度档位
addOnPastebooleanfalse粘贴内容时是否添加标签
allowDuplicatesbooleanfalse是否允许重复标签
allowOverflowboolean是否允许标签数量超过 max;超过后根元素会附加 data-invalid
autoFocusbooleaninput 是否自动聚焦
blurBehavior'clear' | 'add'标签输入失焦时的行为:add 把 input 值添加为新标签,clear 清空 input 值
defaultInputValuestring标签输入渲染时的初始值;不需要控制输入值时使用
defaultValuestring[]标签渲染时的初始值;不需要控制标签值时使用
delimiterstring | RegExp","触发添加标签的按键,也是粘贴时拆分标签的字符
disabledboolean标签输入是否禁用
editablebooleantrue标签创建后能否按 Enter 或双击编辑
formstring底层 input 元素关联的表单
idstring组件内部状态机的唯一标识
idsPartial<{ root: string; input: string; hiddenInput: string; clearBtn: string; label: string; control: string; item(opts: tagsInput.ItemProps): string; itemDeleteTrigger(opts: tagsInput.ItemProps): string; itemInput(opts: tagsInput.ItemProps): string; }>标签输入各元素的 id,适合组合使用
inputValuestring标签输入的受控值
invalidboolean标签输入是否无效
maxnumberInfinity标签数量上限
maxLengthnumberinput 最大长度
modelValuestring[]标签输入的 v-model 值
namestringinput 的 name 属性,用于表单提交
placeholderstring没有标签时 input 的占位文本
readOnlyboolean标签输入是否只读
requiredboolean标签输入是否必填
sanitizeValue(value: string) => string添加标签前清理标签值的函数
translationstagsInput.IntlTranslations无障碍元素及其状态的本地化文案
validate(details: tagsInput.ValidateArgs) => boolean返回能否添加标签的布尔值,可防止重复或无效标签值