amis/docs/components/tasks.md

77 lines
7.9 KiB
Markdown
Raw Permalink Normal View History

2020-07-28 10:03:53 +08:00
---
title: Tasks 任务操作集合
2020-07-29 17:33:14 +08:00
description:
2020-07-28 10:03:53 +08:00
type: 0
group: ⚙ 组件
menuName: Tasks
2020-07-29 17:33:14 +08:00
icon:
2020-07-28 10:03:53 +08:00
order: 69
---
2020-07-29 17:33:14 +08:00
2019-05-08 22:55:41 +08:00
任务操作集合,类似于 orp 上线。
2020-07-28 10:03:53 +08:00
## 基本用法
2019-05-08 22:55:41 +08:00
```schema:height="300" scope="body"
{
"type": "tasks",
"name": "tasks",
"items": [
{
"label": "hive 任务",
"key": "hive",
"status": 4,
"remark": "查看详情<a target=\"_blank\" href=\"http://www.baidu.com\">日志</a>。"
},
{
"label": "小流量",
"key": "partial",
"status": 4
},
{
"label": "全量",
"key": "full",
"status": 4
}
]
}
```
2020-07-28 10:03:53 +08:00
## 属性表
2020-07-29 17:33:14 +08:00
| 属性名 | 类型 | 默认值 | 说明 |
| ----------------- | ------------------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| type | `string` | `"tasks"` | 指定为 Tasks 渲染器 |
| className | `string` | | 外层 Dom 的类名 |
| tableClassName | `string` | | table Dom 的类名 |
| items | `Array` | | 任务列表 |
| items[x].label | `string` | | 任务名称 |
| items[x].key | `string` | | 任务键值,请唯一区分 |
| items[x].remark | `string` | | 当前任务状态,支持 html |
| items[x].status | `string` | | 任务状态: 0: 初始状态不可操作。1: 就绪可操作状态。2: 进行中还没有结束。3有错误不可重试。4: 已正常结束。5有错误且可以重试。 |
| checkApi | [API](../types/api) | | 返回任务列表,返回的数据请参考 items。 |
| submitApi | [API](../types/api) | | 提交任务使用的 API |
| reSubmitApi | [API](../types/api) | | 如果任务失败,且可以重试,提交的时候会使用此 API |
| interval | `number` | `3000` | 当有任务进行中,会每隔一段时间再次检测,而时间间隔就是通过此项配置,默认 3s。 |
| taskNameLabel | `string` | 任务名称 | 任务名称列说明 |
| operationLabel | `string` | 操作 | 操作列说明 |
| statusLabel | `string` | 状态 | 状态列说明 |
| remarkLabel | `string` | 备注 | 备注列说明 |
| btnText | `string` | 上线 | 操作按钮文字 |
| retryBtnText | `string` | 重试 | 重试操作按钮文字 |
| btnClassName | `string` | `btn-sm btn-default` | 配置容器按钮 className |
| retryBtnClassName | `string` | `btn-sm btn-danger` | 配置容器重试按钮 className |
| statusLabelMap | `array` | `["label-warning", "label-info", "label-success", "label-danger", "label-default", "label-danger"]` | 状态显示对应的类名配置 |
| statusTextMap | `array` | `["未开始", "就绪", "进行中", "出错", "已完成", "出错"]` | 状态显示对应的文字显示配置 |
2019-05-08 22:55:41 +08:00
```schema:height="300" scope="body"
[
{
"type": "tasks",
"name": "tasks",
2020-07-28 10:03:53 +08:00
"checkApi": "https://houtai.baidu.com/api/mock2/task"
2019-05-08 22:55:41 +08:00
},
"为了演示,目前获取的状态都是随机出现的。"]
```