diff --git a/demo/documentation/components/autoComplete/enUS/index.md b/demo/documentation/components/autoComplete/enUS/index.md index 30b5d48ca..126a46153 100644 --- a/demo/documentation/components/autoComplete/enUS/index.md +++ b/demo/documentation/components/autoComplete/enUS/index.md @@ -42,7 +42,7 @@ after-select ## Slots |Name|Parameters|Description| |-|-|-| -|default|`({ handleInput: (value: string) => any, handleFocus: function, handleBlur: function, value: string, theme: string \| null })`|| +|default|`(options: { handleInput: (value: string) => any, handleFocus: function, handleBlur: function, value: string, theme: string \| null })`|| ## Events |Name|Parameters|Description| diff --git a/demo/documentation/components/autoComplete/zhCN/index.md b/demo/documentation/components/autoComplete/zhCN/index.md index 839f18aea..f245795fc 100644 --- a/demo/documentation/components/autoComplete/zhCN/index.md +++ b/demo/documentation/components/autoComplete/zhCN/index.md @@ -43,7 +43,7 @@ after-select ## Slots |名称|参数|说明| |-|-|-| -|default|`({ handleInput: (value: string) => any, handleFocus: function, handleBlur: function, value: string, theme: string \| null })`|| +|default|`(options: { handleInput: (value: string) => any, handleFocus: function, handleBlur: function, value: string, theme: string \| null })`|| ## Events |名称|参数|说明| diff --git a/demo/documentation/components/collapse/enUS/index.md b/demo/documentation/components/collapse/enUS/index.md index 2c832c719..3ff226f44 100644 --- a/demo/documentation/components/collapse/enUS/index.md +++ b/demo/documentation/components/collapse/enUS/index.md @@ -43,11 +43,11 @@ item-header-click |-|-|-| |default|`()`|| |header|`()`|| -|arrow|`({ collapsed: boolean })`|| +|arrow|`(options: { collapsed: boolean })`|| ## Event ### Collapse Event |Name|Parameters|Description| |-|-|-| |expanded-names-change|`(expandedNames: Array)`|| -|item-header-click|`({ name: string, expanded: boolean, event: MouseEvent })`|| \ No newline at end of file +|item-header-click|`(data: { name: string, expanded: boolean, event: MouseEvent })`|| \ No newline at end of file diff --git a/demo/documentation/components/collapse/zhCN/index.md b/demo/documentation/components/collapse/zhCN/index.md index 11b23a249..e3b69c510 100644 --- a/demo/documentation/components/collapse/zhCN/index.md +++ b/demo/documentation/components/collapse/zhCN/index.md @@ -43,11 +43,11 @@ item-header-click |-|-|-| |default|`()`|| |header|`()`|| -|arrow|`({ collapsed: boolean })`|| +|arrow|`(options: { collapsed: boolean })`|| ## Event ### Collapse Event |名称|参数|说明| |-|-|-| |expanded-names-change|`(expandedNames: Array)`|| -|item-header-click|`({ name: string, expanded: boolean, event: MouseEvent })`|| +|item-header-click|`(data: { name: string, expanded: boolean, event: MouseEvent })`|| diff --git a/demo/documentation/components/configConsumer/enUS/index.md b/demo/documentation/components/configConsumer/enUS/index.md index f3ef97ecb..9de517399 100644 --- a/demo/documentation/components/configConsumer/enUS/index.md +++ b/demo/documentation/components/configConsumer/enUS/index.md @@ -16,4 +16,4 @@ color ## Slots |Name|Parameters|Description| |-|-|-| -|default|`({ theme: string, namespace: string, language: string, themeEnvironment: any, styleScheme: object })`|| \ No newline at end of file +|default|`(options: { theme: string, namespace: string, language: string, themeEnvironment: any, styleScheme: Object })`|| \ No newline at end of file diff --git a/demo/documentation/components/configConsumer/zhCN/index.md b/demo/documentation/components/configConsumer/zhCN/index.md index d2efaef9b..0f5a49cc4 100644 --- a/demo/documentation/components/configConsumer/zhCN/index.md +++ b/demo/documentation/components/configConsumer/zhCN/index.md @@ -16,4 +16,4 @@ color ## Slots |名称|参数|说明| |-|-|-| -|default|`({ theme: string, namespace: string, language: string, themeEnvironment: any, styleScheme: object })`|| \ No newline at end of file +|default|`(options: { theme: string, namespace: string, language: string, themeEnvironment: any, styleScheme: object })`|| \ No newline at end of file diff --git a/demo/documentation/components/dataTable/enUS/index.md b/demo/documentation/components/dataTable/enUS/index.md index 04e0e0da2..09e9fbbf7 100644 --- a/demo/documentation/components/dataTable/enUS/index.md +++ b/demo/documentation/components/dataTable/enUS/index.md @@ -66,7 +66,7 @@ These methods can help you control table in an uncontrolled manner. However, it' |Name|Parameters|Description| |-|-|-| |filters-change|`(filters: { [string \| number]: Array }, initiatorColumn: Column)`|| -|sorter-change|`({ columnKey: string \| number, sorter: 'default' \| function \| boolean, order: 'ascend' \| 'descend' \| false } \| null)`|If there won't be a active sorter after change, sorter-change will emit `null`| +|sorter-change|`(data: { columnKey: string \| number, sorter: 'default' \| function \| boolean, order: 'ascend' \| 'descend' \| false } \| null)`|If there won't be a active sorter after change, sorter-change will emit `null`| |page-change|`(page: number)`|| |page-size-change|`(pageSize: number)`|| |checked-row-keys-change|`(keys: Array)`|| diff --git a/demo/documentation/components/dataTable/zhCN/index.md b/demo/documentation/components/dataTable/zhCN/index.md index e78984606..0f7494332 100644 --- a/demo/documentation/components/dataTable/zhCN/index.md +++ b/demo/documentation/components/dataTable/zhCN/index.md @@ -66,7 +66,7 @@ ajaxUsage |名称|参数|说明| |-|-|-| |filters-change|`(filters: { [string \| number]: Array \| string \| number }, initiatorColumn: Column)`|| -|sorter-change|`({ columnKey: string \| number, sorter: 'default' \| function \| boolean, order: 'ascend' \| 'descend' \| false } \| null)`|如果在变动后没有激活的排序，那么 sorter-change 将发出 `null`| +|sorter-change|`(options: { columnKey: string \| number, sorter: 'default' \| function \| boolean, order: 'ascend' \| 'descend' \| false } \| null)`|如果在变动后没有激活的排序，那么 sorter-change 将发出 `null`| |page-change|`(page: number)`|| |page-size-change|`(pageSize: number)`|| |checked-row-keys-change|`(keys: Array)`|| diff --git a/demo/documentation/components/dynamicInput/enUS/index.md b/demo/documentation/components/dynamicInput/enUS/index.md index a615a2f56..9e446be7c 100644 --- a/demo/documentation/components/dynamicInput/enUS/index.md +++ b/demo/documentation/components/dynamicInput/enUS/index.md @@ -43,7 +43,7 @@ form ## Slots |Name|Parameters|Description| |-|-|-| -|default|`({ value: any, index: number })`|The content of each item, `value` is the value of current item, `index` is the index of the current item.| +|default|`(options: { value: any, index: number })`|The content of each item, `value` is the value of current item, `index` is the index of the current item.| ## Events |Name|Parameters|Description| diff --git a/demo/documentation/components/dynamicInput/zhCN/index.md b/demo/documentation/components/dynamicInput/zhCN/index.md index 3cf71b23d..6634c0cd7 100644 --- a/demo/documentation/components/dynamicInput/zhCN/index.md +++ b/demo/documentation/components/dynamicInput/zhCN/index.md @@ -44,7 +44,7 @@ form ## Slots |名称|参数|说明| |-|-|-| -|default|`({ value: any, index: number })`|每一项的渲染方式，其中 `value` 为该项对应的数组值，`index` 为该项对应的数组索引| +|default|`(options: { value: any, index: number })`|每一项的渲染方式，其中 `value` 为该项对应的数组值，`index` 为该项对应的数组索引| ## Events |名称|参数|说明| diff --git a/demo/documentation/components/form/enUS/index.md b/demo/documentation/components/form/enUS/index.md index 0acb22217..6c2aaf282 100644 --- a/demo/documentation/components/form/enUS/index.md +++ b/demo/documentation/components/form/enUS/index.md @@ -75,7 +75,7 @@ Accept all props from form-item & [Col](n-row#Col-Props) ### Form Item, Form Item Row, Form Item Col Methods |Name|Type|Description| |-|-|-| -|validate|`({ trigger?: string, callback?: (errors?: Array) => any, shouldRuleBeApplied?: FormItemRule => boolean, options?: AsyncValidatorOptions }) => Promise`|Validate the form item. The rejection value type of returned promise is `Array`. 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) => any, shouldRuleBeApplied?: FormItemRule => boolean, options?: AsyncValidatorOptions }) => Promise`|Validate the form item. The rejection value type of returned promise is `Array`. 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 async-validator. diff --git a/demo/documentation/components/form/zhCN/index.md b/demo/documentation/components/form/zhCN/index.md index 6f1bc2285..5716f64a6 100644 --- a/demo/documentation/components/form/zhCN/index.md +++ b/demo/documentation/components/form/zhCN/index.md @@ -75,7 +75,7 @@ validator-debug ### Form Item, Form Item Row, Form Item Col Methods |名称|类型|说明| |-|-|-| -|validate|`({ trigger?: string, callback?: (errors?: Array) => any, shouldRuleBeApplied?: FormItemRule => boolean, options?: AsyncValidatorOptions }) => Promise`|验证表项，Promise rejection 的返回值类型是 `Array`。如果设定 `trigger`，这一个表项全部的规则都会被使用。`shouldRuleBeApplied` 可以用来进一步过滤已经经过 `trigger` 筛选的规则| +|validate|`(options: { trigger?: string, callback?: (errors?: Array) => any, shouldRuleBeApplied?: FormItemRule => boolean, options?: AsyncValidatorOptions }) => Promise`|验证表项，Promise rejection 的返回值类型是 `Array`。如果设定 `trigger`，这一个表项全部的规则都会被使用。`shouldRuleBeApplied` 可以用来进一步过滤已经经过 `trigger` 筛选的规则| |clearValidationEffect|`() => void`|| 关于 AsyncValidatorOptions，参考 async-validator。 diff --git a/demo/documentation/components/tree/enUS/index.md b/demo/documentation/components/tree/enUS/index.md index 35fbfef24..5fe0e5a64 100644 --- a/demo/documentation/components/tree/enUS/index.md +++ b/demo/documentation/components/tree/enUS/index.md @@ -44,11 +44,11 @@ filter ## Events |Name|Parameters|Description| |-|-|-| -|selected-keys-change|`(Array)`|| -|expanded-keys-change|`(Array)`|| -|checked-keys-change|`(Array)`|| -|dragstart|`({ node: TreeNode, event: DragEvent })`|| -|dragend|`({ node: TreeNode, event: DragEvent })`|| -|dragenter|`({ node: TreeNode, event: DragEvent })`|| -|dragleave|`({ node: TreeNode, event: DragEvent })`|| -|drop|`({ node: TreeNode, dragNode: TreeNode, dropPosition: 'top' \| 'center' \| 'bottom', event: DragEvent })`|| \ No newline at end of file +|selected-keys-change|`(keys: Array)`|| +|expanded-keys-change|`(keys: Array)`|| +|checked-keys-change|`(keys: Array)`|| +|dragstart|`(data: { node: TreeNode, event: DragEvent })`|| +|dragend|`(data: { node: TreeNode, event: DragEvent })`|| +|dragenter|`(data: { node: TreeNode, event: DragEvent })`|| +|dragleave|`(data: { node: TreeNode, event: DragEvent })`|| +|drop|`(data: { node: TreeNode, dragNode: TreeNode, dropPosition: 'top' \| 'center' \| 'bottom', event: DragEvent })`|| \ No newline at end of file diff --git a/demo/documentation/components/tree/zhCN/index.md b/demo/documentation/components/tree/zhCN/index.md index b454f4dee..fd8725f3d 100644 --- a/demo/documentation/components/tree/zhCN/index.md +++ b/demo/documentation/components/tree/zhCN/index.md @@ -43,11 +43,11 @@ filter ## Events |名称|参数|说明| |-|-|-| -|selected-keys-change|`(Array)`|| -|expanded-keys-change|`(Array)`|| -|checked-keys-change|`(Array)`|| -|dragstart|`({ node: TreeNode, event: DragEvent })`|| -|dragend|`({ node: TreeNode, event: DragEvent })`|| -|dragenter|`({ node: TreeNode, event: DragEvent })`|| -|dragleave|`({ node: TreeNode, event: DragEvent })`|| -|drop|`({ node: TreeNode, dragNode: TreeNode, dropPosition: 'top' \| 'center' \| 'bottom', event: DragEvent })`|| \ No newline at end of file +|selected-keys-change|`(keys: Array)`|| +|expanded-keys-change|`(keys: Array)`|| +|checked-keys-change|`(keys: Array)`|| +|dragstart|`(data: { node: TreeNode, event: DragEvent })`|| +|dragend|`(data: { node: TreeNode, event: DragEvent })`|| +|dragenter|`(data: { node: TreeNode, event: DragEvent })`|| +|dragleave|`(data: { node: TreeNode, event: DragEvent })`|| +|drop|`(data: { node: TreeNode, dragNode: TreeNode, dropPosition: 'top' \| 'center' \| 'bottom', event: DragEvent })`|| \ No newline at end of file diff --git a/demo/documentation/components/upload/enUS/index.md b/demo/documentation/components/upload/enUS/index.md index 822abd188..7985f0d78 100644 --- a/demo/documentation/components/upload/enUS/index.md +++ b/demo/documentation/components/upload/enUS/index.md @@ -24,9 +24,9 @@ default-files |headers|`object \| ({ file: UploadFile }) => object`|`null`|The additional HTTP Headers of request.| |data|`object \| ({ file: UploadFile }) => object`|`null`|The additional fileds data of HTTP request's form data.| |with-credentials|`boolean`|`false`|If cookie attached.| -|on-change|`({ file: UploadFile, fileList: Array, event?: Event }) => any`|`() => {}`|The callback of status change of the component. Any file status change would fire the callback.| -|on-remove|`({ file: UploadFile, fileList: Array }) => boolean \| Promise \| any`|`() => true`|The callback of file removal. Return false, promise resolve false or promise reject will cancel this removal.| -|on-finish|`({ file: UploadFile }) => UploadFile \| void`|`file => file`|The callback of file upload finish. You can modify the UploadFile or retun a new UploadFile.| +|on-change|`(options: { file: UploadFile, fileList: Array, event?: Event }) => any`|`() => {}`|The callback of status change of the component. Any file status change would fire the callback.| +|on-remove|`(options: { file: UploadFile, fileList: Array }) => boolean \| Promise \| any`|`() => true`|The callback of file removal. Return false, promise resolve false or promise reject will cancel this removal.| +|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.| |default-upload|`boolean`|`false`|If file uploaded immediatelly after file is selected.| |file-list|`Array`|`undefined`|The file list of component. If set, the component will work in controlled manner.| |file-list-style|`Object`|`null`|The style of file list area| diff --git a/demo/documentation/components/upload/zhCN/index.md b/demo/documentation/components/upload/zhCN/index.md index 4b1541ed9..f1f4e131e 100644 --- a/demo/documentation/components/upload/zhCN/index.md +++ b/demo/documentation/components/upload/zhCN/index.md @@ -23,9 +23,9 @@ default-files |headers|`object \| ({ file: UploadFile }) => object`|`null`|HTTP 请求需要附加的 Headers| |data|`object \| ({ file: UploadFile }) => object`|`null`|提交表单需要附加的数据| |with-credentials|`boolean`|`false`|是否携带 Cookie| -|on-change|`({ file: UploadFile, fileList: Array, event?: Event }) => any`|`() => {}`|组件状态变化的回调，组件的任何文件状态变化都会触发回调| -|on-remove|`({ file: UploadFile, fileList: Array }) => boolean \| Promise \| any`|`() => true`|文件移除的回调，返回 false 或者 promise resolve false 或者 promise reject 会不执行这次删除| -|on-finish|`({ file: UploadFile }) => UploadFile \| void`|`file => file`|文件上传结束的回调，可以修改传入的 UploadFile 或者返回一个新的 UploadFile| +|on-change|`(options: { file: UploadFile, fileList: Array, event?: Event }) => any`|`() => {}`|组件状态变化的回调，组件的任何文件状态变化都会触发回调| +|on-remove|`(options: { file: UploadFile, fileList: Array }) => boolean \| Promise \| any`|`() => true`|文件移除的回调，返回 false 或者 promise resolve false 或者 promise reject 会不执行这次删除| +|on-finish|`(options: { file: UploadFile }) => UploadFile \| void`|`file => file`|文件上传结束的回调，可以修改传入的 UploadFile 或者返回一个新的 UploadFile| |default-upload|`boolean`|`false`|选择文件时候是否默认上传| |file-list|`Array`|`undefined`|文件列表，如果传入组件会处于受控状态| |file-list-style|`Object`|`null`|文件列表区域的样式|