diff --git a/packages/devui-vue/docs/components/auto-complete/index.md b/packages/devui-vue/docs/components/auto-complete/index.md index 496d91a09f..1cdc2aa8f8 100644 --- a/packages/devui-vue/docs/components/auto-complete/index.md +++ b/packages/devui-vue/docs/components/auto-complete/index.md @@ -453,15 +453,15 @@ d-auto-complete 参数 | disabledKey | `string` | -- | 可选，禁用单个选项，当传入资源 source 选项类型为对象，比如设置为'disabled'，则当对象的 disable 属性为 true 时，比如{ label: xxx, disabled: true }，该选项将禁用 | [自定义数据匹配方法](#自定义数据匹配方法) | | itemTemplate | `slot` | -- | 可选，自定义展示模板。slotProps：{ index: 下标索引, item: 当前项内容 }。 | [自定义模板展示](#自定义模板展示) | | noResultItemTemplate | `slot` | -- | 可选，没有匹配项的展示结果。slotProps：输入内容。 | [自定义模板展示](#自定义模板展示) | -| formatter | `(item: any) => string` | [`defaultFormatter`](#defaultformatter) | 可选，格式化函数 | [自定义数据匹配方法](#自定义数据匹配方法) | +| formatter | `(item: any) => string` | [`defaultFormatter`](#defaultFormatter) | 可选，格式化函数 | [自定义数据匹配方法](#自定义数据匹配方法) | | isSearching | `boolean` | false | 可选，是否在搜索中，用于控制 searchingTemplate 是否显示 | [自定义数据匹配方法](#自定义数据匹配方法) | | searchingTemplate | `slot` | -- | 可选，自定义搜索中显示模板。slotProps：输入内容。 | [自定义数据匹配方法](#自定义数据匹配方法) | -| sceneType | `string` | -- | 可选，值为 'select'、'suggest' | [启用懒加载](demo#auto-lazy-load) | -| searchFn | `(term: string) => Array` | [`defaultSearchFn`](#defaultsearchfn) | 可选，自定义搜索过滤 | [自定义数据匹配方法](#自定义数据匹配方法) | -| tipsText | `string` | '最近输入' | 可选，提示文字 | [设置禁用](demo#auto-disable) | -| latestSource | `Array` | -- | 可选， 最近输入 | [最近输入](demo#auto-latest) | -| valueParser | `(item: any) => any` | [`defaultValueParse`](#defaultvalueparse) | 可选， 对选中后数据进行处理 | [启用懒加载](demo#auto-lazy-load) | -| enableLazyLoad | `boolean` | false | 可选，是否允许懒加载 | [启用懒加载](demo#auto-lazy-load) | +| sceneType | `string` | -- | 可选，值为 'select'、'suggest' | [启用懒加载](#启用懒加载) | +| searchFn | `(term: string) => Array` | [`defaultSearchFn`](#defaultSearchFn) | 可选，自定义搜索过滤 | [自定义数据匹配方法](#自定义数据匹配方法) | +| tipsText | `string` | '最近输入' | 可选，提示文字 | [设置禁用](#设置禁用) | +| latestSource | `Array` | -- | 可选， 最近输入 | [最近输入](#最近输入) | +| valueParser | `(item: any) => any` | [`defaultValueParse`](#defaultValueParse) | 可选， 对选中后数据进行处理 | [懒加载](#懒加载) | +| enableLazyLoad | `boolean` | false | 可选，是否允许懒加载 | [懒加载](#懒加载) | | dAutoCompleteWidth | `number` | -- | 可选，调整宽度（`px`） |[基本用法](#基本用法) | showAnimation | `boolean` | true | 可选，是否开启动画 | | ✔ | | | @@ -469,7 +469,7 @@ d-auto-complete 事件 | 参数 | 类型 | 说明 | 跳转 Demo | | :-----------------: | :----------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------- | -| loadMore | `EventEmitter>` | 懒加载触发事件，配合`enableLazyLoad`使用，使用`$event.loadFinish()`关闭 loading 状态，其中\$event 为 AutoCompletePopupComponent 的实例 | [启用懒加载](demo#auto-lazy-load) | +| loadMore | `EventEmitter>` | 懒加载触发事件，配合`enableLazyLoad`使用，使用`$event.loadFinish()`关闭 loading 状态，其中\$event 为 AutoCompletePopupComponent 的实例 | [懒加载](#懒加载) | | selectValue | `EventEmitter` | 可选，选择选项之后的回调函数 | [基本用法](#基本用法) | | transInputFocusEmit | `EventEmitter` | 可选，Input focus 时回调函数 | [基本用法](#基本用法) | diff --git a/packages/devui-vue/docs/en-US/components/auto-complete/api-en.md b/packages/devui-vue/docs/en-US/components/auto-complete/api-en.md index ad5f795303..10cdc97d1a 100644 --- a/packages/devui-vue/docs/en-US/components/auto-complete/api-en.md +++ b/packages/devui-vue/docs/en-US/components/auto-complete/api-en.md @@ -444,34 +444,34 @@ d-auto-complete Parameter | Parameter | Type | Default | Description | Jump to Demo | Global Config | | :--------------------: | :-------------------------------------------------: | :----------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------- | ---------- | -| source | `Array` | -- | Required. This parameter is optional if searchFn is specified. | [Basic usage](#Basic usage) | -| allowEmptyValueSearch | `boolean` | false | Optional. indicates whether to display a search message when the bound text box value is empty. | [Basic usage](#Basic usage) | -| appendToBody | `boolean` | false | Optional. Whether to append to body is displayed in the drop-down list box. | [Basic usage](#Basic usage) | -| appendToBodyDirections | `Object as PropType` | `{originX: 'left',originY: 'bottom',overlayX: 'left',overlayY: 'top',}` | Optional. Specify the relative position of the drop-down box and the input box. for details about ConnectionPosition, see Overlay | [Basic usage](#Basic usage) | +| source | `Array` | -- | Required. This parameter is optional if searchFn is specified. | [Basic usage](#Basic-usage) | +| allowEmptyValueSearch | `boolean` | false | Optional. indicates whether to display a search message when the bound text box value is empty. | [Basic usage](#Basic-usage) | +| appendToBody | `boolean` | false | Optional. Whether to append to body is displayed in the drop-down list box. | [Basic usage](#Basic-usage) | +| appendToBodyDirections | `Object as PropType` | `{originX: 'left',originY: 'bottom',overlayX: 'left',overlayY: 'top',}` | Optional. Specify the relative position of the drop-down box and the input box. for details about ConnectionPosition, see Overlay | [Basic usage](#Basic-usage) | | disabled | `boolean` | false | Optional. Indicating whether to disable commands. | [Disabled](#Disabled) | -| delay | `number` | 300 | Optional. The search is performed only after the delay time elapses and a new value is entered. (ms) | [Basic usage](#Basic usage) | -| disabledKey | `string` | -- | Optional. Disable a single option. If the input resource source option type is an object, for example, disabled, and the disable attribute of the object is true, for example, {label: xxx, disabled: true}, this option will be disabled | [Customized data matching method](#Customized data matching method) | -| itemTemplate | `slot` | -- | Optional. Customized display template | [Customized template display](#Customized template display) | -| noResultItemTemplate | `slot` | -- | Optional. No matching item is displayed. | [Customized template display](#Customized template display) | -| formatter | `(item: any) => string` | [`defaultFormatter`](#defaultformatter) | Optional. Formatting function | [Customized data matching method](#Customized data matching method) | -| isSearching | `boolean` | false | Optional. indicating whether the search template is displayed. | [Customized data matching method](#Customized data matching method) | -| searchingTemplate | `slot` | -- | Optional. The template is displayed in customized search. | [Customized data matching method](#Customized data matching method) | -| sceneType | `string` | -- | Optional. The value can be select or suggestion. | [Enable lazy load](demo#auto-lazy-load) | -| searchFn | `(term: string) => Array` | [`defaultSearchFn`](#defaultsearchfn) | Optional. Customized search filtering | [Customized data matching method](#Customized data matching method) | -| tipsText | `string` | 'Latest input' | Optional. prompt text | [Disabled](demo#auto-disable) | -| latestSource | `Array` | -- | Optional. Latest input | [Latest input](demo#auto-latest) | -| valueParser | `(item: any) => any` | [`defaultValueParse`](#defaultvalueparse) | (optional) Process selected data | [Enable lazy load](demo#auto-lazy-load) | -| enableLazyLoad | `boolean` | false | Optional. Whether lazy loading is allowed | [Enable lazy load](demo#auto-lazy-load) | -| dAutoCompleteWidth | `number` | -- | Optional. Adjust the width (px) |[Basic usage](#Basic usage) +| delay | `number` | 300 | Optional. The search is performed only after the delay time elapses and a new value is entered. (ms) | [Basic usage](#Basic-usage) | +| disabledKey | `string` | -- | Optional. Disable a single option. If the input resource source option type is an object, for example, disabled, and the disable attribute of the object is true, for example, {label: xxx, disabled: true}, this option will be disabled | [Customized data matching method](#Customized-data-matching-method) | +| itemTemplate | `slot` | -- | Optional. Customized display template | [Customized template display](#Customized-template-display) | +| noResultItemTemplate | `slot` | -- | Optional. No matching item is displayed. | [Customized template display](#Customized-template-display) | +| formatter | `(item: any) => string` | [defaultFormatter](#defaultFormatter) | Optional. Formatting function | [Customized data matching method](#Customized-data-matching-method) | +| isSearching | `boolean` | false | Optional. indicating whether the search template is displayed. | [Customized data matching method](#Customized-data-matching-method) | +| searchingTemplate | `slot` | -- | Optional. The template is displayed in customized search. | [Customized data matching method](#Customized-data-matching-method) | +| sceneType | `string` | -- | Optional. The value can be select or suggestion. | [Enable lazy load](#Enable-lazy-load) | +| searchFn | `(term: string) => Array` | [defaultSearchFn](#defaultSearchFn) | Optional. Customized search filtering | [Customized data matching method](#Customized-data-matching-method) | +| tipsText | `string` | 'Latest input' | Optional. prompt text | [Disabled](#Disabled) | +| latestSource | `Array` | -- | Optional. Latest input | [Latest input](#Latest-input) | +| valueParser | `(item: any) => any` | [defaultValueParse](#defaultValueParse) | (optional) Process selected data | [Enable lazy load](#Enable-lazy-load) | +| enableLazyLoad | `boolean` | false | Optional. Whether lazy loading is allowed | [Enable lazy load](#Enable-lazy-load) | +| dAutoCompleteWidth | `number` | -- | Optional. Adjust the width (px) |[Basic usage](#Basic-usage) | showAnimation | `boolean` | true | optional. Whether to enable animation. | | ✔ | | | dAutoComplete Event | Parameter | Type | Description | Jump to Demo | | :-----------------: | :----------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------- | -| loadMore | `EventEmitter>` | : optional. It is a lazy loading trigger event. It is used together with enableLazyLoad. `$event.loadFinish()` is used to disable the loading status. $event is the instance of the pop-up component AutoCompletePopupComponent | [Enable lazy load](demo#auto-lazy-load) | -| selectValue | `EventEmitter` | (optional), callback function after selecting an option数 | [Basic usage](#Basic usage) | -| transInputFocusEmit | `EventEmitter` | (optional). Callback function for input focus | [Basic usage](#Basic usage) | +| loadMore | `EventEmitter>` | : optional. It is a lazy loading trigger event. It is used together with enableLazyLoad. `$event.loadFinish()` is used to disable the loading status. $event is the instance of the pop-up component AutoCompletePopupComponent | [Enable lazy load](#Enable-lazy-load) | +| selectValue | `EventEmitter` | (optional), callback function after selecting an option数 | [Basic usage](#Basic-usage) | +| transInputFocusEmit | `EventEmitter` | (optional). Callback function for input focus | [Basic usage](#Basic-usage) | # Interface & Type Definition