docs: fix all callback [=> any] to [ => void]

This commit is contained in:
07akioni 2021-03-18 15:30:12 +08:00
parent 08edf65455
commit d66e00eede
63 changed files with 164 additions and 164 deletions

View File

@ -25,10 +25,10 @@ after-select
| placeholder | `string` | `'Please Input'` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `string` | `undefined` | |
| on-blur | `(event: FocusEvent) => any` | `undefined` | |
| on-focus | `(event: FocusEvent) => any` | `undefined` | |
| on-select | `(value: string) => any` | `undefined` | |
| on-update:value | `(value: string \| null) => any` | `undefined` | |
| on-blur | `(event: FocusEvent) => void` | `undefined` | |
| on-focus | `(event: FocusEvent) => void` | `undefined` | |
| on-select | `(value: string) => void` | `undefined` | |
| on-update:value | `(value: string \| null) => void` | `undefined` | |
### AutoCompleteOption Properties
@ -51,4 +51,4 @@ after-select
| Name | Parameters | Description |
| --- | --- | --- |
| default | `(options: { handleInput: (value: string) => any, handleFocus: function, handleBlur: function, value: string, theme: string \| null })` | |
| default | `(options: { handleInput: (value: string) => void, handleFocus: function, handleBlur: function, value: string, theme: string \| null })` | |

View File

@ -25,10 +25,10 @@ after-select
| placeholder | `string` | `'请输入'` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `string` | `undefined` | |
| on-blur | `(event: FocusEvent) => any` | `undefined` | |
| on-focus | `(event: FocusEvent) => any` | `undefined` | |
| on-select | `(value: string) => any` | `undefined` | |
| on-update:value | `(value: string \| null) => any` | `undefined` | |
| on-blur | `(event: FocusEvent) => void` | `undefined` | |
| on-focus | `(event: FocusEvent) => void` | `undefined` | |
| on-select | `(value: string) => void` | `undefined` | |
| on-update:value | `(value: string \| null) => void` | `undefined` | |
### AutoCompleteOption Properties
@ -51,4 +51,4 @@ after-select
| 名称 | 参数 | 说明 |
| --- | --- | --- |
| default | `(options: { handleInput: (value: string) => any, handleFocus: function, handleBlur: function, value: string, theme: string \| null })` | |
| default | `(options: { handleInput: (value: string) => void, handleFocus: function, handleBlur: function, value: string, theme: string \| null })` | |

View File

@ -25,4 +25,4 @@ target-container-selector
| show | `boolean` | `undefined` | Whether to show BackTop |
| to | `string \| HTMLElement` | `'body'` | Container node to show BackTop |
| visibility-height | `number` | `180` | |
| on-update:show | `(value: boolean) => any` | `undefined` | |
| on-update:show | `(value: boolean) => void` | `undefined` | |

View File

@ -25,4 +25,4 @@ target-container-selector
| show | `boolean` | `undefined` | 是否显示 BackTop受控 |
| to | `string \| HTMLElement` | `'body'` | BackTop 渲染的容器节点 |
| visibility-height | `number` | `180` | |
| on-update:show | `(value: boolean) => any` | `undefined` | |
| on-update:show | `(value: boolean) => void` | `undefined` | |

View File

@ -27,7 +27,7 @@ closable
| segmented | `boolean \| { [part in 'content' \| 'footer' \| 'action']?: boolean \| 'soft' \| 'hard' }` | `false` | |
| size | `'small' \| 'medium' \| 'large' \| 'huge'` | `'medium'` | |
| title | `string` | `undefined` | |
| on-close | `() => any` | `undefined` | |
| on-close | `() => void` | `undefined` | |
## Slots

View File

@ -27,7 +27,7 @@ closable
| segmented | `boolean \| { [part in 'content' \| 'footer' \| 'action']?: boolean \| 'soft' \| 'hard' }` | `false` | |
| size | `'small' \| 'medium' \| 'large' \| 'huge'` | `'medium'` | |
| title | `string` | `undefined` | |
| on-close | `() => any` | `undefined` | 点击卡片关闭图标时的回调 |
| on-close | `() => void` | `undefined` | 点击卡片关闭图标时的回调 |
## Slots

View File

@ -33,10 +33,10 @@ multiple-lazy
| show-path | `boolean` | `true` | Whether to show path in selector. |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `string \| number \| Array<number \| string> \| null` | `undefined` | |
| on-blur | `() => any` | `undefined` | |
| on-focus | `() => any` | `undefined` |
| on-blur | `() => void` | `undefined` | |
| on-focus | `() => void` | `undefined` |
| on-load | `(option: CascaderOption) => Promise<any>` | `undefined` | Callback when click unloaded node. Set `option.children` in the returned promise. Loading is end after the promise is resolved or rejected. |
| on-update:value | `(value: string \| number \| Array<string \| number> \| null) => any` | `undefined` | |
| on-update:value | `(value: string \| number \| Array<string \| number> \| null) => void` | `undefined` | |
## API

View File

@ -33,10 +33,10 @@ multiple-lazy
| show-path | `boolean` | `true` | 是否在选择器中显示选项路径 |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `string \| number \| Array<number \| string>` | `undefined` | |
| on-blur | `() => any` | `undefined` | |
| on-focus | `() => any` | `undefined` | |
| on-blur | `() => void` | `undefined` | |
| on-focus | `() => void` | `undefined` | |
| on-load | `(option: CascaderOption) => Promise<any>` | `undefined` | 在点击未加载完成节点时的回调,在返回的 promise 中设定 `option.children`,在返回的 promise resolve 或 reject 之后完成加载 |
| on-update:value | `(value: string \| number \| Array<string \| number> \| null) => any` | `undefined` | |
| on-update:value | `(value: string \| number \| Array<string \| number> \| null) => void` | `undefined` | |
## API

View File

@ -24,8 +24,8 @@ item-header-click
| default-expanded-names | `string \| number \| Array<string \| number> \| null` | `null` | If set to `accrodion`, it will be a non-array value. |
| display-directive | `'if' \| 'show'` | `'if'` | The display directive to use when its inner `n-collapse-item` render content. `'if'` corresponds to `v-if` and `'show'` corresponds to `v-show`. |
| expanded-names | `string \| number \| Array<string \| number> \| null` | `undefined` | If set to `accrodion`, it will be a non-array value. |
| on-update:expanded-names | `(expandedNames: Array<string \| number> \| string \| number \| null) => any` | `undefined` | |
| on-item-header-click | `(data: { name: string \| number, expanded: boolean, event: MouseEvent }) => any` | `undefined` | |
| on-update:expanded-names | `(expandedNames: Array<string \| number> \| string \| number \| null) => void` | `undefined` | |
| on-item-header-click | `(data: { name: string \| number, expanded: boolean, event: MouseEvent }) => void` | `undefined` | |
### Collapse Item Props

View File

@ -24,8 +24,8 @@ item-header-click
| default-expanded-names | `string \| number \| Array<string \| number> \| null` | `null` | `accordion` 模式时不为数组 |
| display-directive | `'if' \| 'show'` | `'if'` | 内部 `n-collapse-item` 在控制内容是否渲染时使用的指令,`'if'` 对应 `v-if``'show'` 对应 `v-show` |
| expanded-names | `string \| number \| Array<string \| number> \| null` | `undefined` | `accordion` 模式时不为数组 |
| on-update:expanded-names | `(expandedNames: Array<string \| number> \| string \| number \| null) => any` | `undefined` | |
| on-item-header-click | `(data: { name: string \| number, expanded: boolean, event: MouseEvent }) => any` | `undefined` | |
| on-update:expanded-names | `(expandedNames: Array<string \| number> \| string \| number \| null) => void` | `undefined` | |
| on-item-header-click | `(data: { name: string \| number, expanded: boolean, event: MouseEvent }) => void` | `undefined` | |
### Collapse Item Props

View File

@ -12,7 +12,7 @@ basic
| Name | Parameters | Default | Description |
| --- | --- | --- | --- |
| on-namespace-change | `(namespace: string) => any` | `undefined` | |
| on-namespace-change | `(namespace: string) => void` | `undefined` | |
## Slots

View File

@ -12,9 +12,9 @@ color-debug
## Props
| 名称 | 参数 | 默认值 | 说明 |
| ------------------- | ---------------------------- | ----------- | ---- |
| on-namespace-change | `(namespace: string) => any` | `undefined` | |
| 名称 | 参数 | 默认值 | 说明 |
| ------------------- | ----------------------------- | ----------- | ---- |
| on-namespace-change | `(namespace: string) => void` | `undefined` | |
## Slots

View File

@ -51,11 +51,11 @@ custom-filter-menu
| single-column | `boolean` | `false` | |
| single-line | `boolean` | `true` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| on-update:checked-row-keys | `(keys: Array<string \| number>) => any` | `undefined` | |
| on-update:checked-row-keys | `(keys: Array<string \| number>) => void` | `undefined` | |
| on-update:filters | `(filters: { [string \| number]: Array<string \| number> \| string \| number }, initiatorColumn: Column)` | |
| on-update:page | `(page: number)` | `undefined` | |
| on-update:page-size | `(pageSize: number) => any` | `undefined` | |
| on-update:sorter | `(options: { columnKey: string \| number, sorter: 'default' \| function \| boolean, order: 'ascend' \| 'descend' \| false } \| null) => any` | `undefined` | If there won't be a active sorter after change, `options` will be `null` |
| on-update:page-size | `(pageSize: number) => void` | `undefined` | |
| on-update:sorter | `(options: { columnKey: string \| number, sorter: 'default' \| function \| boolean, order: 'ascend' \| 'descend' \| false } \| null) => void` | `undefined` | If there won't be a active sorter after change, `options` will be `null` |
## Methods

View File

@ -51,11 +51,11 @@ custom-filter-menu
| single-column | `boolean` | `false` | |
| single-line | `boolean` | `true` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| on-update:checked-row-keys | `(keys: Array<string \| number>) => any` | `undefined` | |
| on-update:checked-row-keys | `(keys: Array<string \| number>) => void` | `undefined` | |
| on-update:filters | `(filters: { [string \| number]: Array<string \| number> \| string \| number }, initiatorColumn: Column)` | |
| on-update:page | `(page: number)` | `undefined` | |
| on-update:page-size | `(pageSize: number) => any` | `undefined` | |
| on-update:sorter | `(options: { columnKey: string \| number, sorter: 'default' \| function \| boolean, order: 'ascend' \| 'descend' \| false } \| null) => any` | `undefined` | 如果在变动后没有激活的排序,那么 `options``null` |
| on-update:page-size | `(pageSize: number) => void` | `undefined` | |
| on-update:sorter | `(options: { columnKey: string \| number, sorter: 'default' \| function \| boolean, order: 'ascend' \| 'descend' \| false } \| null) => void` | `undefined` | 如果在变动后没有激活的排序,那么 `options``null` |
## Methods

View File

@ -29,8 +29,8 @@ format
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| type | `'date' \| 'datetime' \| 'daterange' \|'datetimerange'` | `'date'` | |
| value | `number \| [number, number] \| null` | `undefined` | |
| on-blur | `() => any` | `undefined` | |
| on-focus | `() => any` | `undefined` | |
| on-blur | `() => void` | `undefined` | |
| on-focus | `() => void` | `undefined` | |
### Date Type Props
@ -40,7 +40,7 @@ format
| format | `string` | `'yyyy-MM-dd'` | |
| is-date-disabled | `(current: number) => boolean` | `() => false` | |
| placeholder | `string` | `'Select Date'` | |
| on-update:value | `(value: number \| null) => any` | `undefined` | |
| on-update:value | `(value: number \| null) => void` | `undefined` | |
### DateTime Type Props
@ -51,7 +51,7 @@ format
| is-date-disabled | `(current: number) => boolean` | `() => false` | |
| is-time-disabled | `(current: number) => { isHourDisabled?: () => boolean, isMinuteDisabled?: () => boolean, isSecondDisabled?: () => boolean }` | `undefined` | |
| placeholder | `string` | `'Select Date and Time'` | |
| on-update:value | `(value: number \| null) => any` | `undefined` | |
| on-update:value | `(value: number \| null) => void` | `undefined` | |
### DateRange Type Props
@ -64,7 +64,7 @@ format
| is-time-disabled | `(current: number, phase: 'start' \| 'end', value: [number, number] | null) => { isHourDisabled?: () => boolean, isMinuteDisabled?: () => boolean, isSecondDisabled?: () => boolean }` | `undefined` | |
| separator | `string` | `'to'` | |
| start-placeholder | `string` | `'Start Date'` | |
| on-update:value | `(value: [number, number] \| null) => any` | `undefined` | |
| on-update:value | `(value: [number, number] \| null) => void` | `undefined` | |
### DateTimeRange Type Props
@ -77,4 +77,4 @@ format
| is-time-disabled | `(current: number, phase: 'start' \| 'end', value: [number, number]) => { isHourDisabled?: () => boolean, isMinuteDisabled?: () => boolean, isSecondDisabled?: () => boolean }` | `undefined` | |
| separator | `string` | `'to'` | |
| start-placeholder | `string` | `'Start Date and Time'` | |
| on-update:value | `(value: [number, number] \| null) => any` | `undefined` | |
| on-update:value | `(value: [number, number] \| null) => void` | `undefined` | |

View File

@ -29,8 +29,8 @@ format
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| type | `'date' \| 'datetime' \| 'daterange' \|'datetimerange'` | `'date'` | |
| value | `number \| [number, number] \| null` | `undefined` | |
| on-blur | `() => any` | `undefined` | |
| on-focus | `() => any` | `undefined` | |
| on-blur | `() => void` | `undefined` | |
| on-focus | `() => void` | `undefined` | |
### Date 类型的 Props
@ -40,7 +40,7 @@ format
| format | `string` | `'yyyy-MM-dd'` | |
| is-date-disabled | `(current: number) => boolean` | `undefined` | |
| placeholder | `string` | `'选择日期'` | |
| on-update:value | `(value: number \| null) => any` | `undefined` | |
| on-update:value | `(value: number \| null) => void` | `undefined` | |
### DateTime 类型的 Props
@ -51,7 +51,7 @@ format
| is-date-disabled | `(current: number) => boolean` | `undefined` | |
| is-time-disabled | `(current: number) => { isHourDisabled: boolean, isMinuteDisabled: boolean, isSecondDisabled: boolean }` | `undefined` | |
| placeholder | `string` | `'选择日期时间'` | |
| on-update:value | `(value: number \| null) => any` | `undefined` | |
| on-update:value | `(value: number \| null) => void` | `undefined` | |
### DateRange 类型的 Props
@ -64,7 +64,7 @@ format
| is-time-disabled | `(current: number, phase: 'start' \| 'end', value: [number, number] | null) => { isHourDisabled?: () => boolean, isMinuteDisabled?: () => boolean, isSecondDisabled?: () => boolean }` | `undefined` | |
| separator | `string` | `'至'` | |
| start-placeholder | `string` | `'开始日期'` | |
| on-update:value | `(value: [number, number] \| null) => any` | `undefined` | |
| on-update:value | `(value: [number, number] \| null) => void` | `undefined` | |
### DateTimeRange 类型的 Props
@ -77,4 +77,4 @@ format
| is-time-disabled | `(current: number, phase: 'start' \| 'end', value: [number, number]) => { isHourDisabled?: () => boolean, isMinuteDisabled?: () => boolean, isSecondDisabled?: () => boolean }` | `undefined` | |
| separator | `string` | `'to'` | |
| start-placeholder | `string` | `'开始日期时间'` | |
| on-update:value | `(value: [number, number] \| null) => any` | `undefined` | |
| on-update:value | `(value: [number, number] \| null) => void` | `undefined` | |

View File

@ -120,9 +120,9 @@ All the properties can be modified dynamically.
| show-icon | `boolean` | `true` | |
| title | `string \| (() => VNode \| Array<VNode>)` | `undefined` | Can be a render function. |
| type | `'error \| 'success' \| 'warning'` | `'warning'` | |
| on-close | `() => any` | |
| on-negative-click | `() => any` | |
| on-positive-click | `() => any` | |
| on-close | `() => void` | |
| on-negative-click | `() => void` | |
| on-positive-click | `() => void` | |
## Slots

View File

@ -119,9 +119,9 @@ use-component
| show-icon | `boolean` | `true` | |
| title | `string \| (() => VNode \| Array<VNode>)` | `undefined` | 可以是 render 函数 |
| type | `'error \| 'success' \| 'warning'` | `'warning'` | |
| on-close | `() => any` | |
| on-negative-click | `() => any` | |
| on-positive-click | `() => any` | |
| on-close | `() => void` | |
| on-negative-click | `() => void` | |
| on-positive-click | `() => void` | |
## Slots

View File

@ -21,7 +21,7 @@ target
| show | `boolean` | `false` | |
| to | `string \| HTMLElement` | `'body'` | Container node of the drawer. |
| width | `number \| string` | `251` | |
| on-update:show | `(show: boolean) => any` | `undefined` | |
| on-update:show | `(show: boolean) => void` | `undefined` | |
## Slots

View File

@ -25,7 +25,7 @@ dark-4-debug
| show | `boolean` | `false` | |
| to | `string \| HTMLElement` | `'body'` | 抽屉出现的区域 |
| width | `number \| string` | `251` | |
| on-update:show | `(show: boolean) => any` | `undefined` | |
| on-update:show | `(show: boolean) => void` | `undefined` | |
## Slots

View File

@ -21,7 +21,7 @@ manual-position
| keyboard | `boolean` | `true` | Whether is supports keyboard operation. (Be careful about the potential conflicts with other components keyboard operations) |
| options | `Array<DropdownOption \| DropdownDivider \| DropdownSubmenu>` | `[]` | |
| size | `'small'\|'medium'\|'large'\|'huge'` | `'medium'` | |
| on-select | `(key: string \| number) => any` | `undefined` | |
| on-select | `(key: string \| number) => void` | `undefined` | |
For other props, see [Popover Props](n-popover#Props). Note that `arrow`, `raw` is not available.

View File

@ -22,7 +22,7 @@ group-debug
| keyboard | `boolean` | `true` | 是否支持键盘操作(注意和其他内容键盘操作可能的冲突) |
| options | `Array<DropdownOption \| DropdownDivider \| DropdownSubmenu>` | `[]` | |
| size | `'small'\|'medium'\|'large'\|'huge'` | `'medium'` | |
| on-select | `(key: string \| number) => any` | `undefined` | |
| on-select | `(key: string \| number) => void` | `undefined` | |
对于其他 Props参考 [Popover Props](n-popover#Props)。注意 `arrow`, `raw` 属性不可用。

View File

@ -28,7 +28,7 @@ form
| max | `number` | `undefined` | Max number of items. |
| preset | `'input' \| 'preset'` | `'input'` | The preset of `n-dynamic-input`, it work when `$slots.default` is not set. |
| value | `Array<any>` | `undefined` | |
| on-create | `(index: number) => any` | `undefined` | The callback when click at the add button. If set, the return value will be used as the initial value of the new item. `index` is the the new item's corresponding index in the value array, which starts from 1 (the second item). |
| on-create | `(index: number) => void` | `undefined` | The callback when click at the add button. If set, the return value will be used as the initial value of the new item. `index` is the the new item's corresponding index in the value array, which starts from 1 (the second item). |
### Dynamic Input Props (Input Preset)

View File

@ -28,9 +28,9 @@ form
| max | `number` | `undefined` | 最多有几项内容 |
| preset | `'input' \| 'preset'` | `'input'` | 动态录入使用的预设,在不设定 `$slots.default` 的时候生效。 |
| value | `Array<any>` | `undefined` | |
| on-create | `(index: number) => any` | `undefined` | 点击添加按钮时的回调,如果设定则返回值会被用作新添加的初始值。其中 `index` 是创建内容将要被放置到的位置对应的数组索引,从 1 (第二项)开始计算。 |
| on-remove | `() => any` | `undefined` | |
| on-update:value | `(value: any) => any` | `undefined` | |
| on-create | `(index: number) => void` | `undefined` | 点击添加按钮时的回调,如果设定则返回值会被用作新添加的初始值。其中 `index` 是创建内容将要被放置到的位置对应的数组索引,从 1 (第二项)开始计算。 |
| on-remove | `() => void` | `undefined` | |
| on-update:value | `(value: any) => void` | `undefined` | |
### Dynamic Input Props(Input Preset)

View File

@ -22,4 +22,4 @@ form
| tag-style | `string \| Object` | `undefined` | |
| type | `'default' \| 'info' \| 'success' \| 'warning' \| 'error'` | `'default'` | |
| value | `string[]` | `undefined` | |
| on-update:value | `(value: boolean) => any` | `undefined` | |
| on-update:value | `(value: boolean) => void` | `undefined` | |

View File

@ -22,4 +22,4 @@ form
| tag-style | `string \| Object` | `undefined` | |
| type | `'default' \| 'info' \| 'success' \| 'warning' \| 'error'` | `'default'` | |
| value | `string[]` | `undefined` | |
| on-update:value | `(value: boolean) => any` | `undefined` | |
| on-update:value | `(value: boolean) => void` | `undefined` | |

View File

@ -83,14 +83,14 @@ Accept all props from form-item & [Col](n-row#Col-Props)
| Name | Type | Description |
| --- | --- | --- |
| validate | `(validateCallback?: (errors?: Array<ValidationError>) => any, shouldRuleBeApplied?: FormItemRule => boolean) => Promise<void>` | Validate the form. The rejection value type of returned promise is `Array<ValidationError>`. |
| validate | `(validateCallback?: (errors?: Array<ValidationError>) => void, shouldRuleBeApplied?: FormItemRule => boolean) => Promise<void>` | Validate the form. The rejection value type of returned promise is `Array<ValidationError>`. |
| clearValidationEffect | `() => void` | |
### Form Item, Form Item Row, Form Item Col Methods
| Name | Type | Description |
| --- | --- | --- |
| validate | `(options: { trigger?: string, callback?: (errors?: Array<ValidationError>) => any, shouldRuleBeApplied?: FormItemRule => boolean, options?: AsyncValidatorOptions }) => Promise<void>` | Validate the form item. The rejection value type of returned promise is `Array<ValidationError>`. If trigger is not set, all rules of the item will be applied. `shouldRuleBeApplied` can filter rules after they are filtered by the trigger. |
| validate | `(options: { trigger?: string, callback?: (errors?: Array<ValidationError>) => void, shouldRuleBeApplied?: FormItemRule => boolean, options?: AsyncValidatorOptions }) => Promise<void>` | Validate the form item. The rejection value type of returned promise is `Array<ValidationError>`. If trigger is not set, all rules of the item will be applied. `shouldRuleBeApplied` can filter rules after they are filtered by the trigger. |
| clearValidationEffect | `() => void` | |
About AsyncValidatorOptions, see <n-a href="https://github.com/yiminghe/async-validator">async-validator</n-a>.

View File

@ -84,14 +84,14 @@ validator-debug
| 名称 | 类型 | 说明 |
| --- | --- | --- |
| validate | `(validateCallback?: (errors?: Array<ValidationError>) => any, shouldRuleBeApplied?: FormItemRule => boolean) => Promise<void>` | 验证表单。Promise rejection 的返回值类型是 `Array<ValidationError>`。 |
| validate | `(validateCallback?: (errors?: Array<ValidationError>) => void, shouldRuleBeApplied?: FormItemRule => boolean) => Promise<void>` | 验证表单。Promise rejection 的返回值类型是 `Array<ValidationError>`。 |
| clearValidationEffect | `() => void` | |
### FormItem, FormItemRow, FormItemCol Methods
| 名称 | 类型 | 说明 |
| --- | --- | --- |
| validate | `(options: { trigger?: string, callback?: (errors?: Array<ValidationError>) => any, shouldRuleBeApplied?: FormItemRule => boolean, options?: AsyncValidatorOptions }) => Promise<void>` | 验证表项Promise rejection 的返回值类型是 `Array<ValidationError>`。如果设定 `trigger`,这一个表项全部的规则都会被使用。`shouldRuleBeApplied` 可以用来进一步过滤已经经过 `trigger` 筛选的规则 |
| validate | `(options: { trigger?: string, callback?: (errors?: Array<ValidationError>) => void, shouldRuleBeApplied?: FormItemRule => boolean, options?: AsyncValidatorOptions }) => Promise<void>` | 验证表项Promise rejection 的返回值类型是 `Array<ValidationError>`。如果设定 `trigger`,这一个表项全部的规则都会被使用。`shouldRuleBeApplied` 可以用来进一步过滤已经经过 `trigger` 筛选的规则 |
| clearValidationEffect | `() => void` | |
关于 AsyncValidatorOptions参考 <n-a href="https://github.com/yiminghe/async-validator">async-validator</n-a>

View File

@ -27,6 +27,6 @@ validator
| step | `number` | `1` | |
| validator | `(value) => boolean` | `undefined` | |
| value | `number` | `undefined` | |
| on-blur | `(event: FocusEvent) => any` | `undefined` | |
| on-focus | `(event: FocusEvent) => any` | `undefined` | |
| on-update:value | `(value: number) => any` | `undefined` | |
| on-blur | `(event: FocusEvent) => void` | `undefined` | |
| on-focus | `(event: FocusEvent) => void` | `undefined` | |
| on-update:value | `(value: number) => void` | `undefined` | |

View File

@ -27,6 +27,6 @@ validator
| step | `number` | `1` | |
| validator | `(value) => boolean` | `undefined` | |
| value | `number \| null` | `undefined` | |
| on-blur | `(event: FocusEvent) => any` | `undefined` | |
| on-focus | `(event: FocusEvent) => any` | `undefined` | |
| on-update:value | `(value: number) => any` | `undefined` | |
| on-blur | `(event: FocusEvent) => void` | `undefined` | |
| on-focus | `(event: FocusEvent) => void` | `undefined` | |
| on-update:value | `(value: number) => void` | `undefined` | |

View File

@ -41,11 +41,11 @@ passively-activated
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| type | `'text' \| 'password' \| 'textarea'` | `'text'` | |
| value | `string \| [string, string] \| null` | `undefined` | Value of input. When `pair` is `true`, `value` is an array. |
| on-blur | `() => any` | `undefined` | |
| on-change | `(value: string \| [string, string]) => any` | `undefined` | |
| on-clear | `() => any` | `undefined` | |
| on-focus | `() => any` | `undefined` | |
| on-update:value | `(value: string \| [string, string]) => any` | `undefined` | |
| on-blur | `() => void` | `undefined` | |
| on-change | `(value: string \| [string, string]) => void` | `undefined` | |
| on-clear | `() => void` | `undefined` | |
| on-focus | `() => void` | `undefined` | |
| on-update:value | `(value: string \| [string, string]) => void` | `undefined` | |
## Slots

View File

@ -41,11 +41,11 @@ passively-activated
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| type | `'text' \| 'password' \| 'textarea'` | `'text'` | |
| value | `string \| [string, string] \| null` | `undefined` | 文本输入的值。如果是 `pair``true``value` 是一个数组 |
| on-blur | `() => any` | `undefined` | |
| on-change | `(value: string \| [string, string]) => any` | `undefined` | |
| on-clear | `() => any` | `undefined` | |
| on-focus | `() => any` | `undefined` | |
| on-update:value | `(value: string \| [string, string]) => any` | `undefined` | |
| on-blur | `() => void` | `undefined` | |
| on-change | `(value: string \| [string, string]) => void` | `undefined` | |
| on-clear | `() => void` | `undefined` | |
| on-focus | `() => void` | `undefined` | |
| on-update:value | `(value: string \| [string, string]) => void` | `undefined` | |
## Slots

View File

@ -62,9 +62,9 @@ loading
| log | `string` | `undefined` | |
| rows | `number` | `15` | |
| trim | `boolean` | `false` | |
| on-require-more | `(from: 'top' \| 'bottom') => any` | `undefined` | |
| on-reach-top | `() => any` | `undefined` | |
| on-reach-bottom | `() => any` | `undefined` | |
| on-require-more | `(from: 'top' \| 'bottom') => void` | `undefined` | |
| on-reach-top | `() => void` | `undefined` | |
| on-reach-bottom | `() => void` | `undefined` | |
## Methods

View File

@ -51,20 +51,20 @@ loading
## Props
| 名称 | 类型 | 默认值 | 说明 |
| --------------- | ---------------------------------- | ----------- | ---- |
| font-size | `number` | `14` | |
| hljs | `Object` | `undefined` | |
| language | `string` | `undefined` | |
| line-height | `number` | `1.25` | |
| lines | `Array<string>` | `undefined` | |
| loading | `boolean` | `false` | |
| log | `string` | `undefined` | |
| rows | `number` | `15` | |
| trim | `boolean` | `false` | |
| on-require-more | `(from: 'top' \| 'bottom') => any` | `undefined` | |
| on-reach-top | `() => any` | `undefined` | |
| on-reach-bottom | `() => any` | `undefined` | |
| 名称 | 类型 | 默认值 | 说明 |
| --------------- | ----------------------------------- | ----------- | ---- |
| font-size | `number` | `14` | |
| hljs | `Object` | `undefined` | |
| language | `string` | `undefined` | |
| line-height | `number` | `1.25` | |
| lines | `Array<string>` | `undefined` | |
| loading | `boolean` | `false` | |
| log | `string` | `undefined` | |
| rows | `number` | `15` | |
| trim | `boolean` | `false` | |
| on-require-more | `(from: 'top' \| 'bottom') => void` | `undefined` | |
| on-reach-top | `() => void` | `undefined` | |
| on-reach-bottom | `() => void` | `undefined` | |
## Methods

View File

@ -25,7 +25,7 @@ preset-confirm-slot
| preset | `'card' \| 'confirm'` | `undefined` | |
| show | `boolean` | `false` | Whether to show modal. |
| show-mask | `boolean` | `true` | Whether to show mask of the modal. |
| on-update:show | `(value: boolean) => any` | `undefined` | Callback when modal's display status is changed. |
| on-update:show | `(value: boolean) => void` | `undefined` | Callback when modal's display status is changed. |
### Modal with Preset Card

View File

@ -30,7 +30,7 @@ drawer-debug
| preset | `'card' \| 'dialog'` | `undefined` | 模态框使用何种预设 |
| show | `boolean` | `false` | 是否展示 Modal |
| show-mask | `boolean` | `true` | 是否展示 Modal 的遮罩 |
| on-update:show | `(value: boolean) => any` | `undefined` | 模态框更新是否展示状态的回调 |
| on-update:show | `(value: boolean) => void` | `undefined` | 模态框更新是否展示状态的回调 |
### ModalCard 预设)

View File

@ -27,5 +27,5 @@ disabled
| page | `number` | `undefined` | |
| show-quick-jumper | `boolean` | `false` | |
| show-size-picker | `boolean` | `false` | |
| on-update:page | `(page: number) => any` | `undefined` | |
| on-update:page-size | `(pageSize: number) => any` | `undefined` | |
| on-update:page | `(page: number) => void` | `undefined` | |
| on-update:page-size | `(pageSize: number) => void` | `undefined` | |

View File

@ -16,16 +16,16 @@ disabled
## Props
| 名称 | 类型 | 默认值 | 说明 |
| ------------------- | --------------------------- | ----------- | ---- |
| default-page | `number` | `1` | |
| default-page-size | `number` | `10` | |
| page-count | `number` | `1` | |
| page-sizes | `Array<number>` | `['10']` | |
| page-size | `number` | `undefined` | |
| page-slot | `number` | `9` | |
| page | `number` | `undefined` | |
| show-quick-jumper | `boolean` | `false` | |
| show-size-picker | `boolean` | `false` | |
| on-update:page | `(page: number) => any` | `undefined` | |
| on-update:page-size | `(pageSize: number) => any` | `undefined` | |
| 名称 | 类型 | 默认值 | 说明 |
| ------------------- | ---------------------------- | ----------- | ---- |
| default-page | `number` | `1` | |
| default-page-size | `number` | `10` | |
| page-count | `number` | `1` | |
| page-sizes | `Array<number>` | `['10']` | |
| page-size | `number` | `undefined` | |
| page-slot | `number` | `9` | |
| page | `number` | `undefined` | |
| show-quick-jumper | `boolean` | `false` | |
| show-size-picker | `boolean` | `false` | |
| on-update:page | `(page: number) => void` | `undefined` | |
| on-update:page-size | `(pageSize: number) => void` | `undefined` | |

View File

@ -37,7 +37,7 @@ manual-position
| trigger | `'hover' \| 'click'` | `'hover'` | |
| x | `number` | `undefined` | The CSS `left` pixel value when popover manually positioned. |
| y | `number` | `undefined` | The CSS `top` pixel value when popover manually positioned. |
| on-update:show | `(value: boolean) => any` | | |
| on-update:show | `(value: boolean) => void` | | |
## Slots

View File

@ -37,7 +37,7 @@ manual-position
| trigger | `'hover' \| 'click'` | `'hover'` | |
| x | `number` | `undefined` | 手动控制位置时填出内容的 CSS `left` 的像素值 |
| y | `number` | `undefined` | 手动控制位置时填出内容的 CSS `top` 的像素值 |
| on-update:show | `(value: boolean) => any` | | |
| on-update:show | `(value: boolean) => void` | | |
## Slots

View File

@ -20,7 +20,7 @@ multiple
| scrollable | `boolean` | `false` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `string \| number \| Array<string \| number> \| null` | `null` | |
| on-update:value | `(string \| number \| Array<string \| number> \| null) => any` | `undefined` | |
| on-update:value | `(string \| number \| Array<string \| number> \| null) => void` | `undefined` | |
For SelectOption & SelectGroupOption, see [Select](n-select#SelectOption-Type)

View File

@ -20,7 +20,7 @@ multiple
| scrollable | `boolean` | `false` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `string \| number \| Array<string \| number> \| null` | `null` | |
| on-update:value | `(string \| number \| Array<string \| number> \| null) => any` | `undefined` | |
| on-update:value | `(string \| number \| Array<string \| number> \| null) => void` | `undefined` | |
对于 SelectOption & SelectGroupOption参考 [Select](n-select#SelectOption-Type)

View File

@ -24,7 +24,7 @@ size
| name | `string` | `undefined` | The name attribute of the radio element. If not set, name of `radio-group` will be used. |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | 只用于 `n-radio` |
| value | `string` | `undefined` | |
| on-update:checked | `(check: boolean) => any` | `undefined` | |
| on-update:checked | `(check: boolean) => void` | `undefined` | |
### RadioGroup Props
@ -34,4 +34,4 @@ size
| name | `string` | `undefined` | The name attribute of the radio elements inside the group. |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `string \| null` | `null` | |
| on-update:value | `(value: string) => any` | `undefined` | |
| on-update:value | `(value: string) => void` | `undefined` | |

View File

@ -26,7 +26,7 @@ radio-focus-debug
| name | `string` | `undefined` | 单选按钮 radio 元素的 name 属性。如果没有设定会使用 `n-radio-group``name` |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | 只用于 `n-radio` |
| value | `string` | `undefined` | |
| on-update:checked-value | `(checked: boolean) => any` | `undefined` | |
| on-update:checked-value | `(checked: boolean) => void` | `undefined` | |
### RadioGroup Props
@ -36,4 +36,4 @@ radio-focus-debug
| name | `string` | `undefined` | 选项组内部 radio 元素的 name 属性 |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `string \| null` | `null` | |
| on-update:value | `(value: string) => any` | `undefined` | |
| on-update:value | `(value: string) => void` | `undefined` | |

View File

@ -8,9 +8,9 @@ basic
## Props
| 名称 | 类型 | 默认值 | 说明 |
| --------------- | ------------------------ | ----------- | ---- |
| count | `number` | `5` | |
| value | `number` | `undefined` | |
| default-value | `number` | `0` | |
| on-update:value | `(value: number) => any` | `undefined` | |
| 名称 | 类型 | 默认值 | 说明 |
| --------------- | ------------------------- | ----------- | ---- |
| count | `number` | `5` | |
| value | `number` | `undefined` | |
| default-value | `number` | `0` | |
| on-update:value | `(value: number) => void` | `undefined` | |

View File

@ -40,12 +40,12 @@ fallback-option
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| tag | `boolean` | `false` | Whether it can create new option, should be used with `filterable`. |
| value | `Array<string \| number> \| string \| number \| null` | `undefined` | |
| on-blur | `() => any` | Selection blur. |
| on-blur | `() => void` | Selection blur. |
| on-create | `(label: string) => SelectOption` | `label => ({ label, value: label })` | How to create a option when you input a string to create a option. Note that `filter` will be applied to the created option too. And make sure the value of the created option is not the same as any other option. |
| on-focus | `() => any` | Selection focus. |
| on-scroll | `(e: ScrollEvent) => any` | Menu scroll. |
| on-search | `(value: string) => any` | |
| on-update:value | `(value: Array \| string \| number \| null) => any` | |
| on-focus | `() => void` | Selection focus. |
| on-scroll | `(e: ScrollEvent) => void` | Menu scroll. |
| on-search | `(value: string) => void` | |
| on-update:value | `(value: Array \| string \| number \| null) => void` | |
### SelectOption Properties

View File

@ -43,12 +43,12 @@ menu-debug
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| tag | `boolean` | `false` | 是否可以创建新的选项,需要和 `filterable` 一起使用 |
| value | `Array<string \| number> \| string \| number \| null` | `undefined` | |
| on-blur | `() => any` | 选择器 Blur 时发出 |
| on-blur | `() => void` | 选择器 Blur 时发出 |
| on-create | `(label: string) => SelectOption` | `label => ({ label, value: label })` | 在输入内容时如何创建一个选项。注意 `filter` 对这个生成的选项同样会生效。同时确保这个选项和其他选项的 `value` 不要有重复 |
| on-focus | `() => any` | 选择器 Focus 时发出 |
| on-scroll | `(e: ScrollEvent) => any` | 选择菜单在滚动 |
| on-search | `(value: string) => any` | |
| on-update:value | `(value: Array \| string \| number \| null) => any` | |
| on-focus | `() => void` | 选择器 Focus 时发出 |
| on-scroll | `(e: ScrollEvent) => void` | 选择菜单在滚动 |
| on-search | `(value: string) => void` | |
| on-update:value | `(value: Array \| string \| number \| null) => void` | |
### SelectOption Properties

View File

@ -22,4 +22,4 @@ mark
| range | `boolean` | `false` | |
| step | `number` | `1` | |
| value | `number \| [number, number] \| null` | `undefined` |
| on-update:value | `(value: number \| [number, number]) => any` | `undefined` | |
| on-update:value | `(value: number \| [number, number]) => void` | `undefined` | |

View File

@ -22,4 +22,4 @@ mark
| range | `boolean` | `false` | |
| step | `number` | `1` | |
| value | `number \| [number, number] \| null` | `undefined` |
| on-update:value | `(value: number \| [number, number]) => any` | `undefined` | |
| on-update:value | `(value: number \| [number, number]) => void` | `undefined` | |

View File

@ -18,4 +18,4 @@ event
| disabled | `boolean` | `false` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `boolean` | `undefined` | |
| on-update:value | `(value: boolean) => any` | `undefined` | |
| on-update:value | `(value: boolean) => void` | `undefined` | |

View File

@ -18,4 +18,4 @@ event
| disabled | `boolean` | `false` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `boolean` | `undefined` | |
| on-update:value | `(value: boolean) => any` | `undefined` | |
| on-update:value | `(value: boolean) => void` | `undefined` | |

View File

@ -22,7 +22,7 @@ display-directive
| label-size | `'small' \| 'medium' \| 'large' \| 'huge'` | `'medium'` | 标签的尺寸,只对线型的 Tabs 生效 |
| type | `'line' \| 'card'` | `'line'` | |
| value | `string \| number` | required | |
| on-update:value | `(value: string \| number) => any` | `undefined` | |
| on-update:value | `(value: string \| number) => void` | `undefined` | |
### Tab Pane Props

View File

@ -23,7 +23,7 @@ line-debug
| label-size | `'small' \| 'medium' \| 'large' \| 'huge'` | `'medium'` | 标签的尺寸,只对线型的 Tabs 生效 |
| type | `'line' \| 'card'` | `'line'` | |
| value | `string \| number` | required | |
| on-update:value | `(value: string \| number) => any` | `undefined` | |
| on-update:value | `(value: string \| number) => void` | `undefined` | |
### Tab Pane Props

View File

@ -27,7 +27,7 @@ shape
| round | `boolean` | `false` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| type | `'default' \| 'info' \| 'success' \| 'warning' \| 'error'` | `'default'` | |
| on-update:checked | `(value: boolean) => any` | `undefined` | |
| on-update:checked | `(value: boolean) => void` | `undefined` | |
## Slots

View File

@ -27,7 +27,7 @@ shape
| round | `boolean` | `false` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| type | `'default' \| 'info' \| 'success' \| 'warning' \| 'error'` | `'default'` | |
| on-update:checked | `(value: boolean) => any` | `undefined` | |
| on-update:checked | `(value: boolean) => void` | `undefined` | |
## Slots

View File

@ -25,6 +25,6 @@ format
| placeholder | `string` | `'Select Time'` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `number \| null` | `undefined` | |
| on-blur | `() => any` | `undefined` | |
| on-focus | `() => any` | `undefined` | |
| on-update:value | `(value: number \| null) => any` | `undefined` | |
| on-blur | `() => void` | `undefined` | |
| on-focus | `() => void` | `undefined` | |
| on-update:value | `(value: number \| null) => void` | `undefined` | |

View File

@ -25,6 +25,6 @@ format
| placeholder | `string` | `'Select Time'` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `number \| null` | `undefined` | |
| on-blur | `() => any` | `undefined` | |
| on-focus | `() => any` | `undefined` | |
| on-update:value | `(value: number \| null) => any` | `undefined` | |
| on-blur | `() => void` | `undefined` | |
| on-focus | `() => void` | `undefined` | |
| on-update:value | `(value: number \| null) => void` | `undefined` | |

View File

@ -28,7 +28,7 @@ filterable
| target-filter-placeholder | `string` | `undefined` | |
| target-title | `string` | `'Target'` | |
| value | `Array<string \| number> \| null` | `undefined` | |
| on-update:value | `(value: Array<string \| number>) => any` | `undefined` | |
| on-update:value | `(value: Array<string \| number>) => void` | `undefined` | |
| virtual-scroll | `boolean` | `false` | If use virtual scroll on transfer. If set to `true` it can handles large data (and turn transfer animation off) |
### TransferOption Type

View File

@ -28,7 +28,7 @@ filterable
| target-filter-placeholder | `string` | `undefined` | |
| target-title | `string` | `'目标项'` | |
| value | `Array<string \| number> \| null` | `undefined` | |
| on-update:value | `(value: Array<string \| number>) => any` | `undefined` | |
| on-update:value | `(value: Array<string \| number>) => void` | `undefined` | |
| virtual-scroll | `boolean` | `false` | If use virtual scroll on transfer. If set to `true` it can handles large data (and turn transfer animation off) |
### TransferOption Type

View File

@ -37,9 +37,9 @@ drag-drop-debug
| remote | `boolean` | `false` | Whether to load nodes async. It should work with `on-load` |
| selectable | `boolean` | `true` | |
| selected-keys | `Array<string \| number>` | `undefined` | If set, selected status will work in controlled manner. |
| on-update:selected-keys | `(keys: Array<string \| number>) => any` | `undefined` | |
| on-update:expanded-keys | `(keys: Array<string \| number>) => any` | `undefined` | |
| on-update:checked-keys | `(keys: Array<string \| number>) => any` | `undefined` | |
| on-update:selected-keys | `(keys: Array<string \| number>) => void` | `undefined` | |
| on-update:expanded-keys | `(keys: Array<string \| number>) => void` | `undefined` | |
| on-update:checked-keys | `(keys: Array<string \| number>) => void` | `undefined` | |
<!--

View File

@ -37,9 +37,9 @@ drag-drop-debug
| remote | `boolean` | `false` | 是否异步获取选项,和 onLoad 配合 |
| selectable | `boolean` | `true` | |
| selected-keys | `Array<string \| number>` | `undefined` | 如果设定则 selected 状态受控 |
| on-update:selected-keys | `(keys: Array<string \| number>) => any` | `undefined` | |
| on-update:expanded-keys | `(keys: Array<string \| number>) => any` | `undefined` | |
| on-update:checked-keys | `(keys: Array<string \| number>) => any` | `undefined` | |
| on-update:selected-keys | `(keys: Array<string \| number>) => void` | `undefined` | |
| on-update:expanded-keys | `(keys: Array<string \| number>) => void` | `undefined` | |
| on-update:checked-keys | `(keys: Array<string \| number>) => void` | `undefined` | |
<!--
| draggable | `boolean` | `false` | |

View File

@ -35,7 +35,7 @@ default-files
| show-remove-button | `boolean` | `true` | Whether to show remove button (at file finished status). Click on remove button will fire `on-remove` callback. |
| show-retry-button | `boolean` | `true` | Whether to show retry button (at file error status). |
| with-credentials | `boolean` | `false` | If cookie attached. |
| on-change | `(options: { file: UploadFile, fileList: Array<UploadFile>, event?: Event }) => any` | `() => {}` | The callback of status change of the component. Any file status change would fire the callback. |
| on-change | `(options: { file: UploadFile, fileList: Array<UploadFile>, event?: Event }) => void` | `() => {}` | The callback of status change of the component. Any file status change would fire the callback. |
| on-finish | `(options: { file: UploadFile }) => UploadFile \| void` | `({ file }) => file` | The callback of file upload finish. You can modify the UploadFile or retun a new UploadFile. |
| on-remove | `(options: { file: UploadFile, fileList: Array<UploadFile> }) => boolean \| Promise<boolean> \| any` | `() => true` | The callback of file removal. Return false, promise resolve false or promise reject will cancel this removal. |

View File

@ -35,7 +35,7 @@ default-files
| show-remove-button | `boolean` | `true` | 是否显示删除按钮(在 finished 的时候展示),点击删除按钮会触发 `on-remove` 回调 |
| show-retry-button | `boolean` | `true` | 是否显示重新上传按钮(在 error 时展示) |
| with-credentials | `boolean` | `false` | 是否携带 Cookie |
| on-change | `(options: { file: UploadFile, fileList: Array<UploadFile>, event?: Event }) => any` | `() => {}` | 组件状态变化的回调,组件的任何文件状态变化都会触发回调 |
| on-change | `(options: { file: UploadFile, fileList: Array<UploadFile>, event?: Event }) => void` | `() => {}` | 组件状态变化的回调,组件的任何文件状态变化都会触发回调 |
| on-finish | `(options: { file: UploadFile }) => UploadFile \| void` | `({ file }) => file` | 文件上传结束的回调,可以修改传入的 UploadFile 或者返回一个新的 UploadFile |
| on-remove | `(options: { file: UploadFile, fileList: Array<UploadFile> }) => boolean \| Promise<boolean> \| any` | `() => true` | 文件移除的回调,返回 false 或者 promise resolve false 或者 promise reject 会不执行这次删除 |