mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-02 03:59:01 +08:00
Fix doc headings
This commit is contained in:
parent
c79826ea83
commit
0e6f677ff9
@ -6,7 +6,7 @@ english: Affix
|
||||
|
||||
Make an element sticky to viewport.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
When user browses a long web page, some content need to sticky to viewport. It is common for menus and actions.
|
||||
|
||||
|
@ -6,7 +6,7 @@ english: Alert
|
||||
|
||||
Alert component for feedback.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
- When you need to show alert messages for users.
|
||||
- When you need a persist static container, and closable by user actions.
|
||||
|
@ -7,7 +7,7 @@ title: AutoComplete
|
||||
|
||||
Autocomplete function of input field.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
When need to use autocomplete function.
|
||||
|
||||
|
@ -6,7 +6,7 @@ english: Badge
|
||||
|
||||
Small numerical value or status descriptors for UI elements.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
Badge normally appears in proximity to notification or head picture with eye-catching appeal, typically displaying unread messages count.
|
||||
|
||||
|
@ -6,7 +6,7 @@ title: Breadcrumb
|
||||
|
||||
A breadcrumb displays the current location within a hierarchy. It allows going back to states higher up within the hierarchy.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
- When the system has more than two layers in a hierarchy.
|
||||
- When you need to inform the user of where they are.
|
||||
|
@ -5,9 +5,9 @@ cols: 1
|
||||
title: Calendar
|
||||
---
|
||||
|
||||
When to use container for displaying data in calendar form.
|
||||
When To Use container for displaying data in calendar form.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
When data is in the form of date, such as schedule, timetable, prices calendar, Lunar calendar. This component also supports Year/Month switch.
|
||||
|
||||
|
@ -7,7 +7,7 @@ cols: 1
|
||||
|
||||
Simple rectangular container
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
A card can be used to display content related to a single subject. The content can consist of multiple elements of varying type and size.
|
||||
|
||||
|
@ -6,7 +6,7 @@ title: Carousel
|
||||
|
||||
A carousel component. Scales with its container.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
- When there is a group of content on the same level.
|
||||
- When there is insufficient content space, it can be used to save space in the form of a resolving door.
|
||||
|
@ -7,7 +7,7 @@ title: Cascader
|
||||
Cascade selection box.
|
||||
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
- When you need to select from a set of associated data set. Such as province/city/district, company level, things classification.
|
||||
- When selecting from a large data set, with multi-stage classification separated for easy selection.
|
||||
|
@ -6,7 +6,7 @@ title: Collapse
|
||||
|
||||
A content area which can be collapsed and expanded.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
- Can be used to group or hide complex regions to keep the page clean.
|
||||
- `Accordion` is a special kind of `Collapse`, which allows only one panel to be expanded at a time.
|
||||
|
@ -9,13 +9,13 @@ Meaningful vector graphics.
|
||||
|
||||
## Icons naming convention
|
||||
|
||||
We provide semantic name for every icon, and naming rules are as follows:
|
||||
We provide semantic name for every icon, and naming rules are as follows:
|
||||
|
||||
- Scanning line icon has the similar name with its solid one,but it's distinguished by `-o`, for example, `question-circle`(a full circle) and `question-circle-o`(an empty circle);
|
||||
|
||||
- Naming sequence:`[icon's name]-[shape, optional]-[Scanning line or not]-[direction, optional]`.
|
||||
|
||||
## How to use
|
||||
## How To Use
|
||||
|
||||
Use tag <Icon /> to create an icon and set its type in the type prop, for example:
|
||||
|
||||
|
@ -6,7 +6,7 @@ title: InputNumber
|
||||
|
||||
Enter a number within certain range with the mouse or keyboard.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
When a numeric value needs to be provided.
|
||||
|
||||
|
@ -7,7 +7,7 @@ title: Input
|
||||
A basic widget for getting the user input is a text field.
|
||||
Keyboard and mouse can be used for providing or changing data.
|
||||
|
||||
## When to Use
|
||||
## When To Use
|
||||
|
||||
- A user input in a form field is needed.
|
||||
- A search input is required.
|
||||
|
@ -7,7 +7,7 @@ title: Menu
|
||||
|
||||
Menu list of Navigation.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
Navigation menu is important for a website, it helps users jump from one site section to another quickly. Mostly, it includes top navigation and side navigation. Top navigation provides all the category and functions of the website. Side navigation provides the Multi-level structure of the website.
|
||||
|
||||
|
@ -6,7 +6,7 @@ english: Modal
|
||||
|
||||
Modal dialogs.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
When requiring users to interact with application, but without jumping to a new page to interrupt
|
||||
the user's workflow, you can use `Modal` to create a new floating layer over the current page for user
|
||||
|
@ -7,7 +7,7 @@ title: Notification
|
||||
|
||||
To display a notification message globally.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
To display a notification message at the top right of the view port. Typically it can be
|
||||
used in the following cases:
|
||||
|
||||
|
@ -6,7 +6,7 @@ title: Pagination
|
||||
|
||||
A long list can be divided into several pages by `Pagination`, and only one page will be loaded at a time.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
- When it will take a long time to load/render all items.
|
||||
- If you want to browse the data by switching in the pages.
|
||||
|
@ -6,7 +6,7 @@ title: Popconfirm
|
||||
|
||||
A simple and compact confirmation dialog of an action.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
A simple and compact dialog used for asking an user confirmation.
|
||||
|
||||
|
@ -6,7 +6,7 @@ english: Popover
|
||||
|
||||
The floating card popped by clicking or hovering.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
A simple popup menu to provide extra information or operations.
|
||||
|
||||
|
@ -6,7 +6,7 @@ title: Progress
|
||||
|
||||
To display the current progress of an operation flow.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
If it will take a long time to complete the operation, you can use `Progress` to show the current progress and status.
|
||||
|
||||
|
@ -6,7 +6,7 @@ title: Radio
|
||||
|
||||
Radio.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
- Used to select a single state in multiple options.
|
||||
- The different between Select, Radio is visible to user, it can facilitate users in the comparison of choice. So, when you want to use Radio, option should not be too much.
|
||||
|
@ -6,7 +6,7 @@ title: Rate
|
||||
|
||||
Rate component.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
- Show evalutate.
|
||||
- A quick rating operation on something.
|
||||
|
@ -6,7 +6,7 @@ title: Select
|
||||
|
||||
A Selector similar to Select2.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
A dropdown menu for choosing, an elegant alternative to the native select component.
|
||||
|
||||
|
@ -6,7 +6,7 @@ title: Slider
|
||||
|
||||
A Slider component for displaying current value and intervals in range.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
To input a value in a range.
|
||||
|
||||
|
@ -6,7 +6,7 @@ title: Spin
|
||||
|
||||
A Spin is used for displaying loading state of a page or a block.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
When partial of page is waiting for asynchronous data or during a rendering process, an appropriate loading animation can effectively alleviate users' inquietude.
|
||||
|
||||
|
@ -7,7 +7,7 @@ title: Steps
|
||||
|
||||
`Steps` is a navigation bar that guides users through the steps of a task.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
When the task is complicated or has a certain sequence in the series of subtasks, we can decompose it into several steps to make things easier.
|
||||
|
||||
|
@ -6,7 +6,7 @@ title: Switch
|
||||
|
||||
Switching Selector.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
- If you need to represent the switching between two states or on-off state.
|
||||
- The difference between `Switch` and `Checkbox` is that `Switch` will trigger a state change directly when you toggle it, while `Checkbox` is generally used for state marking, which should work in conjunction with submit operation.
|
||||
|
@ -7,12 +7,12 @@ title: Table
|
||||
|
||||
A table displays rows data.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
- To display a collections of structured data.
|
||||
- To sort, search, paging, filter data.
|
||||
|
||||
## How to use
|
||||
## How To Use
|
||||
|
||||
Sepecify `dataSource` of Table to be an array data.
|
||||
|
||||
|
@ -6,7 +6,7 @@ english: Tabs
|
||||
|
||||
Tabs make it easy to switch between different views.
|
||||
|
||||
### When to use
|
||||
### When To Use
|
||||
|
||||
Ant Design has 3 types Tabs for different situation.
|
||||
|
||||
|
@ -6,7 +6,7 @@ english: Tag
|
||||
|
||||
Tag for categorizing or markuping.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
- It can be used to tag by dimension or property.
|
||||
|
||||
|
@ -6,7 +6,7 @@ title: TimePicker
|
||||
|
||||
To select/input a time.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
--------
|
||||
|
||||
By clicking the input box, you can select a time from a popup panel.
|
||||
|
@ -6,7 +6,7 @@ title: TreeSelect
|
||||
|
||||
Tree selection control.
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
`TreeSelect` is similar with `Select`, but the values are provided in a tree like structure.
|
||||
Any data whose entries are defined in a hierarchical manner is fit to use this control. Examples of such case may include a corporate hierarchy, a directory structure, and so on.
|
||||
|
@ -4,7 +4,7 @@ type: Views
|
||||
title: Tree
|
||||
---
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
Directory, organization, biological classification, country, and etc. Almost things of the world are tree structure. The `Tree` component is a way of representing the hierarchical relationship of these things,and you also can expand, collapse, select the treeNodes of it.
|
||||
|
||||
|
@ -6,7 +6,7 @@ english: Upload
|
||||
|
||||
Upload file by selecting or dragging
|
||||
|
||||
## When to use
|
||||
## When To Use
|
||||
|
||||
Uploading is the process of publishing information (web pages, text, pictures, video, etc.) to a remote server via a web page or upload tool.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user