ant-design/components/tabs/index.en-US.md
Dreamcreative 4281739d5d
docs: update Tabs component onEdit prop describe (#35271)
* docs: update Tabs component  onEdit prop describe

* docs: update Tabs component  onEdit prop describe

* Apply suggestions from code review

Co-authored-by: afc163 <afc163@gmail.com>
2022-04-30 15:11:41 +08:00

2.9 KiB

category type title cols cover
Components Data Display Tabs 1 https://gw.alipayobjects.com/zos/antfincdn/lkI2hNEDr2V/Tabs.svg

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

API

Tabs

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
moreIcon The custom icon of ellipsis ReactNode <EllipsisOutlined /> 4.14.0
renderTabBar Replace the TabBar (props: DefaultTabBarProps, DefaultTabBar: React.ComponentClass) => React.ReactElement -
size Preset tab bar size large | default | small default
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 option

Tabs.TabPane

Property Description Type Default
closeIcon Customize close icon in TabPane's head. Only works while type="editable-card" ReactNode -
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 ReactNode -

More option at rc-tabs option