ant-design/components/tabs/index.zh-CN.md

51 lines
2.4 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
2016-09-21 11:28:38 +08:00
subtitle: 标签页
type: 数据展示
2016-09-21 11:28:38 +08:00
title: Tabs
2017-06-26 20:20:57 +08:00
cols: 1
2016-03-31 14:17:09 +08:00
---
2015-05-27 15:43:29 +08:00
2015-06-09 18:17:20 +08:00
选项卡切换组件。
2015-05-27 15:43:29 +08:00
2015-06-14 17:54:08 +08:00
## 何时使用
提供平级的区域将大块内容进行收纳和展现,保持界面整洁。
2015-12-17 12:36:10 +08:00
Ant Design 依次提供了三级选项卡,分别用于不同的场景。
2015-12-15 17:30:06 +08:00
2015-12-17 12:36:10 +08:00
- 卡片式的页签,提供可关闭的样式,常用于容器顶部。
- 标准线条式页签,用于容器内部的主功能切换,这是最常用的 Tabs。
2016-11-06 15:45:39 +08:00
- [RadioButton](/components/radio/#components-radio-demo-radiobutton) 可作为更次级的页签来使用。
2015-06-14 17:54:08 +08:00
2015-06-09 18:17:20 +08:00
## API
2015-05-27 15:43:29 +08:00
2015-06-15 19:56:58 +08:00
### Tabs
2015-05-27 15:43:29 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| activeKey | 当前激活 tab 面板的 key | string | 无 |
| animated | 是否使用动画切换 Tabs`tabPosition=top|bottom` 时有效 | boolean \| {inkBar:boolean, tabPane:boolean} | true, 当 type="card" 时为 false |
| renderTabBar | 替换 TabBar用于二次封装标签头 | (props: DefaultTabBarProps, DefaultTabBar: React.ComponentClass) => React.ReactElement | 无 |
| defaultActiveKey | 初始化选中面板的 key如果没有设置 activeKey | string | 第一个面板 |
| hideAdd | 是否隐藏加号图标,在 `type="editable-card"` 时有效 | boolean | false |
| size | 大小,提供 `large` `default``small` 三种大小 | string | 'default' |
| tabBarExtraContent | tab bar 上额外的元素 | React.ReactNode | 无 |
| tabBarGutter | tabs 之间的间隙 | number | 无 |
| tabBarStyle | tab bar 的样式对象 | object | - |
| tabPosition | 页签位置,可选值有 `top` `right` `bottom` `left` | string | 'top' |
| type | 页签的基本样式,可选 `line`、`card` `editable-card` 类型 | string | 'line' |
| onChange | 切换面板的回调 | Function(activeKey) {} | 无 |
| onEdit | 新增和删除页签的回调,在 `type="editable-card"` 时有效 | (targetKey, action): void | 无 |
| onNextClick | next 按钮被点击的回调 | Function | 无 |
| onPrevClick | prev 按钮被点击的回调 | Function | 无 |
| onTabClick | tab 被点击的回调 | Function | 无 |
2015-05-27 15:43:29 +08:00
2015-06-15 19:56:58 +08:00
### Tabs.TabPane
2015-05-27 15:43:29 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| ----------- | ------------------------- | ----------------- | ------ |
| forceRender | 被隐藏时是否渲染 DOM 结构 | boolean | false |
| key | 对应 activeKey | string | 无 |
| tab | 选项卡头显示文字 | string\|ReactNode | 无 |