docs: fix type desc (#5734)

This commit is contained in:
吉仔 2024-03-11 14:05:00 +08:00 committed by GitHub
parent 00537c84ad
commit 4bc272c317
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
23 changed files with 31 additions and 31 deletions

View File

@ -29,7 +29,7 @@ append.vue
| default-value | `string` | `null` | Default value of autocomplete. | |
| disabled | `boolean` | `false` | Whether the autocomplete is disabled. | |
| get-show | `(value: string) => boolean` | `undefined` | Use the input to determine whether to show options on focus. | |
| input-props | `HTMLInputAttributes` | `undefined` | The attributes of input element in autocomplete. | |
| input-props | `InputHTMLAttributes` | `undefined` | The attributes of input element in autocomplete. | |
| loading | `boolean` | `false` | Whether to show a loading status. | |
| menu-props | `HTMLAttributes` | `undefined` | The menu's dom props. | 2.32.2 |
| options | `Array<string \| AutoCompleteOption \| AutoCompleteGroupOption>` | `[]` | Options to autocomplete from. | |

View File

@ -29,7 +29,7 @@ append.vue
| default-value | `string` | `null` | 自动填充的默认值 | |
| disabled | `boolean` | `false` | 自动填充是否禁用 | |
| get-show | `(value: string) => boolean` | `undefined` | 根据输入值在聚焦的状态中决定是否显示菜单 | |
| input-props | `HTMLInputAttributes` | `undefined` | 自动填充中 input 元素的属性 | |
| input-props | `InputHTMLAttributes` | `undefined` | 自动填充中 input 元素的属性 | |
| loading | `boolean` | `false` | 是否展示加载状态 | |
| menu-props | `HTMLAttributes` | `undefined` | 菜单的 DOM 属性 | 2.32.2 |
| options | `Array<string \| AutoCompleteOption \| AutoCompleteGroupOption>` | `[]` | 自动填充的自定义选项 | |

View File

@ -26,7 +26,7 @@ v-show-debug.vue
| bordered | `boolean` | `false` | Whether to display a avatar with border. | |
| color | `string` | `undefined` | The background color of the avatar. | |
| fallback-src | `string` | `undefined` | Image URL to show when avatar fails to load. | |
| img-props | `object` | `undefined` | The props of the img element inside the component. | 2.34.0 |
| img-props | `ImgHTMLAttributes` | `undefined` | The props of the img element inside the component. | 2.34.0 |
| intersection-observer-options | `{ root?: Element \| Document \| string \| null, rootMargin?: string, threshold?: number \| number[]; }` | `undefined` | Intersection observer's config to be applied when `lazy=true`. | 2.31.0 |
| lazy | `boolean` | `false` | Load image after it enters viewport. When used alone, it will be assigned the property value of [HTMLImageElement.loading](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/loading). Alternatively, it can be used in conjunction with the `intersection-observer-options` configuration to achieve lazy loading. | 2.31.0 |
| object-fit | `'fill' \| 'contain' \| 'cover' \| 'none' \| 'scale-down'` | `'fill'` | Object-fit type of the image in the container. | |

View File

@ -28,7 +28,7 @@ rtl-debug.vue
| bordered | `boolean` | `false` | 头像是否带边框 | |
| color | `string` | `undefined` | 头像的背景色 | |
| fallback-src | `string` | `undefined` | 头像加载失败时显示的图片的地址 | |
| img-props | `object` | `undefined` | 组件中 img 元素的属性 | 2.34.0 |
| img-props | `ImgHTMLAttributes` | `undefined` | 组件中 img 元素的属性 | 2.34.0 |
| intersection-observer-options | `{ root?: Element \| Document \| string \| null, rootMargin?: string, threshold?: number \| number[]; }` | `undefined` | `lazy=true` 时 intersection observer 观测的配置 | 2.31.0 |
| lazy | `boolean` | `false` | 是否让图片进入视口再加载,单独使用将设置为[HTMLImageElement.loading](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/loading) 的属性值;也可配合 `intersection-observer-options` 配置实现懒加载 | 2.31.0 |
| object-fit | `'fill' \| 'contain' \| 'cover' \| 'none' \| 'scale-down'` | `'fill'` | 头像的图片在容器内的的适应类型 | |

View File

@ -92,9 +92,9 @@ export-csv.vue
| render-expand-icon | `({ expanded }: { expanded: boolean }) => VNodeChild` | `undefined` | Render function of expand icon. | 2.32.2, `expanded`: 2.34.4 |
| row-class-name | `string \| (rowData: object, rowIndex : number) => string` | `undefined` | Class name of each row. | |
| row-key | `(rowData: object) => (number \| string)` | `undefined` | Generate the key of the row by row data (if you don't want to set the key). | |
| row-props | `(rowData: object, rowIndex : number) => object` | `undefined` | Customize row attributes. | |
| row-props | `(rowData: object, rowIndex : number) => HTMLAttributes` | `undefined` | Customize row attributes. | |
| scroll-x | `number \| string` | `undefined` | If columns are horizontal fixed, scroll-x need to be set. | |
| scrollbar-props | `object` | `undefined` | See [Scrollbar props](scrollbar#Scrollbar-Props), the `on-scroll` attribute already exists in the `DataTable`, the `on-scroll` attribute does not take effect here. | |
| scrollbar-props | `ScrollbarProps` | `undefined` | See [Scrollbar props](scrollbar#Scrollbar-Props), the `on-scroll` attribute already exists in the `DataTable`, the `on-scroll` attribute does not take effect here. | |
| single-column | `boolean` | `false` | Whether rows are not divided. If the prop is `true`, table cell has no `border-bottom`. | |
| single-line | `boolean` | `true` | Whether columns are not divided. If the prop is `true`, table cell has no `border-right`. | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | Table size. | |

View File

@ -103,9 +103,9 @@ rtl-debug.vue
| render-expand-icon | `({ expanded }: { expanded: boolean }) => VNodeChild` | `undefined` | 自定义渲染展开图标 | 2.32.2, `expanded`: 2.34.4 |
| row-class-name | `string \| (rowData: object, index : number) => string` | `undefined` | 每一行上的类名 | |
| row-key | `(rowData: object) => (number \| string)` | `undefined` | 通过行数据创建行的 key如果你不想给每一行加上 key | |
| row-props | `(rowData: object, rowIndex : number) => object` | `undefined` | 自定义行属性 | |
| row-props | `(rowData: object, rowIndex : number) => HTMLAttributes` | `undefined` | 自定义行属性 | |
| scroll-x | `number \| string` | `undefined` | 表格内容的横向宽度,如果列被水平固定了,则需要设定它 | |
| scrollbar-props | `object` | `undefined` | 属性参考 [Scrollbar props](scrollbar#Scrollbar-Props)`DataTable` 中已存在 `on-scroll` 属性,此处 `on-scroll` 属性不生效 | |
| scrollbar-props | `ScrollbarProps` | `undefined` | 属性参考 [Scrollbar props](scrollbar#Scrollbar-Props)`DataTable` 中已存在 `on-scroll` 属性,此处 `on-scroll` 属性不生效 | |
| single-column | `boolean` | `false` | 是否不设定行的分割线,当参数为`true`时,则单元格没有下边线 | |
| single-line | `boolean` | `true` | 是否不设定列的分割线,当参数值为 `true` 时,则单元格没有右边线 | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | 表格的尺寸 | |

View File

@ -41,7 +41,7 @@ resizable.vue
| min-height | `number` | `undefined` | Max height of draggable drawer. | 2.35.0 |
| placement | `'top' \| 'right' \| 'bottom' \| 'left'` | `'right'` | Drawer placement. | |
| resizable | `boolean` | `false` | Whether to resize the width / height of drawer. | 2.31.0 |
| scrollbar-props | `object` | `undefined` | See [Scrollbar props](scrollbar#Scrollbar-Props). | |
| scrollbar-props | `ScrollbarProps` | `undefined` | See [Scrollbar props](scrollbar#Scrollbar-Props). | |
| show | `boolean` | `false` | Whether to show drawer. | |
| show-mask | `boolean` | `true` | Whether to show mask. If set to `'transparent'`, transparent mask would be shown. If set to false, `trap-focus` will be disabled. | 2.28.3 |
| to | `string \| HTMLElement` | `'body'` | Container node of the drawer. | |
@ -71,7 +71,7 @@ resizable.vue
| header-style | `string \| Object` | `undefined` | Drawer content's header style. | |
| native-scrollbar | `boolean` | `true` | Whether to use native scrollbar on body part. | |
| title | `string` | `undefined` | Drawer content title. | |
| scrollbar-props | `object` | `undefined` | See [Scrollbar props](scrollbar#Scrollbar-Props) | |
| scrollbar-props | `ScrollbarProps` | `undefined` | See [Scrollbar props](scrollbar#Scrollbar-Props) | |
### Drawer Slots

View File

@ -48,7 +48,7 @@ rtl-debug.vue
| native-scrollbar | `boolean` | `true` | 是否使用原生滚动 | |
| placement | `'top' \| 'right' \| 'bottom' \| 'left'` | `'right'` | 抽屉展示的位置 | |
| resizable | `boolean` | `false` | 抽屉是否可以调整宽度、高度 | 2.31.0 |
| scrollbar-props | `object` | `undefined` | 属性参考 [Scrollbar props](scrollbar#Scrollbar-Props) | |
| scrollbar-props | `ScrollbarProps` | `undefined` | 属性参考 [Scrollbar props](scrollbar#Scrollbar-Props) | |
| show | `boolean` | `false` | 是否展示抽屉 | |
| show-mask | `boolean \| 'transparent'` | `true` | 是否显示遮罩,如果设为 `'transparent'` 会展示透明遮罩,如果设为 `false` 会禁用 `trap-focus` | 2.28.3 |
| to | `string \| HTMLElement` | `'body'` | 抽屉出现的区域 | |
@ -77,7 +77,7 @@ rtl-debug.vue
| header-class | `string` | `undefined` | 主体 header 的类名 | 2.37.0 |
| header-style | `string \| Object` | `undefined` | 主体 header 的样式 | |
| native-scrollbar | `boolean` | `true` | 主体部分是否使用原生滚动条 | |
| scrollbar-props | `object` | `undefined` | 属性参考 [Scrollbar props](scrollbar#Scrollbar-Props) | |
| scrollbar-props | `ScrollbarProps` | `undefined` | 属性参考 [Scrollbar props](scrollbar#Scrollbar-Props) | |
| title | `string` | `undefined` | 主体的标题 | |
### Drawer Slots

View File

@ -24,14 +24,14 @@ previewed-img-props.vue
| alt | `string` | `undefined` | Image alt information. | |
| fallback-src | `string` | `undefined` | URL to show when the image fails to load. | |
| height | `string \| number` | `undefined` | Image height. | |
| img-props | `object` | `undefined` | The props of the img element inside the component. | |
| img-props | `ImgHTMLAttributes` | `undefined` | The props of the img element inside the component. | |
| lazy | `boolean` | `false` | Load image after it enters viewport. When used alone, it will be assigned the property value of [HTMLImageElement.loading](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/loading). Alternatively, it can be used in conjunction with the `intersection-observer-options` configuration to achieve lazy loading. |
| 2.30.5 |
| intersection-observer-options | `{ root?: Element \| Document \| string \| null, rootMargin?: string, threshold?: number \| number[]; }` | `undefined` | Intersection observer's config to be applied when `lazy=true`. | 2.30.5 |
| object-fit | `'fill' \| 'contain' \| 'cover' \| 'none' \| 'scale-down'` | `fill` | Object-fit type of the image in the container. | |
| preview-src | `string` | `undefined` | Source of preview image. | |
| preview-disabled | `boolean` | `false` | Whether clicking image preview is disabled. | |
| previewed-img-props | `object` | `undefined` | DOM attributes of img element in preview mode. | 2.34.0 |
| previewed-img-props | `HTMLAttributes` | `undefined` | DOM attributes of img element in preview mode. | 2.34.0 |
| show-toolbar | `boolean` | `true` | Whether to show the bottom toolbar when the image enlarge. | |
| show-toolbar-tooltip | `boolean` | `false` | Whether to show toolbar buttons' tooltip. | 2.24.0 |
| src | `string` | `undefined` | Image source. | |

View File

@ -25,13 +25,13 @@ previewed-img-props.vue
| alt | `string` | `undefined` | 图片说明 | |
| fallback-src | `string` | `undefined` | 图片加载失败时显示的地址 | |
| height | `string \| number` | `undefined` | 图片高度 | |
| img-props | `object` | `undefined` | 组件中 img 元素的属性 | |
| img-props | `ImgHTMLAttributes` | `undefined` | 组件中 img 元素的属性 | |
| lazy | `boolean` | `false` | 是否让图片进入视口再加载,单独使用将设置为[HTMLImageElement.loading](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/loading) 的属性值;也可配合 `intersection-observer-options` 配置实现懒加载 | 2.30.5 |
| intersection-observer-options | `{ root?: Element \| Document \| string \| null, rootMargin?: string, threshold?: number \| number[]; }` | `undefined` | `lazy=true` 时 intersection observer 观测的配置 | 2.30.5 |
| object-fit | `'fill' \| 'contain' \| 'cover' \| 'none' \| 'scale-down'` | `'fill'` | 图片在容器内的的适应类型 | |
| preview-src | `string` | `undefined` | 预览图片的图片地址 | |
| preview-disabled | `boolean` | `false` | 是否禁用单击图像预览 | |
| previewed-img-props | `object` | `undefined` | 预览图片时 img 元素的属性 | 2.34.0 |
| previewed-img-props | `HTMLAttributes` | `undefined` | 预览图片时 img 元素的属性 | 2.34.0 |
| show-toolbar | `boolean` | `true` | 图片放大后是否展示底部工具栏 | |
| show-toolbar-tooltip | `boolean` | `false` | 是否展示工具栏的提示 | 2.24.0 |
| src | `string` | `undefined` | 图片来源 | |

View File

@ -37,7 +37,7 @@ custom-icon.vue
| default-value | `number \| null` | `null` | Default value when not manually set. | |
| disabled | `boolean` | `false` | Whether to disable the input. | |
| format | `(value: number \| null) => string` | `undefined` | Method to format value. If it's set, `update-value-on-input` will be disabled. | 2.30.0 |
| input-props | `HTMLInputAttributes` | `undefined` | The dom props of the input element inside the component. For avaiable attributes, [see here](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). WarningIt won't override internal props with the same name (except `type`). | 2.37.0 |
| input-props | `InputHTMLAttributes` | `undefined` | The dom props of the input element inside the component. For avaiable attributes, [see here](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). WarningIt won't override internal props with the same name (except `type`). | 2.37.0 |
| keyboard | `{ ArrowUp?: boolean, ArrowDown?: boolean }` | `{}` | Control the keyboard behavior. If you set corresponding to false, the keyboard behavior will be disabled. | |
| loading | `boolean` | `undefined` | Set loading state. If set (true/false), the element will always take up enough space for the loading indicator. | |
| max | `number` | `undefined` | The max value. | |

View File

@ -41,7 +41,7 @@ precision-debug.vue
| default-value | `number \| null` | `null` | 非受控模式下的默认值 | |
| disabled | `boolean` | `false` | 是否禁用 | |
| format | `(value: number \| null) => string` | `undefined` | 格式化值的方法,设定后会禁用 `update-value-on-input` | 2.30.0 |
| input-props | `HTMLInputAttributes` | `undefined` | 组件内部 input 元素的属性,[在这里查看原生属性](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input)。注意:`input-props` 不会覆盖内部 input 元素的已经存在的属性(除了 `type` | 2.37.0 |
| input-props | `InputHTMLAttributes` | `undefined` | 组件内部 input 元素的属性,[在这里查看原生属性](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input)。注意:`input-props` 不会覆盖内部 input 元素的已经存在的属性(除了 `type` | 2.37.0 |
| keyboard | `{ ArrowUp?: boolean, ArrowDown?: boolean }` | `{}` | 控制允许的键盘操作,属性值设为 `false` 的时候会禁用对应的键盘操作 |
| loading | `boolean` | `undefined` | 是否展示加载图标,设为非 `undefined` 会占据空间 | |
| max | `number` | `undefined` | 最大值 | |

View File

@ -39,7 +39,7 @@ graphemes.vue
| count-graphemes | `(value: string) => number` | `undefined` | Count graphemes of input value. If it's set, native `maxlength` and `minlength` won't be used. | 2.34.0 |
| default-value | `string \| [string, string] \| null` | `null` | Default value when not manually set. | |
| disabled | `boolean` | `false` | Whether to disable the input. | |
| input-props | `HTMLInputAttributes \| TextareaHTMLAttributes` | `undefined` | The dom props of the input element inside the component. This is disabled if the `pair` property is true. For avaiable attributes, [see here](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). WarningIt won't override internal props with the same name (except `type`). | |
| input-props | `InputHTMLAttributes \| TextareaHTMLAttributes` | `undefined` | The dom props of the input element inside the component. This is disabled if the `pair` property is true. For avaiable attributes, [see here](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). WarningIt won't override internal props with the same name (except `type`). | |
| loading | `boolean` | `undefined` | Set loading state. If set (true/false), the element will always take up enough space for the loading indicator. | |
| maxlength | `number` | `undefined` | Maximum input length. | |
| minlength | `number` | `undefined` | Minimum input length. | |

View File

@ -43,7 +43,7 @@ textarea-resize-debug.vue
| default-value | `string \| [string, string] \| null` | `null` | 输入框默认值 | |
| count-graphemes | `(value: string) => number` | `undefined` | 计算输入的字数。如果设定了,那么原生的 `maxlength``minlength` 属性将不再被使用 | 2.34.0 |
| disabled | `boolean` | `false` | 是否禁用 | |
| input-props | `HTMLInputAttributes \| TextareaHTMLAttributes` | `undefined` | Input 组件内部 input 元素的属性,对 `pair` 类型不生效,[在这里查看原生属性](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input)。注意input-props 不会覆盖内部 input 元素的已经存在的属性(除了 `type` | |
| input-props | `InputHTMLAttributes \| TextareaHTMLAttributes` | `undefined` | Input 组件内部 input 元素的属性,对 `pair` 类型不生效,[在这里查看原生属性](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input)。注意input-props 不会覆盖内部 input 元素的已经存在的属性(除了 `type` | |
| loading | `boolean` | `undefined` | 是否展示加载图标,设为非 `undefined` 会占据空间 | |
| maxlength | `number` | `undefined` | 最大输入长度 | |
| minlength | `number` | `undefined` | 最小输入长度 | |

View File

@ -36,7 +36,7 @@ scroll-to.vue
| has-sider | `boolean` | `false` | Whether the component has sider inside. If so it must be `true`. | |
| native-scrollbar | `boolean` | `true` | Whether to use native scrollbar on itself. If set to `false`, layout will use a naive-ui style scrollbar for content. | |
| position | `'static' \| 'absolute'` | `'static'` | `static` position will make it css position set to `static`. `absolute` position will make it css position set to `absolute` and `left`, `right`, `top`, `bottom` to `0`. `absolute` position is very useful when you want to make content scroll in a fixed container or make the whole page's layout in a fixed position. You may need to change the style of the component to make it display as you expect. | |
| scrollbar-props | `object` | `undefined` | See [Scrollbar props](scrollbar#Scrollbar-Props) | |
| scrollbar-props | `ScrollbarProps` | `undefined` | See [Scrollbar props](scrollbar#Scrollbar-Props) | |
| sider-placement | `'left' \| 'right'` | `left` | The sidebar is displayed on the left or the right side. | |
| on-scroll | `(e: Event) => void` | `undefined` | Callback function when the content scroll. | |
@ -72,7 +72,7 @@ scroll-to.vue
| inverted | `boolean` | `false` | Whether to use inverted background. | |
| native-scrollbar | `boolean` | `true` | Whether to use native scrollbar on itself. If set to `false`, sider will use a naive-ui style scrollbar for content. | |
| position | `'static' \| 'absolute'` | `'static'` | `static` position will make it css position set to `static`. `absolute` position will make it css position set to `absolute` and `left`, `top`, `bottom` to `0`. `absolute` position is very useful when you want to make content scroll in a fixed container or make the whole page's layout in a fixed position. You may need to change the style of the component to make it as you expect. | |
| scrollbar-props | `object` | `undefined` | See [Scrollbar props](scrollbar#Scrollbar-Props) | |
| scrollbar-props | `ScrollbarProps` | `undefined` | See [Scrollbar props](scrollbar#Scrollbar-Props) | |
| show-collapsed-content | `boolean` | `true` | Whether to show content in sider after it is collapsed. | |
| show-trigger | `boolean \| 'bar' \| 'arrow-circle'` | `false` | Whether to show the built-in trigger button on sider. | |
| trigger-class | `string` | `undefined` | Trigger class. | 2.36.0 |

View File

@ -37,7 +37,7 @@ keep-alive-debug.vue
| has-sider | `boolean` | `false` | 组件内部是否有边栏,如果有的话必须设为 `true` | |
| native-scrollbar | `boolean` | `true` | 是否在自身使用原生滚动条。如果设定为 `false``Layout` 将会对内容使用 `naive-ui` 风格的滚动条 | |
| position | `'static' \| 'absolute'` | `'static'` | `static` 模式将会把 CSS `position` 设为 `static``absolute` 模式将会把 CSS `position` 设为 `absolute`,还将 `left`、`right`、`top`、`bottom` 设为 `0`。`absolute` 模式在你想将内容在一个固定容器或者将这个页面的布局设为固定位置的时候很有用。你可能需要修改一些 style 来确保它按照你预想的方式展示 | |
| scrollbar-props | `object` | `undefined` | 属性参考 [Scrollbar props](scrollbar#Scrollbar-Props) | |
| scrollbar-props | `ScrollbarProps` | `undefined` | 属性参考 [Scrollbar props](scrollbar#Scrollbar-Props) | |
| sider-placement | `'left' \| 'right'` | `left` | 组件折叠侧边栏在哪一侧 | |
| on-scroll | `(e: Event) => void` | `undefined` | 内容的滚动事件回调函数 | |
@ -73,7 +73,7 @@ keep-alive-debug.vue
| inverted | `boolean` | `false` | 使用反转背景色 | |
| native-scrollbar | `boolean` | `true` | 是否在自身使用原生滚动条。如果设定为 `false``Sider` 将会对内容使用 naive-ui 风格的滚动条 | |
| position | `'static' \| 'absolute'` | `'static'` | `static` 模式将会把 CSS `position` 设为 `static` `absolute` 模式将会把 CSS `position` 设为 `absolute`,还将 `left`、`top`、`bottom` 设为 `0`。`absolute` 模式在你想将内容在一个固定容器或者将这个页面的布局设为固定位置的时候很有用。你可能需要修改一些 style 来确保它按照你预想的方式展示 | |
| scrollbar-props | `object` | `undefined` | 属性参考 [Scrollbar props](scrollbar#Scrollbar-Props) | |
| scrollbar-props | `ScrollbarProps` | `undefined` | 属性参考 [Scrollbar props](scrollbar#Scrollbar-Props) | |
| show-collapsed-content | `boolean` | `true` | 是否在 `sider` 折叠后展示内部内容 | |
| show-trigger | `boolean \| 'bar' \| 'arrow-circle'` | `false` | 内置的触发按钮是否展示 | |
| trigger-class | `string` | `undefined` | 触发器类名 | 2.36.0 |

View File

@ -48,7 +48,7 @@ custom-field.vue
| filterable | `boolean` | `false` | Whether options can be filtered. | |
| filter | `(pattern: string, option: Object) => boolean` | String search method. | Filter function. | |
| ignore-composition | `boolean` | `true` | Ingore IME's composition status. By default `filter` won't be triggered by input event under compositions. | 2.33.4 |
| input-props | `HTMLInputAttributes` | `undefined` | The attributes of input element in the trigger. It only works when the select is filterable. | |
| input-props | `InputHTMLAttributes` | `undefined` | The attributes of input element in the trigger. It only works when the select is filterable. | |
| keyboard | `boolean` | `true` | Whether to allow keyboard control. | 2.34.4 |
| label-field | `string` | `'label'` | Field name of option label. | 2.29.1 |
| loading | `boolean` | `false` | Whether to show a loading state. | |

View File

@ -59,7 +59,7 @@ create-debug.vue
| filterable | `boolean` | `false` | 是否可以过滤 | |
| filter | `(pattern: string, option: object) => boolean` | 一个简单的字符串搜索算法 | 过滤器函数 | |
| ignore-composition | `boolean` | `true` | 忽略输入法 Composition 状态,默认情况下 `filter` 在输入法输入的过程中不会触发 | 2.33.4 |
| input-props | `HTMLInputAttributes` | `undefined` | 触发器中 input 元素的属性,只在可过滤时有意义 | |
| input-props | `InputHTMLAttributes` | `undefined` | 触发器中 input 元素的属性,只在可过滤时有意义 | |
| keyboard | `boolean` | `true` | 是否支持键盘操作 | 2.34.4 |
| label-field | `string` | `'label'` | 选项 label 的字段名 | 2.29.1 |
| loading | `boolean` | `false` | 是否为加载状态 | |

View File

@ -71,7 +71,7 @@ override-click-behavior.vue
| render-prefix | `(info: { option: TreeOption, checked: boolean, selected: boolean }) => VNodeChild` | `undefined` | Render function of all the options' prefix. | |
| render-suffix | `(info: { option: TreeOption, checked: boolean, selected: boolean }) => VNodeChild` | `undefined` | Render function of all the options' suffix. | |
| render-switcher-icon | `(props: { option: TreeOption, expanded: boolean, selected: boolean }) => VNodeChild` | `undefined` | Render function of option switcher icon. | 2.24.0, `props` 2.34.0 |
| scrollbar-props | `object` | `undefined` | See [Scrollbar props](scrollbar#Scrollbar-Props) | |
| scrollbar-props | `ScrollbarProps` | `undefined` | See [Scrollbar props](scrollbar#Scrollbar-Props) | |
| selectable | `boolean` | `true` | Whether the node can be selected. | |
| selected-keys | `Array<string \| number>` | `undefined` | If set, selected status will work in controlled manner. | |
| show-irrelevant-nodes | `boolean` | `true` | Whether to filter unmached nodes when tree is in filter mode. | 2.28.1 |

View File

@ -77,7 +77,7 @@ expand-debug.vue
| render-prefix | `(info: { option: TreeOption, checked: boolean, selected: boolean }) => VNodeChild` | `undefined` | 节点前缀的渲染函数 | |
| render-suffix | `(info: { option: TreeOption, checked: boolean, selected: boolean }) => VNodeChild` | `undefined` | 节点后缀的渲染函数 | |
| render-switcher-icon | `(props: { option: TreeOption, expanded: boolean, selected: boolean }) => VNodeChild` | `undefined` | 节点展开开关的渲染函数 | 2.24.0, `props` 2.34.0 |
| scrollbar-props | `object` | `undefined` | 属性参考 [Scrollbar props](scrollbar#Scrollbar-Props) |   |
| scrollbar-props | `ScrollbarProps` | `undefined` | 属性参考 [Scrollbar props](scrollbar#Scrollbar-Props) |   |
| selectable | `boolean` | `true` | 节点是否可以被选中 | |
| selected-keys | `Array<string \| number>` | `undefined` | 如果设定则 `selected` 状态受控 | |
| show-irrelevant-nodes | `boolean` | `true` | 是否在搜索状态显示和搜索无关的节点 | 2.28.1 |

View File

@ -40,7 +40,7 @@ download.vue
| file-list-style | `Object` | `undefined` | The style of file list area | |
| file-list | `Array<UploadFileInfo>` | `undefined` | The file list of component. If set, the component will work in controlled manner. | |
| headers | `Object \| ({ file: UploadFileInfo }) => Object` | `undefined` | The additional HTTP Headers of request. | |
| input-props | `Object` | `undefined` | Attributes of file input. | 2.24.2 |
| input-props | `InputHTMLAttributes` | `undefined` | Attributes of file input. | 2.24.2 |
| image-group-props | `ImageGroupProps` | `undefined` | Props of `n-image` inside upload. See [ImageGroup Props](image#ImageGroup-Props). | 2.24.0 |
| is-error-state | `(xhr: XMLHttpRequest) => boolean` | `undefined` | Check if response is error state. | 2.29.1 |
| list-type | `string` | `'text'` | Built-in styles for file lists, `text`, `image` and `image-card`. | |

View File

@ -42,7 +42,7 @@ debug.vue
| file-list | `Array<UploadFileInfo>` | `undefined` | 文件列表,如果传入组件会处于受控状态 | |
| headers | `Object \| ({ file: UploadFileInfo }) => Object` | `undefined` | HTTP 请求需要附加的 Headers | |
| image-group-props | `ImageGroupProps` | `undefined` | Upload 中预览图片组件的属性,参考 [ImageGroup Props](image#ImageGroup-Props) | 2.24.0 |
| input-props | `Object` | `undefined` | file input 元素的属性 | 2.24.2 |
| input-props | `InputHTMLAttributes` | `undefined` | file input 元素的属性 | 2.24.2 |
| is-error-state | `(xhr: XMLHttpRequest) => boolean` | `undefined` | 判断请求是否为异常状态 | 2.29.1 |
| list-type | `string` | `'text'` | 文件列表的内建样式,`text`、`image` 和 `image-card` | |
| max | `number` | `undefined` | 限制上传文件数量 | |

View File

@ -31,7 +31,7 @@ keep-alive.vue
| key-field | `string` | `'key'` | Field name of option key. | 2.36.0 |
| padding-top | `string \| number` | `undefined` | Distance from the top. | 2.36.0 |
| padding-bottom | `string \| number` | `undefined` | Distance from the bottom. | 2.36.0 |
| scrollbar-props | `object` | `undefined` | Attribute reference [Scrollbar props](scrollbar#Scrollbar-Props). | 2.36.0 |
| scrollbar-props | `ScrollbarProps` | `undefined` | Attribute reference [Scrollbar props](scrollbar#Scrollbar-Props). | 2.36.0 |
| visible-items-tag | `string` | `'div'` | Items container tag. | 2.36.0 |
| visible-items-props | `object` | `undefined` | Items container prop. | 2.36.0 |
| on-scroll | `(event: Event) => void` | `undefined` | Scrolling callback function. | 2.36.0 |