2016-08-03 10:39:20 +08:00
---
category: Components
2022-11-09 12:28:04 +08:00
group: Data Display
2016-09-21 11:28:38 +08:00
title: Tabs
2022-11-30 20:14:41 +08:00
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*72NDQqXkyOEAAAAAAAAAAAAADrJ8AQ/original
2023-02-09 22:17:31 +08:00
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*8HMoTZUoSGoAAAAAAAAAAAAADrJ8AQ/original
2016-08-03 10:39:20 +08:00
---
Tabs make it easy to switch between different views.
2016-09-10 13:43:30 +08:00
### When To Use
2016-08-03 10:39:20 +08:00
2017-09-18 10:27:49 +08:00
Ant Design has 3 types of Tabs for different situations.
2016-08-03 10:39:20 +08:00
- Card Tabs: for managing too many closeable views.
2016-09-01 18:12:12 +08:00
- Normal Tabs: for functional aspects of a page.
2020-04-09 16:12:47 +08:00
- [Radio.Button ](/components/radio/#components-radio-demo-radiobutton ): for secondary tabs.
2016-08-03 10:39:20 +08:00
2022-11-09 12:28:04 +08:00
## Examples
2022-11-17 17:31:26 +08:00
<!-- prettier - ignore -->
2022-11-09 12:28:04 +08:00
< 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 >
2023-08-30 21:28:45 +08:00
< code src = "./demo/custom-indicator.tsx" > Indicator< / code >
2022-11-09 12:28:04 +08:00
< 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 >
2023-01-05 15:30:59 +08:00
< code src = "./demo/card-top.tsx" compact background = "grey" debug > Container of card type Tab< / code >
2022-11-09 12:28:04 +08:00
< 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 >
2023-06-02 01:27:30 +08:00
< code src = "./demo/component-token.tsx" debug > component Token< / code >
2022-11-09 12:28:04 +08:00
2016-08-03 10:39:20 +08:00
## API
2023-08-08 18:27:48 +08:00
Common props ref: [Common props](/docs/react/common-props)
2016-08-03 10:39:20 +08:00
### Tabs
2022-11-30 20:14:41 +08:00
<!-- prettier - ignore -->
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default | Version |
2022-11-21 22:16:01 +08:00
| --- | --- | --- | --- | --- |
2022-11-17 17:31:26 +08:00
| activeKey | Current TabPane's key | string | - | |
| addIcon | Customize add icon | ReactNode | - | 4.4.0 |
2023-08-21 10:03:48 +08:00
| animated | Whether to change tabs with animation. | boolean \| { inkBar: boolean, tabPane: boolean } | { inkBar: true, tabPane: false } | |
2022-11-17 17:31:26 +08:00
| 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 | |
2023-08-30 21:28:45 +08:00
| indicatorSize | Customize length of indicator, which is the same as tab by default | number \| (origin: number) => number | - | 5.9.0 |
2022-12-22 14:12:26 +08:00
| items | Configure tab content | [TabItemType ](#tabitemtype ) | [] | 4.23.0 |
2022-11-17 17:31:26 +08:00
| 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 | - | |
2023-01-29 12:31:34 +08:00
| tabPosition | Position of tabs | `top` \| `right` \| `bottom` \| `left` | `top` | |
2022-11-17 17:31:26 +08:00
| 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 |
2019-03-15 19:01:20 +08:00
2022-10-08 17:20:46 +08:00
More option at [rc-tabs tabs ](https://github.com/react-component/tabs#tabs )
2016-08-03 10:39:20 +08:00
2022-10-03 22:27:26 +08:00
### TabItemType
2017-10-25 10:25:44 +08:00
2023-10-17 10:50:12 +08:00
| Property | Description | Type | Default | Version |
2023-10-16 13:40:47 +08:00
| --- | --- | --- | --- | --- |
2023-10-17 10:50:12 +08:00
| closeIcon | Customize close icon in TabPane's head. Only works while `type="editable-card"` . 5.7.0: close button will be hidden when setting to `null` or `false` | boolean \| ReactNode | - | |
2023-10-16 13:40:47 +08:00
| destroyInactiveTabPane | Whether destroy inactive TabPane when change tab | boolean | false | 5.11.0 |
2023-10-17 10:50:12 +08:00
| 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 | - | |
2023-11-28 11:49:10 +08:00
| icon | TabPane's head display icon | ReactNode | - | 5.12.0 |
2023-10-17 10:50:12 +08:00
| children | TabPane's head display content | ReactNode | - | |
2023-11-14 19:40:37 +08:00
| closable | Whether a close (x) button is visible, Only works while `type="editable-card"` | boolean | true | |
2023-04-11 10:25:24 +08:00
## Design Token
< ComponentTokenTable component = "Tabs" > < / ComponentTokenTable >