mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-04 00:49:39 +08:00
cbcfd38ca7
* build: try to use dumi as doc tool
* docs: migrate demo structure to dumi way
* refactor: use type export & import
* docs: migrate demo previewer to dumi
* docs: create empty layout & components
* docs: apply custom rehype plugin
* docs: create empty extra pages
* docs: Add Banner component
* chore: move theme tsconfig.json
* docs: home page init
* docs: migrate header (#37896)
* docs: header
* docs: update
* docs: home init
* clean up
* test: fix site lint
* chore: tsc ignore demo
* chore: dumi demo migrate script
* chore: cards
* docs: home layout
* docs: Update locale logic
* docs: fix getLink logic
* chore: fix ci (#37899)
* chore: fix ci
* ci: remove check-ts-demo
* ci: preview build
* test: ignore demo.tsx
* chore: update script
* test: update snapshot
* test: update node and image test
* chore: add .surgeignore
* docs: layout providers (#37908)
* docs: add components sidebar (#37923)
* docs: sidebar
* docs: update docs title
* docs: update design doc
* chore: code clean
* docs: handle changelog page
* docs: add title
* docs: add subtitle
* docs: active header nav
* chore: code clean
* docs: overview
* chore: code clean
* docs: update intl (#37918)
* docs: update intl
* chore: code clean
* docs: update favicons
* chore: update testPathIgnorePatterns
* chore: code clean
* chore: code clean
* chore: copy 404.html (#37996)
* docs: Home page theme picker
* chore: Update migrate script
* docs: home page update
* docs: theme editor style
* docs: theme lang
* chore: update migrate.js
* docs: fix demo (#38094)
* chore: update migrate.js
* docs: update md
* docs: update demo
* test: fix snapshot
* chore: move debug to code attr in migrate script
* chore: update md
Co-authored-by: PeachScript <scdzwyxst@gmail.com>
* feat: overview page
* feat: Migrate `404` page (#38118)
* feat: migrate IconSearch component (#37916)
* feat<site/IconSearch>: copy IconDisplay from site to .dumi
* feat<site/IconSearch>: change docs of icon
* feat<site/IconSearch>: tweak
* feat<site/IconSearch>: use useIntl instead of injectIntl
* feat<site/IconSearch>: fix ts type error
* feat<site/IconSearch>: use intl.formatMessage to render text
* docs: Adjust home btn sizw
* docs: Update doc
* feat: v5 site overview page (#38131)
* feat: site
* fix: fix
* feat: v5 site overview page
* fix: fix path
* fix: fix
* fix: fix
* docs: fix margin logic
* feat: v5 site change-log page (#38137)
* feat: v5 site change-log page (#38162)
* docs: site redirect to home pag
* docs: theme picker
* docs: use react-intl from dumi (#38183)
* docs: Theme Picker
* docs: update dumi config
* docs: home back fix
* docs: picker colorful
* docs: locale of it
* docs: update components desc
* docs: site of links
* docs: update components list
* docs: update desc
* feat: Migrate `DemoWrapper` component (#38166)
* feat: Migrate `DemoWrapper` component
* feat: remove invalid comments and add comment for `key` prop
* docs: FloatButton pure panel
* chore: update demo
* chore: update dumi config
* Revert "chore: update demo"
This reverts commit 028265d3ba.
* chore: test logic adjust to support cnpm modules
* chore: add locale alias
* docs: /index to /
* docs: add locale redirect head script
* chore: adjust compact
* docs: fix missing token
* feat: compact switch
* chore: code clean
* docs: update home
* docs: fix radius token
* docs: hash of it
* chore: adjust home page
* docs: Add background map
* docs: site theme bac logic
* docs: avatar
* docs: update logo color
* docs: home banner
* docs: adjust tour size
* docs: purepanl update
* docs: transfooter
* docs: update banner gif
* docs: content (#38361)
* docs: title & EditButton
* docs: content
* chore: fix toc
* docs: resource page
* docs: transform resource data from hast
* docs: filename & Resource Card
* chore: enable prerender
* chore: remove less
* docs: toc style
* chore: fix lint
* docs: fix Layout page
* docs: fix CP page
* chore: update demos
* docs: workaround for export dynamic html
* chore: enable demo eslint
* docs: table style
* fix: header shadow
* chore: update snapshot
* fix: toc style
* docs: add title
* docs: Adjust site
* feat: helmet
* docs: site css
* fix: description
* feat: toc debug
* docs: update config-provider
* feat: use colorPanel
* fix: colorPanel value
* feat: anchor ink ball style
* feat: apply theme editor
* fix: code block style
* chore: update demo
* chore: fix lint
* chore: code clean
* chore: update snapshot
* feat: ts2js
* chore: description
* docs: site ready for ssr
includes:
- move client render logic to useEffect in site theme
- extract antd cssinjs to a single css file like bisheng
- workaround to support react@18 pipeableStream for emotion
* chore: bump testing lib
* docs: font size of title
* chore: remove react-sortable-hoc
* chore: update snapshot
* chore: update script
Co-authored-by: PeachScript <scdzwyxst@gmail.com>
Co-authored-by: MadCcc <1075746765@qq.com>
Co-authored-by: zqran <uuxnet@gmail.com>
Co-authored-by: TrickyPi <530257315@qq.com>
Co-authored-by: lijianan <574980606@qq.com>
203 lines
7.8 KiB
Markdown
203 lines
7.8 KiB
Markdown
---
|
||
group: Design Patterns
|
||
type: Template Document
|
||
order: 1
|
||
skip: true
|
||
title: Form Page
|
||
---
|
||
|
||
表单页是一种用于信息添加、录入的页面类型。用来确保用户按照要求录入信息提交给系统使用或引导用户进行应用设置。
|
||
|
||
## 设计目标
|
||
|
||
帮助用户明确当前页面任务，快速查找和定位修改目标，轻松准确地理解表单项含义及生效后果，同时简化填写流程，确保用户准确、轻松、快速地完成任务。
|
||
|
||
## 设计原则
|
||
|
||
|
||
|
||
### Do & Don't
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
## 如何设计
|
||
|
||
表单类页面模板聚焦于提交一次表单的过程体验。按照任务的复杂度，提供多种解决问题的思路：
|
||
|
||
- [普通布局](#WdpbA)
|
||
- [任务拆解和编排](#IzXxO)
|
||
- [填写和预览](#00nna)
|
||
- [特定场景](#yToPl)
|
||
|
||
### 普通布局
|
||
|
||
平铺所有需要填写的信息，适合内容项较少、内容项无法按照相关性分组的表单。
|
||
|
||
#### [模板 - 基础表单](http://preview-techui.dockerlab.alipay.net/createProject)
|
||
|
||
**什么时候用**
|
||
|
||
当需要完成一个简单快速的任务，例如输入少量信息即可完成创建。
|
||
|
||
|
||
|
||
### 任务拆解和编排
|
||
|
||
将大型、复杂任务拆解为多个部分，并按照相关性分组，减轻用户输入负担。尽管每部分内容单独处理，但最终一起完成提交。适用于大型、复杂表单。通过适当的任务分割，可以降低用户出错率。
|
||
|
||
#### [模板 - 基础分步表单](http://preview-techui.dockerlab.alipay.net/stepform)
|
||
|
||
作者：晴风将用户需要填写和确认的信息按照线性流程组织，利用步骤条告知用户完整流程和进度，常常在最后提交前让用户再次确认信息，并在流程结束给与明确的结果反馈。
|
||
|
||
**什么时候用**
|
||
|
||
适用于具有明确的线性逻辑的任务。
|
||
|
||
|
||
|
||
#### 模板 - 同页分步表单 (Coming soon...)
|
||
|
||
**什么时候用**
|
||
|
||
用户需要在同一页面查看表单的完整上下文，而不是像基础分步表单那样拆解为多个独立任务。
|
||
|
||
|
||
|
||
#### [模板 - 分组表单](http://preview-techui.dockerlab.alipay.net/groupviews)
|
||
|
||
**什么时候用**
|
||
|
||
单次任务的表单页中需要填写内容众多，且不同内容之中存在一定可分类归纳性。
|
||
|
||
|
||
|
||
#### 模板 - 分组编辑
|
||
|
||
**什么时候用**
|
||
|
||
内容量特别大的表单或常常仅需编辑部分内容的表单，该模式常见于详情页的内容编辑。
|
||
|
||
|
||
|
||
#### 模板 - 可编辑列表 (开发中...)
|
||
|
||
**什么时候用**
|
||
|
||
适用于页面中需要添加一个或多个对象，且每个对象都需要添加或编辑多组数据的情况。
|
||
|
||
**选择合适的模板**
|
||
|
||
A. 动态增减：建议条目表单数 <=3 项，并且每个输入框不需要单独的标题使用。 B. 可编辑表格：建议条目表单数 2 ～ 5 项 时使用，以使得每行内容可被完整呈现。 C. 折叠面板编辑：建议条目表单数在 6 ～ 8 项 时使用。 D. 抽屉编辑：建议条目表单表单数 >8 项 时使用 E. 规则树：应用于规则编辑场景。
|
||
|
||
|
||
|
||
#### 模板 - 联动表单 (Coming soon...)
|
||
|
||
**什么时候用**
|
||
|
||
一般分为显示联动、数据联动、事件联动，当需要展示联动选项的时候使用。
|
||
|
||
|
||
|
||
### 填写和预览
|
||
|
||
填写表单的同时提供信息摘要区或实时效果图，便于在提交前预览和确认重要信息，适用于需要提前预知表单生效后关键信息场景。
|
||
|
||
#### 模板 - 下单页(Coming soon...)
|
||
|
||
|
||
|
||
### 特定场景模板
|
||
|
||
#### [模板 - 设置](http://preview-techui.dockerlab.alipay.net/settingform)
|
||
|
||
**什么时候用**
|
||
|
||
个人档案、应用配置等设置类页面，使用频率较低，一般用户操作后不会频繁修改。
|
||
|
||
**使用建议**
|
||
|
||
- 每个页面选择一种设置模式：
|
||
- **即时生效模式：**用户在修改选项即生效；
|
||
- 提交生效模式：当设置项之间有关联关系，使用提交生效模式。
|
||
- 根据设置项数量确定是否需要分组：
|
||
- 数量 <7 项，不建议分组；
|
||
- 数量 7~ 15 个建议分组；
|
||
- 数量 >15 个建议使用页签分组；
|
||
|
||
|
||
|
||
#### [模板 - 登录](https://preview.pro.ant.design/user/login)
|
||
|
||
|
||
|
||
#### [模板 - 注册](https://preview.pro.ant.design/user/register)
|
||
|
||
|
||
|
||
### 设计建议
|
||
|
||
#### 前期准备
|
||
|
||
- 表单页的核心由表单项组成，设计前建议先熟悉表单基础规则；
|
||
- 梳理用户当前信息录入任务中所涉及的信息类型，并根据 [antd 数据录入规则](/docs/spec/data-entry-cn#header) 确定所使用的组件；
|
||
|
||
#### 布局方式
|
||
|
||
在单个表单页中需要根据内容量进行合理地布局，以兼顾页面展示和用户效率。表单页布局可由简到繁划分为 4 个梯度，每一级梯度都兼容前一种布局方式。
|
||
|
||
**基础布局**
|
||
|
||
在一个区域内从上到下单列布局，引导用户纵向阅读，据[研究](https://www.uxmatters.com/mt/archives/2006/07/label-placement-in-forms.php)这是能够最高效完成任务的布局方式。
|
||
|
||
> 以下“区域”特指页面、抽屉、弹窗、卡片内或分组标题下。
|
||
|
||
|
||
|
||
**弱分组**
|
||
|
||
在空间有限时，较短宽度且具有相关性的表单项可多个组合在一行中，形成分组的暗示。
|
||
|
||
|
||
|
||
|
||
|
||
为避免和弱分组布局的阅读顺序混淆，一个区域内禁用多列表单。
|
||
|
||
|
||
|
||
**区域内分组**
|
||
|
||
当一个区域中内容较多且存在可分类归纳性时，可通过区分标题来进行区域内分组。
|
||
|
||
|
||
|
||
**卡片分组**
|
||
|
||
当一个页面中内容众多（通常大于两屏）且存在可分类归纳性时，可通过卡片分组来承载。每个卡片需要包含一个大标题。
|
||
|
||
|
||
|
||
关于使用何种布局方式的判断，和详情页类似，应从信息的复杂度和关联性两个维度去梳理。随后可选择相匹配的模板，进行页面快速搭建。将相关的元素分组到一起。
|
||
|
||
|
||
|
||
## 4. 扩展阅读
|
||
|
||
### 会用到哪些模块或组件
|
||
|
||
- [数据录入组件](/components/form-cn/#header)
|
||
- [步骤条](/components/steps-cn/#header)
|
||
|
||
### 相关页面
|
||
|
||
- [列表页](/docs/spec/research-list)
|
||
- [结果页](/docs/spec/research-result)
|
||
- [详情页](/docs/spec/detail-page)
|