mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-11 23:00:20 +08:00
76241f5d0b
* 做重复了 * Revert "做重复了" This reverts commit 79c59e79ea66c6592df9dca0e41e10399044ec7a. * site(theme): demo block supports no inner margin configuration ref: https://d.umijs.org/guide/write-demo#%E4%B8%8D%E9%9C%80%E8%A6%81%E5%86%85%E8%BE%B9%E8%B7%9D * docs(tabs): update demo styles * chore: update style * test: update snapshot * Revert "site(theme): demo block supports no inner margin configuration" This reverts commitee2ff25796. * chore: update * Revert "chore: update" This reverts commitbbe449cb3f. * Revert "Revert "site(theme): demo block supports no inner margin configuration"" This reverts commit5eac19e7f2. * chore: convert to debug demo * chore: use emotion * test: update snapshot
79 lines
4.0 KiB
Markdown
79 lines
4.0 KiB
Markdown
---
|
|
category: Components
|
|
group: Data Display
|
|
title: Tabs
|
|
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*72NDQqXkyOEAAAAAAAAAAAAADrJ8AQ/original
|
|
---
|
|
|
|
Tabs make it easy to switch between different views.
|
|
|
|
### When To Use
|
|
|
|
Ant Design has 3 types of Tabs for different situations.
|
|
|
|
- Card Tabs: for managing too many closeable views.
|
|
- Normal Tabs: for functional aspects of a page.
|
|
- [Radio.Button](/components/radio/#components-radio-demo-radiobutton): for secondary tabs.
|
|
|
|
## Examples
|
|
|
|
<!-- prettier-ignore -->
|
|
<code src="./demo/basic.tsx">Basic</code>
|
|
<code src="./demo/disabled.tsx">Disabled</code>
|
|
<code src="./demo/centered.tsx">Centered</code>
|
|
<code src="./demo/icon.tsx">Icon</code>
|
|
<code src="./demo/slide.tsx">Slide</code>
|
|
<code src="./demo/extra.tsx">Extra content</code>
|
|
<code src="./demo/size.tsx">Size</code>
|
|
<code src="./demo/position.tsx">Position</code>
|
|
<code src="./demo/card.tsx">Card type tab</code>
|
|
<code src="./demo/editable-card.tsx">Add & close tab</code>
|
|
<code src="./demo/card-top.tsx" compact debug>Container of card type Tab</code>
|
|
<code src="./demo/custom-add-trigger.tsx">Customized trigger of new tab</code>
|
|
<code src="./demo/custom-tab-bar.tsx">Customized bar of tab</code>
|
|
<code src="./demo/custom-tab-bar-node.tsx">Draggable Tabs</code>
|
|
<code src="./demo/animated.tsx" debug>Animated</code>
|
|
<code src="./demo/nest.tsx" debug>Nest</code>
|
|
|
|
## API
|
|
|
|
### Tabs
|
|
|
|
<!-- prettier-ignore -->
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| activeKey | Current TabPane's key | string | - | |
|
|
| addIcon | Customize add icon | ReactNode | - | 4.4.0 |
|
|
| animated | Whether to change tabs with animation. Only works while `tabPosition="top"` | boolean \| { inkBar: boolean, tabPane: boolean } | { inkBar: true, tabPane: false } | |
|
|
| centered | Centers tabs | boolean | false | 4.4.0 |
|
|
| defaultActiveKey | Initial active TabPane's key, if `activeKey` is not set | string | - | |
|
|
| hideAdd | Hide plus icon or not. Only works while `type="editable-card"` | boolean | false | |
|
|
| items | Configure tab content | [TabItemType](#tabitemtype) | [] | 4.23.0 |
|
|
| moreIcon | The custom icon of ellipsis | ReactNode | <EllipsisOutlined /> | 4.14.0 |
|
|
| popupClassName | `className` for more dropdown. | string | - | 4.21.0 |
|
|
| renderTabBar | Replace the TabBar | (props: DefaultTabBarProps, DefaultTabBar: React.ComponentClass) => React.ReactElement | - | |
|
|
| size | Preset tab bar size | `large` \| `middle` \| `small` | `middle` | |
|
|
| tabBarExtraContent | Extra content in tab bar | ReactNode \| {left?: ReactNode, right?: ReactNode} | - | object: 4.6.0 |
|
|
| tabBarGutter | The gap between tabs | number | - | |
|
|
| tabBarStyle | Tab bar style object | CSSProperties | - | |
|
|
| tabPosition | Position of tabs | `top` \| `right` \| `bottom` \ | `left` | `top` | |
|
|
| destroyInactiveTabPane | Whether destroy inactive TabPane when change tab | boolean | false | |
|
|
| type | Basic style of tabs | `line` \| `card` \| `editable-card` | `line` | |
|
|
| onChange | Callback executed when active tab is changed | function(activeKey) {} | - | |
|
|
| onEdit | Callback executed when tab is added or removed. Only works while `type="editable-card"` | (action === 'add' ? event : targetKey, action): void | - | |
|
|
| onTabClick | Callback executed when tab is clicked | function(key: string, event: MouseEvent) | - | |
|
|
| onTabScroll | Trigger when tab scroll | function({ direction: `left` \| `right` \| `top` \| `bottom` }) | - | 4.3.0 |
|
|
|
|
More option at [rc-tabs tabs](https://github.com/react-component/tabs#tabs)
|
|
|
|
### TabItemType
|
|
|
|
| Property | Description | Type | Default |
|
|
| --- | --- | --- | --- |
|
|
| closeIcon | Customize close icon in TabPane's head. Only works while `type="editable-card"` | ReactNode | - |
|
|
| disabled | Set TabPane disabled | boolean | false |
|
|
| forceRender | Forced render of content in tabs, not lazy render after clicking on tabs | boolean | false |
|
|
| key | TabPane's key | string | - |
|
|
| label | TabPane's head display text | ReactNode | - |
|
|
| children | TabPane's head display content | ReactNode | - |
|