test/amis
1
0
Fork 0
mirror of https://gitee.com/baidu/amis.git synced 2024-12-02 20:09:08 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #3785 from gooolh/event-docs

Browse Source 
docs: 上传类 事件文档补充
This commit is contained in:
hsm-lv 2022-03-16 20:20:44 +08:00 committed by GitHub
commit f83dbcafd4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 89 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/zh-CN/components/form/input-excel.md
View File

@ -223,3 +223,15 @@ order: 14
| parseMode | `'array'` 或 `'object'` | 'object' | 解析模式 |
| includeEmpty | `boolean` | true | 是否包含空值 |
| plainText | `boolean` | true | 是否解析为纯文本 |
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | ---------------------- | -------------------- |
| change | `value: Array<object>` | 选中值发生变化时触发 |
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | -------- | ---- |
| clear | - | 清空 |

23
docs/zh-CN/components/form/input-file.md
View File

@ -311,3 +311,26 @@ order: 21
| startChunkApi | [API](../../../docs/types/api) | | startChunkApi |
| chunkApi | [API](../../../docs/types/api) | | chunkApi |
| finishChunkApi | [API](../../../docs/types/api) | | finishChunkApi |
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | ------------------------ | -------------------- |
| change | `file: Array<FileValue>` | 选中值发生变化时触发 |
| remove | `file: FileValue` | 被移除的文件 |
| success | `file: FileValue` | 上传成功的文件 |
| fail | `file: FileValue` | 上传失败的文件 |
### FileValue 属性表
| 属性名 | 类型 | 说明 |
| ------ | -------- | -------------------------------------------------- |
| name | `string` | 文件名称 |
| value | `string` | 上传成功后返回的 url |
| state | `string` | 文件当前状态,值可为 `pending` `uploaded` `invalid` |
| error | `string` | 错误信息 |
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | -------- | ---- |
| clear | - | 清空 |

24
docs/zh-CN/components/form/input-image.md
View File

@ -398,3 +398,27 @@ app.listen(8080, function () {});
| maxWidth | `number` | | 限制图片最大宽度。 |
| maxHeight | `number` | | 限制图片最大高度。 |
| aspectRatio | `number` | | 限制图片宽高比，格式为浮点型数字，默认 `1` 即 `1:1`，如果要设置 `16:9` 请设置 `1.7777777777777777` 即 `16 / 9`。 如果不想限制比率，请设置空字符串。 |
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | ------------------------ | -------------------- |
| change | `file: Array<FileValue>` | 选中值发生变化时触发 |
| remove | `file: FileValue` | 被移除的文件 |
| success | `file: FileValue` | 上传成功的文件 |
| fail | `file: FileValue` | 上传失败的文件 |
### FileValue 属性表
| 属性名 | 类型 | 说明 |
| ------ | -------- | -------------------------------------------------- |
| name | `string` | 图片名称 |
| value | `string` | 上传成功后返回的 url |
| state | `string` | 文件当前状态,值可为 `pending` `uploaded` `invalid` |
| error | `string` | 错误信息 |
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | -------- | ---- |
| clear | - | 清空 |

18
src/renderers/Form/InputFile.tsx
View File

@ -818,7 +818,11 @@ export default class FileControl extends React.Component<FileProps, FileState> {
let value =
(ret.data as any).value || (ret.data as any).url || ret.data;
const dispatcher = await this.dispatchEvent('success', file);
const dispatcher = await this.dispatchEvent('success', {
...file,
value,
state: 'uploaded'
});
if (dispatcher?.prevented) {
return;
}
@ -1220,11 +1224,19 @@ export default class FileControl extends React.Component<FileProps, FileState> {
async dispatchEvent(e: string, data?: Record<string, any>) {
const {dispatchEvent} = this.props;
data = data || this.state.files;
const getEventData = (item: Record<string, any>) => ({
name: item.path || item.name,
value: item.value,
state: item.state,
error: item.error
});
const value = data
? getEventData(data)
: this.state.files.map(item => getEventData(item));
return dispatchEvent(
e,
createObject(this.props.data, {
file: data
file: value
})
);
}

18
src/renderers/Form/InputImage.tsx
View File

@ -1081,7 +1081,11 @@ export default class ImageControl extends React.Component<
};
obj.value = obj.value || obj.url;
const dispatcher = await this.dispatchEvent('success', obj);
const dispatcher = await this.dispatchEvent('success', {
...file,
value: obj.value,
state: 'uploaded'
});
if (dispatcher?.prevented) {
return;
}
@ -1252,8 +1256,16 @@ export default class ImageControl extends React.Component<
async dispatchEvent(e: string, data?: Record<string, any>) {
const {dispatchEvent} = this.props;
data = data ? data : this.files;
return dispatchEvent(e, createObject(this.props.data, {file: data}));
const getEventData = (item: Record<string, any>) => ({
name: item.path || item.name,
value: item.value,
state: item.state,
error: item.error
});
const value = data
? getEventData(data)
: this.files.map(item => getEventData(item));
return dispatchEvent(e, createObject(this.props.data, {file: value}));
}
// 动作