Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: steps form #179

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/config/handbook.ts
Original file line number Diff line number Diff line change
Expand Up @@ -689,6 +689,12 @@ export default [
'title.ja-JP': 'チャート',
link: '/handbook/data-visualization/',
},
{
title: 'Multi-step form',
'title.zh-CN': '分步表单',
'title.ja-JP': '多段階フォーム',
link: '/handbook/block-steps-from',
},
],
},
{
Expand Down
65 changes: 65 additions & 0 deletions docs/en-US/handbook/block-steps-from/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Multi-step form

## Introduction
Multi-step form is a block used to build a data entry and editing interface that supports step-by-step configuration on top of the capabilities of the form block.

## Adding Blocks

<video width="100%" height="440" controls>
<source src="https://static-docs.nocobase.com/202410101614107.mp4" type="video/mp4">
</video>

## Block Settings

![](https://static-docs.nocobase.com/202410101717319.png)


### Linkage Rules

Control the behavior of form fields through linkage rules.

![](https://static-docs.nocobase.com/202410101717884.png)

More content reference [Linkage rules](/handbook/ui/blocks/block-settings/linkage-rule)


### Block Height Setting

Example: Set the block height to "Specify height" mode.

<video width="100%" height="440" controls>
<source src="https://static-docs.nocobase.com/202410101623290.mp4" type="video/mp4">
</video>

More content reference [Block height](/handbook/ui/blocks/block-settings/block-height)

## Step Setting

### Add New Step

![](https://static-docs.nocobase.com/202410101718482.png)

### Update Step Title

![](https://static-docs.nocobase.com/202410101718755.png)

![](https://static-docs.nocobase.com/202410101718413.png)

### Adjust Step Sequence

<video width="100%" height="440" controls>
<source src="https://static-docs.nocobase.com/202410101633487.mp4" type="video/mp4">
</video>

## Configure Fields

Refer to the field configuration items [Form configuration field](/handbook/ui/blocks/data-blocks/form#configure-fields)

## Configure Actions

![](https://static-docs.nocobase.com/202410101719893.png)

- previous: return to the previous form
- next: switch to the next form
- [submit](/handbook/ui/actions/types/submit)
- [custom request](/handbook/action-custom-request)
65 changes: 65 additions & 0 deletions docs/ja-JP/handbook/block-steps-from/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# 分步表单

## 介绍
分步表单是用于构建数据输入和编辑界面的区块,在表单区块的能力之上支持分步配置。

## 添加区块

<video width="100%" height="440" controls>
<source src="https://static-docs.nocobase.com/202410101614107.mp4" type="video/mp4">
</video>

## 区块配置项

![](https://static-docs.nocobase.com/202410101717319.png)


### 联动规则

通过联动规则控制表单字段行为。

![](https://static-docs.nocobase.com/202410101717884.png)

更多内容参考 [联动规则](/handbook/ui/blocks/block-settings/linkage-rule)


### 设置区块高度

示例:设置区块高度为「指定高度」模式。

<video width="100%" height="440" controls>
<source src="https://static-docs.nocobase.com/202410101623290.mp4" type="video/mp4">
</video>

更多内容参考 [区块高度](/handbook/ui/blocks/block-settings/block-height)

## 分步配置

### 添加新的步骤

![](https://static-docs.nocobase.com/202410101718482.png)

### 编辑步骤名称

![](https://static-docs.nocobase.com/202410101718755.png)

![](https://static-docs.nocobase.com/202410101718413.png)

### 调整步骤顺序

<video width="100%" height="440" controls>
<source src="https://static-docs.nocobase.com/202410101633487.mp4" type="video/mp4">
</video>

## 配置字段

字段配置项可参考 [表单配置字段](/handbook/ui/blocks/data-blocks/form#配置字段)

## 配置操作

![](https://static-docs.nocobase.com/202410101719893.png)

- 上一步:返回上一个表单
- 下一步:切换到下一个表单
- [提交](/handbook/ui/actions/types/submit)
- [自定义请求](/handbook/action-custom-request)
65 changes: 65 additions & 0 deletions docs/zh-CN/handbook/block-steps-from/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# 分步表单

## 介绍
分步表单是用于构建数据输入和编辑界面的区块,在表单区块的能力之上支持分步配置。

## 添加区块

<video width="100%" height="440" controls>
<source src="https://static-docs.nocobase.com/202410101614107.mp4" type="video/mp4">
</video>

## 区块配置项

![](https://static-docs.nocobase.com/202410101717319.png)


### 联动规则

通过联动规则控制表单字段行为。

![](https://static-docs.nocobase.com/202410101717884.png)

更多内容参考 [联动规则](/handbook/ui/blocks/block-settings/linkage-rule)


### 设置区块高度

示例:设置区块高度为「指定高度」模式。

<video width="100%" height="440" controls>
<source src="https://static-docs.nocobase.com/202410101623290.mp4" type="video/mp4">
</video>

更多内容参考 [区块高度](/handbook/ui/blocks/block-settings/block-height)

## 分步配置

### 添加新的步骤

![](https://static-docs.nocobase.com/202410101718482.png)

### 编辑步骤名称

![](https://static-docs.nocobase.com/202410101718755.png)

![](https://static-docs.nocobase.com/202410101718413.png)

### 调整步骤顺序

<video width="100%" height="440" controls>
<source src="https://static-docs.nocobase.com/202410101633487.mp4" type="video/mp4">
</video>

## 配置字段

字段配置项可参考 [表单配置字段](/handbook/ui/blocks/data-blocks/form#配置字段)

## 配置操作

![](https://static-docs.nocobase.com/202410101719893.png)

- 上一步:返回上一个表单
- 下一步:切换到下一个表单
- [提交](/handbook/ui/actions/types/submit)
- [自定义请求](/handbook/action-custom-request)
Loading