--- title: Wizard 向导 description: type: 0 group: ⚙ 组件 menuName: Wizard 向导 icon: order: 73 --- 表单向导，能够配置多个步骤引导用户一步一步完成表单提交。 ## 基本使用 ```schema: scope="body" { "type": "wizard", "initApi": "/api/mock2/form/saveForm?waitSeconds=2", "steps": [ { "title": "第一步", "body": [ { "name": "website", "label": "网址", "type": "input-url", "required": true }, { "name": "email", "label": "邮箱", "type": "input-email", "required": true } ] }, { "title": "Step 2", "body": [ { "name": "email2", "label": "邮箱", "type": "input-email", "required": true } ] }, { "title": "Step 3", "body": [ "这是最后一步了" ] } ] } ``` ## 自定义按钮 可以在每个 `step` 中配置 `actions` 来自定义按钮。 ```schema: scope="body" { "type": "wizard", "steps": [ { "title": "第一步", "body": [ { "name": "website", "label": "网址", "type": "input-url" }, { "name": "email", "label": "邮箱", "type": "input-email" } ], actions: [ { label: "Next", type: 'button', actionType: 'next' } ] }, { "title": "Step 2", "body": [ { "name": "email2", "label": "邮箱", "type": "input-email" } ], actions: [ { label: "Prev", type: 'button', actionType: 'prev' }, { label: "Submit", type: 'button', actionType: 'next' } ] }, { "title": "Step 3", "body": [ "这是最后一步了, 没有按钮" ], actions: [] } ] } ``` ## 初始化到某一步 `initApi` 接口返回 `step` 字段即可，注意得是数字类型。`1` 表示第一步，`2` 表示第二步，以此类推 ```schema: scope="body" { "type": "wizard", "initApi": "/api/mock2/initWizard", "steps": [ { "title": "第一步", "body": [ { "name": "website", "label": "网址", "type": "input-url", "required": true }, { "name": "email", "label": "邮箱", "type": "input-email", "required": true } ] }, { "title": "Step 2", "body": [ { "name": "email2", "label": "邮箱", "type": "input-email", "required": true } ] }, { "title": "Step 3", "body": [ "这是最后一步了" ] } ] } ``` ## 限制跳转 可以通过在 step 上配置 `jumpableOn` 来限制跳转，可以基于整体 wizard 数据，或者基于 `currentStep` 来判断。 比如：`"jumpableOn": "${!website}",` 当设置完成了 website 后不可以回去跳转 ```schema: scope="body" { "type": "wizard", "initApi": "/api/mock2/initWizard", "steps": [ { "title": "第一步", "jumpableOn": "${!website}", "body": [ { "name": "website", "label": "网址", "type": "input-url", "required": true }, { "name": "email", "label": "邮箱", "type": "input-email", "required": true } ] }, { "title": "Step 2", "body": [ { "name": "email2", "label": "邮箱", "type": "input-email", "required": true } ] }, { "title": "Step 3", "body": [ "这是最后一步了" ] } ] } ``` ## 属性表 | 属性名 | 类型 | 默认值 | 说明 | | ------------------- | ---------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | 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)> | | 数组，配置步骤信息 | | startStep | `string` | `1` | 起始默认值，从第几步开始。可支持模版，但是只有在组件创建时渲染模版并设置当前步数，在之后组件被刷新时，当前 step 不会根据 startStep 改变 | ### step | 属性名 | 类型 | 默认值 | 说明 | | ------------------- | ---------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------- | | title | `string` | | 步骤标题 | | mode | `string` | | 展示默认，跟 [Form](./Form/Form) 中的模式一样，选择： `normal`、`horizontal`或者`inline`。 | | 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)。 | | closeDialogOnSubmit | `boolean` | | 提交的时候是否关闭弹窗。当 widzard 里面有且只有一个弹窗的时候，本身提交会触发弹窗关闭，此属性可以关闭此行为 | | jumpableOn | `string` | | 配置是否可跳转的表达式 | | actions | `Array` | | 自定义每一步的操作按钮 | ## 事件表 当前组件会对外派发以下事件，可以通过`onEvent`来监听这些事件，并通过`actions`来配置执行的动作，在`actions`中可以通过`${事件参数名}`或`${event.data.[事件参数名]}`来获取事件产生的数据，详细请查看[事件动作](../../docs/concepts/event-action)。 > `[name]`为当前数据域中的字段名，例如：当前数据域为 {username: 'amis'}，则可以通过${username}获取对应的值。 | 事件名称 | 事件参数 | 说明 | | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- | | inited | `responseData: any` 请求的响应数据
`responseStatus: number` 响应状态，0 表示成功
`responseMsg: string`响应消息, `error`表示接口是否成功
`[name]: any` 当前数据域中指定字段的值 | initApi 接口请求完成时触发 | | stepChange | `step: number` 步骤索引 | 切换步骤时触发 | | change | `event.data: object` 当前表单数据
`[name]: any` 当前数据域中指定字段的值 | 表单值变化时触发 | | stepSubmitSucc | - | 单个步骤提交成功 | | stepSubmitFail | `error: object` 单个步骤 api 远程请求失败后返回的错误信息 | 单个步骤提交失败 | | finished | `event.data: object` 即将提交的表单数据
`[name]: any` 当前数据域中指定字段的值 | 最终提交时触发 | | submitSucc | `result: object` api 远程请求成功后返回的结果数据 | 最终提交成功时触发 | | submitFail | `error: object` api 远程请求失败后返回的错误信息 | 最终提交失败时触发 | ## 动作表 当前组件对外暴露以下特性动作，其他组件可以通过指定`actionType: 动作名称`、`componentId: 该组件id`来触发这些动作，动作配置可以通过`args: {动作配置项名称: xxx}`来配置具体的参数，详细请查看[事件动作](../../docs/concepts/event-action#触发其他组件的动作)。 | 动作名称 | 动作配置 | 说明 | | ----------- | -------------------------- | ---------------------------------------- | | submit | - | 全部提交 | | step-submit | - | 分步提交 | | next | - | 下一步 | | prev | - | 上一步 | | goto-step | `step: number` 目标步骤 | 定位步骤 | | reload | - | 重新加载，调用 `intiApi`，刷新数据域数据 | | setValue | `value: object` 更新的数据 | 更新数据 |