Tabs

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.
  • RadioButton: for secondary tabs.

    Examples

Content of Tab Pane 1

basic Usage

Default activate first tab.

Content of Tab Pane 1

Content of Tab Pane 1

Content of Tab Pane 1

Container of card type Tab

Should be used at the top of container, needs to override styles.

Content of Tab Pane 1

Card type tab

Another type Tabs, which doesn't support vertical mode.

Content of Tab 1

Customized trigger of new tab

Hide default plus icon, and bind event for customized trigger.

Tab 1

Disabled

Disabled a tab.

Content of Tab 1

Add & close tab

Only card type Tabs support adding & closable.
+Use closable={false} to disable close.

Content of tab 1

Extra content

You can add extra actions to the right of Tabs.

Tab 2

Icon

The Tab with Icon.

Content of Tab 1

Position

Tab's position: left, right, top or bottom.

Content of tab 2

Size

Large size tabs are usally used in page header, and small size could be used in Modal.

Content of tab 1

Slide

Tab can be slide to left or right(up or down), which is used for a lot of tabs.

API

Tabs

Property Description Type Default
activeKey Current TabPane's key string -
animated Whether to change tabs with animation. Only works while tabPosition="top"\|"bottom" boolean | {inkBar:boolean, tabPane:boolean} true, false when type="card"
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
size preset tab bar size large | default | small default
tabBarExtraContent Extra content in tab bar slot -
tabBarStyle Tab bar style object object -
tabPosition Position of tabs top | right | bottom | left top
type Basic style of tabs line | card | editable-card line
tabBarGutter The gap between tabs number -

Events

Events Name Description Arguments
change Callback executed when active tab is changed Function(activeKey) {}
edit Callback executed when tab is added or removed. Only works while type="editable-card" (targetKey, action): void
nextClick Callback executed when next button is clicked Function
prevClick Callback executed when prev button is clicked Function
tabClick Callback executed when tab is clicked Function

Tabs.TabPane

Property Description Type Default
forceRender Forced render of content in tabs, not lazy render after clicking on tabs boolean false
key TabPane's key string -
tab Show text in TabPane's head string|slot -