Spaces:
Paused
Paused
File size: 8,394 Bytes
93dd899 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 | ---
title: Tabs
sidebar_label: Tabs
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
import { StoryWithControls } from '../../../../src/components/StorybookWrapper';
# Tabs
A tabs component for switching between different views or content sections. Supports multiple tab styles, positions, and sizes.
## Live Example
<StoryWithControls
component="Tabs"
props={{
defaultActiveKey: '1',
type: 'line',
tabPosition: 'top',
size: 'middle',
animated: true,
centered: false,
tabBarGutter: 8,
items: [
{
key: '1',
label: 'Tab 1',
children: 'Content of Tab Pane 1',
},
{
key: '2',
label: 'Tab 2',
children: 'Content of Tab Pane 2',
},
{
key: '3',
label: 'Tab 3',
children: 'Content of Tab Pane 3',
},
],
}}
controls={[
{
name: 'defaultActiveKey',
label: 'Default Active Key',
type: 'text',
},
{
name: 'type',
label: 'Type',
type: 'inline-radio',
options: ['line', 'card', 'editable-card'],
description: 'The style of tabs. Options: line, card, editable-card.',
},
{
name: 'tabPosition',
label: 'Tab Position',
type: 'inline-radio',
options: ['top', 'bottom', 'left', 'right'],
description: 'Position of tabs. Options: top, bottom, left, right.',
},
{
name: 'size',
label: 'Size',
type: 'inline-radio',
options: ['small', 'middle', 'large'],
description: 'Size of the tabs.',
},
{
name: 'animated',
label: 'Animated',
type: 'boolean',
description: 'Whether to animate tab transitions.',
},
{
name: 'centered',
label: 'Centered',
type: 'boolean',
description: 'Whether to center the tabs.',
},
{
name: 'tabBarGutter',
label: 'Tab Bar Gutter',
type: 'number',
description: 'The gap between tabs.',
},
]}
/>
## Try It
Edit the code below to experiment with the component:
```tsx live
function Demo() {
return (
<Tabs
defaultActiveKey="1"
items={[
{ key: '1', label: 'Tab 1', children: 'Content of Tab Pane 1' },
{ key: '2', label: 'Tab 2', children: 'Content of Tab Pane 2' },
{ key: '3', label: 'Tab 3', children: 'Content of Tab Pane 3' },
]}
/>
);
}
```
## Card Style
```tsx live
function CardTabs() {
return (
<Tabs
type="card"
defaultActiveKey="1"
items={[
{
key: '1',
label: 'Dashboards',
children: 'View and manage your dashboards.',
},
{ key: '2', label: 'Charts', children: 'Browse all saved charts.' },
{
key: '3',
label: 'Datasets',
children: 'Explore available datasets.',
},
]}
/>
);
}
```
## Tab Positions
```tsx live
function TabPositions() {
const items = [
{ key: '1', label: 'Tab 1', children: 'Content 1' },
{ key: '2', label: 'Tab 2', children: 'Content 2' },
{ key: '3', label: 'Tab 3', children: 'Content 3' },
];
return (
<div style={{ display: 'flex', flexDirection: 'column', gap: 24 }}>
{['top', 'bottom', 'left', 'right'].map(pos => (
<div key={pos}>
<h4>{pos}</h4>
<Tabs tabPosition={pos} defaultActiveKey="1" items={items} />
</div>
))}
</div>
);
}
```
## With Icons
```tsx live
function IconTabs() {
return (
<Tabs
defaultActiveKey="1"
items={[
{
key: '1',
label: (
<>
<Icons.DashboardOutlined /> Dashboards
</>
),
children: 'Dashboard content here.',
},
{
key: '2',
label: (
<>
<Icons.LineChartOutlined /> Charts
</>
),
children: 'Chart content here.',
},
{
key: '3',
label: (
<>
<Icons.DatabaseOutlined /> Datasets
</>
),
children: 'Dataset content here.',
},
{
key: '4',
label: (
<>
<Icons.ConsoleSqlOutlined /> SQL Lab
</>
),
children: 'SQL Lab content here.',
},
]}
/>
);
}
```
## Props
| Prop | Type | Default | Description |
| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ |
| `defaultActiveKey` | `string` | `"1"` | - |
| `type` | `string` | `"line"` | The style of tabs. Options: line, card, editable-card. |
| `tabPosition` | `string` | `"top"` | Position of tabs. Options: top, bottom, left, right. |
| `size` | `string` | `"middle"` | Size of the tabs. |
| `animated` | `boolean` | `true` | Whether to animate tab transitions. |
| `centered` | `boolean` | `false` | Whether to center the tabs. |
| `tabBarGutter` | `number` | `8` | The gap between tabs. |
| `items` | `any` | `[{"key":"1","label":"Tab 1","children":"Content of Tab Pane 1"},{"key":"2","label":"Tab 2","children":"Content of Tab Pane 2"},{"key":"3","label":"Tab 3","children":"Content of Tab Pane 3"}]` | - |
## Import
```tsx
import { Tabs } from '@superset-ui/core/components';
```
---
:::tip[Improve this page]
This documentation is auto-generated from the component's Storybook story.
Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Tabs/Tabs.stories.tsx).
:::
|