test/amis
1
0
Fork 0
mirror of https://gitee.com/baidu/amis.git synced 2024-12-14 17:01:14 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
dd5200ce18
amis/docs/zh-CN/components/wizard.md

121 lines
9.7 KiB
Markdown
Raw Normal View History

文档加上去了
2020-07-28 10:03:53 +08:00
---
title: Wizard 向导
修复路径
2020-07-29 16:20:21 +08:00
description:
文档加上去了
2020-07-28 10:03:53 +08:00
type: 0
group: ⚙ 组件
menuName: Wizard 向导
修复路径
2020-07-29 16:20:21 +08:00
icon:
文档加上去了
2020-07-28 10:03:53 +08:00
order: 73
---
修复路径
2020-07-29 16:20:21 +08:00
文档加上去了
2020-07-28 10:03:53 +08:00
表单向导，能够配置多个步骤引导用户一步一步完成表单提交。
## 基本使用
文档文字小调整；统一删掉 schema 中的高度设置；修复 tinymce 弹窗可能被遮挡问题 (#1336) * 文档优化 * 文档细节调整，删除示例的 height 设置，使用自动撑开 * sdk 使用完整例子，因为新版没发布 * 修复官网语言不正确问题 * 增加 icon 调整颜色及大小的例子 * 修复文字错误 * 补充 each 的文档 * 修复 zh-CN 大写问题
2021-01-07 23:35:03 +08:00
```schema: scope="body"
文档加上去了
2020-07-28 10:03:53 +08:00
{
"type": "wizard",
docs: 将 cfc 的 mock 接口放到项目中支持文档离线访问；将大部分图片外联都放入项目中管理 (#2366)
2021-08-09 18:05:01 +08:00
"api": "/api/mock2/form/saveForm?waitSeconds=2",
文档加上去了
2020-07-28 10:03:53 +08:00
"mode": "vertical",
"steps": [
{
"title": "第一步",
1.2.x 文档&示例配置调整 (#2064) * 补充容错 * fix: form 中 name 关联顶层数据初始化失效 * 更新 examples * 文档调整 * 删除多余的文档, 调整 schema * schema 调整 * schema 调整 * control 类型容器 control 改成 body * 修复一个选项加载的bug * form 注册直接用 type
2021-06-07 10:09:55 +08:00
"body": [
文档加上去了
2020-07-28 10:03:53 +08:00
{
"name": "website",
"label": "网址",
1.2.x 文档&示例配置调整 (#2064) * 补充容错 * fix: form 中 name 关联顶层数据初始化失效 * 更新 examples * 文档调整 * 删除多余的文档, 调整 schema * schema 调整 * schema 调整 * control 类型容器 control 改成 body * 修复一个选项加载的bug * form 注册直接用 type
2021-06-07 10:09:55 +08:00
"type": "input-url",
文档加上去了
2020-07-28 10:03:53 +08:00
"required": true
},
{
"name": "email",
"label": "邮箱",
1.2.x 文档&示例配置调整 (#2064) * 补充容错 * fix: form 中 name 关联顶层数据初始化失效 * 更新 examples * 文档调整 * 删除多余的文档, 调整 schema * schema 调整 * schema 调整 * control 类型容器 control 改成 body * 修复一个选项加载的bug * form 注册直接用 type
2021-06-07 10:09:55 +08:00
"type": "input-email",
文档加上去了
2020-07-28 10:03:53 +08:00
"required": true
}
]
},
{
"title": "Step 2",
1.2.x 文档&示例配置调整 (#2064) * 补充容错 * fix: form 中 name 关联顶层数据初始化失效 * 更新 examples * 文档调整 * 删除多余的文档, 调整 schema * schema 调整 * schema 调整 * control 类型容器 control 改成 body * 修复一个选项加载的bug * form 注册直接用 type
2021-06-07 10:09:55 +08:00
"body": [
文档加上去了
2020-07-28 10:03:53 +08:00
{
"name": "email2",
"label": "邮箱",
1.2.x 文档&示例配置调整 (#2064) * 补充容错 * fix: form 中 name 关联顶层数据初始化失效 * 更新 examples * 文档调整 * 删除多余的文档, 调整 schema * schema 调整 * schema 调整 * control 类型容器 control 改成 body * 修复一个选项加载的bug * form 注册直接用 type
2021-06-07 10:09:55 +08:00
"type": "input-email",
文档加上去了
2020-07-28 10:03:53 +08:00
"required": true
}
]
},
{
"title": "Step 3",
1.2.x 文档&示例配置调整 (#2064) * 补充容错 * fix: form 中 name 关联顶层数据初始化失效 * 更新 examples * 文档调整 * 删除多余的文档, 调整 schema * schema 调整 * schema 调整 * control 类型容器 control 改成 body * 修复一个选项加载的bug * form 注册直接用 type
2021-06-07 10:09:55 +08:00
"body": [
文档加上去了
2020-07-28 10:03:53 +08:00
"这是最后一步了"
]
}
]
}
```
## 属性表
文档拆分组件部分 (#1502) * 文档样式一点小优化 * 文档拆分组件部分
2021-02-01 20:44:49 +08:00
| 属性名 | 类型 | 默认值 | 说明 |
| ------------------- | ---------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| type | `string` | `"wizard"` | 指定为 `Wizard` 组件 |
| mode | `string` | `"horizontal"` | 展示模式，选择：`horizontal` 或者 `vertical` |
| api | [API](../../docs/types/api) | | 最后一步保存的接口。 |
| initApi | [API](../../docs/types/api) | | 初始化数据接口 |
| initFetch | [API](../../docs/types/api) | | 初始是否拉取数据。 |
| initFetchOn | [表达式](../../docs/concepts/expression) | | 初始是否拉取数据，通过表达式来配置 |
| actionPrevLabel | `string` | `上一步` | 上一步按钮文本 |
| actionNextLabel | `string` | `下一步` | 下一步按钮文本 |
| actionNextSaveLabel | `string` | `保存并下一步` | 保存并下一步按钮文本 |
| actionFinishLabel | `string` | `完成` | 完成按钮文本 |
| className | `string` | | 外层 CSS 类名 |
| actionClassName | `string` | `btn-sm btn-default` | 按钮 CSS 类名 |
| reload | `string` | | 操作完后刷新目标对象。请填写目标组件设置的 name 值，如果填写为 `window` 则让当前页面整体刷新。 |
| redirect | [模板](../../docs/concepts/template) | `3000` | 操作完后跳转。 |
| target | `string` | `false` | 可以把数据提交给别的组件而不是自己保存。请填写目标组件设置的 name 值，如果填写为 `window` 则把数据同步到地址栏上，同时依赖这些数据的组件会自动重新刷新。 |
| steps | Array<[step](#step)> | | 数组，配置步骤信息 |
1.2.x 文档&示例配置调整 (#2064) * 补充容错 * fix: form 中 name 关联顶层数据初始化失效 * 更新 examples * 文档调整 * 删除多余的文档, 调整 schema * schema 调整 * schema 调整 * control 类型容器 control 改成 body * 修复一个选项加载的bug * form 注册直接用 type
2021-06-07 10:09:55 +08:00
| startStep | `string` | `1` | 起始默认值，从第几步开始。可支持模版，但是只有在组件创建时渲染模版并设置当前步数，在之后组件被刷新时，当前 step 不会根据 startStep 改变 |
文档加上去了
2020-07-28 10:03:53 +08:00
### step
fix:页面跳转动作链接问题 (#4049) * fix:页面跳转链接拼接问题 * fix:页面跳转链接拼接问题 * fix:页面跳转链接拼接问题&去掉按钮点击事件时的额外传参 * fix:页面跳转链接拼接问题&容器内事件参数格式 * fix:页面跳转链接拼接问题&容器内事件参数格式
2022-04-14 21:16:03 +08:00
| 属性名 | 类型 | 默认值 | 说明 |
| ----------------- | ---------------------------------------- | ------ | ------------------------------------------------------------------------------------------ |
| title | `string` | | 步骤标题 |
fix: 修复文档组件中链接404 (#3469) Co-authored-by: yuehq <yuehq@helianhealth.com>
2022-01-21 14:40:52 +08:00
| mode | `string` | | 展示默认，跟 [Form](./Form/Form) 中的模式一样，选择： `normal`、`horizontal`或者`inline`。 |
fix:页面跳转动作链接问题 (#4049) * fix:页面跳转链接拼接问题 * fix:页面跳转链接拼接问题 * fix:页面跳转链接拼接问题&去掉按钮点击事件时的额外传参 * fix:页面跳转链接拼接问题&容器内事件参数格式 * fix:页面跳转链接拼接问题&容器内事件参数格式
2022-04-14 21:16:03 +08:00
| horizontal | `Object` | | 当为水平模式时，用来控制左右占比 |
| horizontal.label | `number` | | 左边 label 的宽度占比 |
| horizontal.right | `number` | | 右边控制器的宽度占比。 |
| horizontal.offset | `number` | | 当没有设置 label 时，右边控制器的偏移量 |
| api | [API](../../docs/types/api) | | 当前步骤保存接口，可以不配置。 |
| initApi | [API](../../docs/types/api) | | 当前步骤数据初始化接口。 |
| initFetch | `boolean` | | 当前步骤数据初始化接口是否初始拉取。 |
| initFetchOn | [表达式](../../docs/concepts/expression) | | 当前步骤数据初始化接口是否初始拉取，用表达式来决定。 |
| body | Array<[FormItem](./form/formItem)> | | 当前步骤的表单项集合，请参考 [FormItem](./form/formItem)。 |
feat: 向导、评分 文档修改
2022-03-15 11:41:55 +08:00
## 事件表
fix:页面跳转动作链接问题 (#4049) * fix:页面跳转链接拼接问题 * fix:页面跳转链接拼接问题 * fix:页面跳转链接拼接问题&去掉按钮点击事件时的额外传参 * fix:页面跳转链接拼接问题&容器内事件参数格式 * fix:页面跳转链接拼接问题&容器内事件参数格式
2022-04-14 21:16:03 +08:00
| 事件名称 | 事件参数 | 说明 |
| -------------- | ----------------------------- | ------------ |
| inited | 表单数据 | 初始化完成 |
| finished | 表单数据 | 点击完成 |
| stepChange | `step: number` 步骤, 表单数据 | 步骤切换 |
| change | 表单数据 | 数值变化 |
| submitSucc | 表单数据 | 提交成功 |
| submitFail | `error: object` 错误信息 | 提交失败 |
| stepSubmitSucc | 表单数据 | 步骤提交成功 |
| stepSubmitFail | `error: object` 错误信息 | 步骤提交失败 |
feat: 向导、评分 文档修改
2022-03-15 11:41:55 +08:00
## 动作表
fix:修复部分组件事件动作问题&补充组件动作表文档&规范事件动作参数类型 (#4152) * fix:修复部分组件事件动作问题&补充组件动作表文档&规范事件动作参数类型 * fix:修复部分组件事件动作问题&补充组件动作表文档&规范事件动作参数类型 * fix:input-range类型声明问题 * fix:input-range单测问题 * fix:input-range单测u snapshot
2022-04-26 21:12:00 +08:00
| 动作名称 | 动作配置 | 说明 |
| ----------- | -------------------------- | ---------------- |
| submit | - | 全部提交 |
| step-submit | - | 分步提交 |
| next | - | 下一步 |
| prev | - | 上一步 |
| goto-step | `step: number` 目标步骤 | 定位步骤 |
| reload | - | 刷新（重新加载） |
| setValue | `value: object` 更新的数据 | 更新数据 |
Reference in New Issue Copy Permalink