:: BASE_DOC ::
| 名称 | 类型 | 默认值 | 描述 | 必传 |
|---|---|---|---|---|
| className | String | - | 类名 | N |
| style | Object | - | 样式，TS 类型：React.CSSProperties |
N |
| autoWidth | Boolean | false | 宽度随内容自适应 | N |
| borderless | Boolean | false | 无边框模式 | N |
| clearable | Boolean | false | 是否可清空 | N |
| collapsedItems | TElement | - | 标签过多的情况下，折叠项内容，默认为 +N。如果需要悬浮就显示其他内容，可以使用 collapsedItems 自定义。value 表示当前存在的所有标签，collapsedSelectedItems 表示折叠的标签，count 表示折叠的数量，onClose 表示移除标签的事件回调。TS 类型：TNode<{ value: TagInputValue; collapsedSelectedItems: TagInputValue; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>。通用类型定义 |
N |
| disabled | Boolean | - | 是否禁用标签输入框 | N |
| dragSort | Boolean | false | 拖拽调整标签顺序 | N |
| excessTagsDisplayType | String | break-line | 标签超出时的呈现方式，有两种：横向滚动显示 和 换行显示。可选项：scroll/break-line | N |
| inputProps | Object | - | 透传 Input 输入框组件全部属性。TS 类型：InputProps，Input API Documents。详细类型定义 |
N |
| inputValue | String / Number | '' | 输入框的值。TS 类型：string |
N |
| defaultInputValue | String / Number | '' | 输入框的值。非受控属性。TS 类型：string |
N |
| label | TNode | - | 左侧文本。TS 类型：string | TNode。通用类型定义 |
N |
| max | Number | - | 最大允许输入的标签数量 | N |
| maxRows | Number | - | 最大允许显示的行数，超出会出现滚动条，默认为不限制。 | N |
| minCollapsedNum | Number | 0 | 最小折叠数量，用于标签数量过多的情况下折叠选中项，超出该数值的选中项折叠。值为 0 则表示不折叠 | N |
| placeholder | String | undefined | 占位符 | N |
| prefixIcon | TElement | - | 组件前置图标。TS 类型：TNode。通用类型定义 |
N |
| readonly | Boolean | false | 只读状态，值为真会隐藏标签移除按钮和输入框 | N |
| size | String | medium | 组件尺寸。可选项：small/medium/large。TS 类型：SizeEnum。通用类型定义 |
N |
| status | String | - | 输入框状态。可选项：default/success/warning/error | N |
| suffix | TNode | - | 后置图标前的后置内容。TS 类型：string | TNode。通用类型定义 |
N |
| suffixIcon | TElement | - | 组件后置图标。TS 类型：TNode。通用类型定义 |
N |
| tag | TNode | - | 自定义标签的内部内容，每一个标签的当前值。注意和 valueDisplay 区分，valueDisplay 是用来定义全部标签内容，而非某一个标签。TS 类型：string | TNode<{ value: string | number }>。通用类型定义 |
N |
| tagProps | Object | - | 透传 Tag 组件全部属性。TS 类型：TagProps，Tag API Documents。详细类型定义 |
N |
| tips | TNode | - | 输入框下方提示文本，会根据不同的 status 呈现不同的样式。TS 类型：string | TNode。通用类型定义 |
N |
| value | Array | [] | 值。TS 类型：TagInputValue type TagInputValue = Array<string | number>。详细类型定义 |
N |
| defaultValue | Array | [] | 值。非受控属性。TS 类型：TagInputValue type TagInputValue = Array<string | number>。详细类型定义 |
N |
| valueDisplay | TNode | - | 自定义值呈现的全部内容，参数为所有标签的值。TS 类型：string | TNode<{ value: TagInputValue; onClose: (index: number, item?: any) => void }>。通用类型定义 |
N |
| onBlur | Function | TS 类型：(value: TagInputValue, context: { inputValue: string; e: FocusEvent }) => void失去焦点时触发 |
N | |
| onChange | Function | TS 类型：(value: TagInputValue, context: TagInputChangeContext) => void值变化时触发，参数 context.trigger 表示数据变化的触发来源；context.index 指当前变化项的下标；context.item 指当前变化项；context.e 表示事件参数。详细类型定义。interface TagInputChangeContext { trigger: TagInputTriggerSource; index?: number; item?: string | number; e?: MouseEvent | KeyboardEvent }type TagInputTriggerSource = 'enter' | 'tag-remove' | 'backspace' | 'clear' |
N | |
| onClear | Function | TS 类型：(context: { e: MouseEvent }) => void清空按钮点击时触发 |
N | |
| onClick | Function | TS 类型：(context: { e: MouseEvent }) => void点击组件时触发 |
N | |
| onDragSort | Function | TS 类型：(context: TagInputDragSortContext) => void【开发中】拖拽排序时触发。详细类型定义。 interface TagInputDragSortContext { newTags: TagInputValue; currentIndex: number; current: string | number; targetIndex: number; target: string | number } |
N | |
| onEnter | Function | TS 类型：(value: TagInputValue, context: { e: KeyboardEvent; inputValue: string }) => void按键按下 Enter 时触发 |
N | |
| onFocus | Function | TS 类型：(value: TagInputValue, context: { inputValue: string; e: FocusEvent }) => void聚焦时触发 |
N | |
| onInputChange | Function | TS 类型：(value: string, context?: InputValueChangeContext) => void输入框值发生变化时触发， context.trigger 表示触发输入框值变化的来源：文本输入触发、清除按钮触发、回车键触发等。详细类型定义。interface InputValueChangeContext { e?: InputEvent | MouseEvent | CompositionEvent | KeyboardEvent; trigger: 'input' | 'clear' | 'enter' | 'blur' } |
N | |
| onMouseenter | Function | TS 类型：(context: { e: MouseEvent }) => void进入输入框时触发 |
N | |
| onMouseleave | Function | TS 类型：(context: { e: MouseEvent }) => void离开输入框时触发 |
N | |
| onPaste | Function | TS 类型：(context: { e: ClipboardEvent; pasteValue: string }) => void粘贴事件， pasteValue 表示粘贴板的内容 |
N | |
| onRemove | Function | TS 类型：(context: TagInputRemoveContext) => void移除单个标签时触发。详细类型定义。 interface TagInputRemoveContext { value: TagInputValue; index: number; item: string | number; e?: MouseEvent | KeyboardEvent; trigger: TagInputRemoveTrigger }type TagInputRemoveTrigger = 'tag-remove' | 'backspace' |
N |