Demos
How to import
<script lang="ts">
import { Tabs } from '@fibrae/semi-ui-svelte';
</script>
Basic Usage
Tabs supports four types of styles: line, button, card, and slash. By default, the first enabled tab is selected.
Tabs supports two declare ways, and the rendering process of the two is different:
- Pass the array of objects through
tabList, when usingtabList, only render the currently passed node each time - Or use
<TabPane>to explicitly pass in item by item. When using<TabPane>, all panels will be rendered by default. You can setkeepDOMtofalseto only render the current panel, and there will be no animation effect at this time.
Svelte has no TabPane; tabs are passed through tabList only. The items of tabList hold data only (itemKey, tab, disabled, closable); for markup use the tab and icon snippets of Tabs, which receive { item, index }. Without a tab snippet the tab text of the item is shown. Write the content in the panel snippet, which receives { item, index, itemKey }: every tab is its own tabpanel, and keepDOM, lazyRender and motion apply to it. Without panel, the children of Tabs are the content of the active tab. Bind activeKey with bind:activeKey; there is no defaultActiveKey, so write the initial value as activeKey="1".
Code
<script lang="ts">
import { Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
const tabList: PlainTab[] = [
{ itemKey: '1', tab: '文档' },
{ itemKey: '2', tab: '快速起步' },
{ itemKey: '3', tab: '帮助' },
];
const paragraphStyle = 'line-height: 1.8';
const questionStyle = 'line-height: 1.8; color: var(--semi-color-text-0); font-weight: 600';
const answerStyle = 'line-height: 1.8; color: var(--semi-color-text-1)';
const codeStyle = 'margin: 24px 0; padding: 20px; border: none; white-space: normal; border-radius: var(--semi-border-radius-medium); color: var(--semi-color-text-1); background-color: var(--semi-color-fill-0)';
</script>
<div>
<Tabs {tabList} type="line">
{#snippet panel({ itemKey })}
{#if itemKey === '1'}
<h3>文档</h3>
<p style={paragraphStyle}>Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。</p>
<p style={paragraphStyle}>区别于其他的设计系统而言,Semi Design 以用户中心、内容优先、设计人性化为设计理念,具有以下优势:</p>
<ul>
<li>
<p>Semi Design 以内容优先进行设计。</p>
</li>
<li>
<p>更容易地自定义主题。</p>
</li>
<li>
<p>适用国际化场景。</p>
</li>
<li>
<p>效率场景加入人性化关怀。</p>
</li>
</ul>
{:else if itemKey === '2'}
<h3>快速起步</h3>
<pre style={codeStyle}><code>yarn add @fibrae/semi-ui-svelte</code></pre>
{:else}
<h3>帮助</h3>
<p style={questionStyle}>Q:有新组件需求、或者现有组件feature不能满足业务需求?</p>
<p style={answerStyle}>右上角问题反馈,提交issue,label选择Feature Request / New Component Request 我们会高优处理这些需求。</p>
<p style={questionStyle}>Q:对组件的使用有疑惑?</p>
<p style={answerStyle}>欢迎进我们的客服lark群进行咨询提问。</p>
{/if}
{/snippet}
</Tabs>
</div>Code
<script lang="ts">
import { Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
const tabList: PlainTab[] = [
{ itemKey: '1', tab: '文档' },
{ itemKey: '2', tab: '快速起步' },
{ itemKey: '3', tab: '帮助' },
];
</script>
<Tabs {tabList} type="button">
{#snippet panel({ item })}{item.tab}{/snippet}
</Tabs>Code
<script lang="ts">
import { Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
const contentList = ['文档', '快速起步', '帮助'];
const tabList: PlainTab[] = [
{ tab: '文档', itemKey: '1' },
{ tab: '快速起步', itemKey: '2' },
{ tab: '帮助', itemKey: '3' },
];
let key = $state<string | null | undefined>('1');
</script>
<Tabs bind:activeKey={key} {tabList} type="card">
<div>{contentList[Number(key) - 1]}</div>
</Tabs>Code
<script lang="ts">
import { Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
const contentList = ['文档', '快速起步', '帮助'];
const tabList: PlainTab[] = [
{ tab: '文档', itemKey: '1' },
{ tab: '快速起步', itemKey: '2' },
{ tab: '帮助', itemKey: '3' },
];
let key = $state<string | null | undefined>('1');
</script>
<Tabs bind:activeKey={key} {tabList} type="slash">
<div>{contentList[Number(key) - 1]}</div>
</Tabs>With Icon
Code
<script lang="ts">
import { IconFile, IconGlobe, IconHelpCircle } from '@fibrae/semi-icons-svelte';
import { Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
const tabList: PlainTab[] = [
{ itemKey: '1', tab: '文档' },
{ itemKey: '2', tab: '快速起步' },
{ itemKey: '3', tab: '帮助' },
];
const icons = { '1': IconFile, '2': IconGlobe, '3': IconHelpCircle } as const;
</script>
<Tabs {tabList}>
{#snippet tab({ item })}
{@const Icon = icons[item.itemKey as keyof typeof icons]}
<span><Icon />{item.tab}</span>
{/snippet}
{#snippet panel({ item })}{item.tab}{/snippet}
</Tabs>More with Dropdown
Supports merging redundant tabs into a more drop-down menu. Just pass in a number for more. The number represents the number of tabs included in the drop-down menu.
Code
<script lang="ts">
import { Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
const tabList: PlainTab[] = Array.from({ length: 10 }, (_, i) => ({ itemKey: `Tab-${i}`, tab: `Tab-${i}` }));
</script>
<Tabs more={4} style="width: 60%; margin: 20px" {tabList} type="card">
{#snippet panel({ index })}Content of card tab {index}{/snippet}
</Tabs>Advanced configuration is also supported, passing the object to more, and it can be passed in
count: Represents the number of Tabs in the income drop-down menudropdownProps: Dropdown props, passed through to the drop-down menu
Customize the "More" trigger with the moreTrigger snippet, and the content of the drop-down menu with the moreContent snippet, whose { items } are the tabs moved into the menu.
Code
<script lang="ts">
import { Button, Tabs, type PlainTab, type TabsMore } from '@fibrae/semi-ui-svelte';
const tabList: PlainTab[] = Array.from({ length: 10 }, (_, i) => ({ itemKey: `Tab-${i}`, tab: `Tab-${i}` }));
const more: TabsMore = { count: 4, dropdownProps: { trigger: 'click', position: 'bottomRight' } };
</script>
<Tabs {more} style="width: 60%; margin: 20px" {tabList} type="card">
{#snippet moreTrigger()}
<Button type="tertiary">Click to show More</Button>
{/snippet}
{#snippet panel({ index })}Content of card tab {index}{/snippet}
</Tabs>Vertical mode
When type is line, card, or button, horizontal and vertical modes are supported, tabPosition='left|top',default is top. When type is slash, only horizontal mode is supported.
Code
<script lang="ts">
import { IconFile, IconGlobe, IconHelpCircle } from '@fibrae/semi-icons-svelte';
import { Radio, RadioGroup, Tabs, type PlainTab, type RadioValue, type TabType } from '@fibrae/semi-ui-svelte';
let value = $state<RadioValue | undefined>('line');
const type = $derived(value as TabType);
const tabList: PlainTab[] = [
{ itemKey: '1', tab: '文档' },
{ itemKey: '2', tab: '快速起步' },
{ itemKey: '3', tab: '帮助' },
];
const icons = { '1': IconFile, '2': IconGlobe, '3': IconHelpCircle } as const;
const contentStyle = 'padding: 0 24px';
const paragraphStyle = 'line-height: 1.8';
const questionStyle = 'line-height: 1.8; color: var(--semi-color-text-0); font-weight: 600';
const answerStyle = 'line-height: 1.8; color: var(--semi-color-text-1)';
const codeStyle = 'margin: 24px 0; padding: 20px; border: none; white-space: normal; border-radius: 6px; color: var(--semi-color-text-1); background-color: var(--semi-color-fill-0)';
</script>
<RadioGroup bind:value style="display: flex; width: 200px; justify-content: center" type="button">
<Radio value="line">Line</Radio>
<Radio value="card">Card</Radio>
<Radio value="button">Button</Radio>
</RadioGroup>
<br />
<br />
<Tabs {tabList} tabPosition="left" {type}>
{#snippet tab({ item })}
{@const Icon = icons[item.itemKey as keyof typeof icons]}
<span><Icon />{item.tab}</span>
{/snippet}
{#snippet panel({ itemKey })}
<div style={contentStyle}>
{#if itemKey === '1'}
<h3>文档</h3>
<p style={paragraphStyle}>Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。</p>
<p style={paragraphStyle}>区别于其他的设计系统而言,Semi Design 以用户中心、内容优先、设计人性化为设计理念,具有以下优势:</p>
{:else if itemKey === '2'}
<h3>快速起步</h3>
<pre style={codeStyle}><code>yarn add @fibrae/semi-ui-svelte</code></pre>
{:else}
<h3>帮助</h3>
<p style={questionStyle}>Q:有新组件需求、或者现有组件feature不能满足业务需求?</p>
<p style={answerStyle}>右上角问题反馈,提交issue,label选择Feature Request / New Component Request 我们会高优处理这些需求。</p>
<p style={questionStyle}>Q:对组件的使用有疑惑?</p>
<p style={answerStyle}>欢迎进我们的客服lark群进行咨询提问。</p>
{/if}
</div>
{/snippet}
</Tabs>Scrollable Tabs
You could use collapsible for a scrollable tabs with dropdown menu. Horizontal mode only.
Code
<script lang="ts">
import { Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
const tabList: PlainTab[] = Array.from({ length: 10 }, (_, i) => ({ itemKey: `Tab-${i}`, tab: `Tab-${i}` }));
</script>
<Tabs collapsible style="width: 60%; margin: 20px" {tabList} type="card">
{#snippet panel({ index })}Content of card tab {index}{/snippet}
</Tabs>Modify the scrolling rendering Arrow
The arrow snippet modifies the arrows in collapsible mode. It receives { items, position, onClick, defaultNode }: the overflowed tabs, the position, the click function and the default arrow defaultNode (render it with {@render defaultNode()}).
Code
<script lang="ts">
import { Dropdown, DropdownItem, DropdownMenu, Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
let activeKey = $state<string | null | undefined>('Tab-0');
const tabList: PlainTab[] = Array.from({ length: 10 }, (_, i) => ({ itemKey: `Tab-${i}`, tab: `Tab-${i}` }));
const arrowStyle = 'width: 32px; height: 32px; margin: 0 12px; display: flex; justify-content: center; align-items: center; padding: 0; border: none; border-radius: 100%; background: var(--semi-grey-1); color: var(--semi-color-text); font-family: inherit; font-size: inherit; cursor: pointer';
</script>
<Tabs bind:activeKey collapsible style="width: 50%; margin: 20px" {tabList} type="card">
{#snippet arrow({ items, position, onClick })}
<Dropdown>
{#snippet child({ props })}
<button {...props} style={arrowStyle} type="button" onclick={onClick}>
{position === 'start' ? '←' : '→'}
</button>
{/snippet}
{#snippet content()}
<DropdownMenu>
{#each items as item (item.itemKey)}
<DropdownItem onclick={() => (activeKey = item.itemKey)}>{item.itemKey}</DropdownItem>
{/each}
</DropdownMenu>
{/snippet}
</Dropdown>
{/snippet}
{#snippet panel({ index })}Content of card tab {index}{/snippet}
</Tabs>Modify Arrow rendering position
Use arrowPosition to modify the overflow indicator position, optional start both end
Code
<script lang="ts">
import { Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
const positions = ['start', 'both', 'end'] as const;
const tabList: PlainTab[] = Array.from({ length: 10 }, (_, i) => ({ itemKey: `Tab-${i}`, tab: `Tab-${i}` }));
</script>
{#each positions as position (position)}
<Tabs arrowPosition={position} collapsible style="width: 60%; margin: 20px" {tabList} type="card">
{#snippet panel({ index })}Content of card tab {index}{/snippet}
</Tabs>
{/each}Auto Overflow Detection
Set collapsible="auto" to enable automatic overflow detection. The component will automatically detect whether tabs overflow the container:
- When tabs exceed the container width or wrap to multiple lines, it automatically enables collapse mode (shows left/right arrows)
- When the container width increases or tab count decreases and all tabs can be fully displayed, it automatically exits collapse mode
This feature eliminates the need for developers to manually determine whether folding is needed, making it especially suitable for responsive layouts.
collapsible="auto" - 自动检测溢出
固定宽度 400px,测试较窄容器
Code
<script lang="ts">
import { Button, Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
let count = $state(8);
const tabList = $derived<PlainTab[]>(Array.from({ length: count }, (_, i) => ({ itemKey: `${i}`, tab: `Tab-${i + 1}` })));
const boxStyle = 'border: 1px solid var(--semi-color-border); padding: 12px';
const noteStyle = 'margin-bottom: 8px; color: var(--semi-color-text-2); font-size: 12px';
</script>
{#snippet panel({ index }: { index: number })}Content of Tab {index + 1}{/snippet}
<div>
<div style="margin-bottom: 12px">
<Button style="margin-right: 8px" onclick={() => (count = Math.max(3, count - 2))}>减少 Tab</Button>
<Button onclick={() => (count = Math.min(15, count + 2))}>增加 Tab</Button>
<span style="margin-left: 12px">当前 Tab 数量: {count}</span>
</div>
<div style={`${boxStyle}; margin-bottom: 16px`}>
<p style={noteStyle}>collapsible="auto" - 自动检测溢出</p>
<Tabs collapsible="auto" {panel} {tabList} type="card" />
</div>
<div style={`${boxStyle}; max-width: 400px`}>
<p style={noteStyle}>固定宽度 400px,测试较窄容器</p>
<Tabs collapsible="auto" {panel} {tabList} type="card" />
</div>
</div>Disable
Disable one tab.
Code
<script lang="ts">
import { Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
const tabList: PlainTab[] = [
{ itemKey: '1', tab: '文档' },
{ itemKey: '2', tab: '快速起步', disabled: true },
{ itemKey: '3', tab: '帮助' },
];
</script>
<Tabs activeKey="1" {tabList}>
{#snippet panel({ item })}{item.tab}{/snippet}
</Tabs>Extra Content
Use the tabBarExtraContent snippet to add extra content on the right side of tabBar.
Code
<script lang="ts">
import { Button, Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
const tabList: PlainTab[] = [
{ itemKey: '1', tab: '文档' },
{ itemKey: '2', tab: '快速起步' },
{ itemKey: '3', tab: '帮助' },
];
const onExtraClick = () => {
alert('you have clicked me!');
};
</script>
<Tabs activeKey="1" {tabList}>
{#snippet tabBarExtraContent()}
<Button onclick={onExtraClick}>Extra Action</Button>
{/snippet}
{#snippet panel({ item })}{item.tab}{/snippet}
</Tabs>Custom Render
Use the tabBar snippet, which receives { tabBarProps, tabBar }, to customize the tab bar. tabBarProps holds data only (see TabBarProps below) and tabBar is the default tab bar, rendered with {@render tabBar()}.
When tabBar replaces the bar entirely, the aria-label and aria-labelledby of Tabs do not reach your own element: put the accessible name on your own role="tablist" element.
Code
<script lang="ts">
import { Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
const tabList: PlainTab[] = [
{ itemKey: '1', tab: '文档' },
{ itemKey: '2', tab: '快速起步' },
{ itemKey: '3', tab: '帮助' },
];
</script>
<Tabs activeKey="1" {tabList}>
{#snippet tabBar({ tabBarProps, tabBar })}
<div class="tab-bar-box">
这是二次封装的Tab Bar,当前ActiveKey:{tabBarProps.activeKey}
{@render tabBar()}
</div>
{/snippet}
{#snippet panel({ item })}{item.tab}{/snippet}
</Tabs>Drag and Drop Reordering
Through the tabBar snippet, render the tabs with TabItem inside your own role="tablist" element and combine them with dragging to reorder the tab bar. Inside a Tabs a TabItem selects its tab on click by itself, and native attributes and listeners such as draggable and the drag events land on its root element. The demo uses native browser drag and drop, which supports pointer input only; when you need keyboard sorting, use a drag library with keyboard support instead.
<script lang="ts">
import { TabItem } from '@fibrae/semi-ui-svelte';
</script>
Code
<script lang="ts">
import { TabItem, Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
let activeKey = $state<string | null | undefined>('1');
let tabList = $state<PlainTab[]>([
{ itemKey: '1', tab: '文档' },
{ itemKey: '2', tab: '表格' },
{ itemKey: '3', tab: '幻灯片' },
{ itemKey: '4', tab: '表单' },
]);
const contents: Record<string, string> = { '1': '文档内容', '2': '表格内容', '3': '幻灯片内容', '4': '表单内容' };
// HTML5 drag and drop on the TabItems: the website has no sortable library for Svelte, and a sortable list would wrap
// each tab in a button-role element that nests focusable tabs. Known limit: pointer only; use a sortable library for keyboard sorting.
let draggingKey = $state<string | null>(null);
const moveTo = (targetKey: string) => {
const from = tabList.findIndex((item) => item.itemKey === draggingKey);
const to = tabList.findIndex((item) => item.itemKey === targetKey);
if (from < 0 || to < 0 || from === to) return;
const next = [...tabList];
const [moved] = next.splice(from, 1);
next.splice(to, 0, moved);
tabList = next;
};
</script>
<Tabs bind:activeKey {tabList} type="line">
<!-- the bar keeps Semi's own .semi-tabs-bar shell; the TabItems inside select their Tabs by themselves -->
{#snippet tabBar()}
<div aria-orientation="horizontal" class="semi-tabs-bar semi-tabs-bar-line semi-tabs-bar-top" role="tablist">
{#each tabList as item (item.itemKey)}
<TabItem
draggable="true"
itemKey={item.itemKey}
selected={activeKey === item.itemKey}
style={`cursor: grab; opacity: ${draggingKey === item.itemKey ? 0.5 : 1}; display: inline-flex`}
ondragend={() => (draggingKey = null)}
ondragenter={(event) => {
event.preventDefault();
moveTo(item.itemKey);
}}
ondragover={(event) => event.preventDefault()}
ondragstart={() => (draggingKey = item.itemKey)}
>
{#snippet tab()}{item.tab}{/snippet}
</TabItem>
{/each}
</div>
{/snippet}
{#snippet panel({ itemKey })}
<div style="padding: 20px">{contents[itemKey]}</div>
{/snippet}
</Tabs>Dynamic Update
You can add events to update tabBar dynamically.
Code
<script lang="ts">
import { Button, ButtonGroup, Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
let newTabIndex = 0;
let tabList = $state<PlainTab[]>([
{ tab: 'Tab 1', itemKey: '1' },
{ tab: 'Tab 2', itemKey: '2' },
]);
const contents: Record<string, string> = { '1': 'Content of Tab Pane 1', '2': 'Content of Tab Pane 2' };
let activeKey = $state<string | null | undefined>('1');
const add = () => {
const index = newTabIndex++;
tabList = [...tabList, { tab: `New Tab ${index}`, itemKey: `newTab${index}` }];
activeKey = `newTab${index}`;
};
const remove = () => {
if (tabList.length > 1) {
tabList = tabList.slice(0, -1);
activeKey = tabList[tabList.length - 1].itemKey;
}
};
</script>
<Tabs bind:activeKey {tabList}>
{#snippet tabBarExtraContent()}
<ButtonGroup>
<Button onclick={add}>新增</Button>
<Button onclick={remove}>删除</Button>
</ButtonGroup>
{/snippet}
{#snippet panel({ itemKey })}{contents[itemKey] ?? 'New Tab Pane'}{/snippet}
</Tabs>Closeable
Close a tab in the tab bar. All four tab styles support the close option; set closable on the tab to turn it on. A disabled tab cannot be closed. The caller removes the tab in the close callback.
Code
<script lang="ts">
import { Tabs, type PlainTab } from '@fibrae/semi-ui-svelte';
let tabList = $state<PlainTab[]>([
{ tab: '文档', itemKey: '1', closable: true },
{ tab: '快速起步', itemKey: '2', closable: true },
{ tab: '帮助', itemKey: '3', closable: false },
]);
const close = (key: string) => {
tabList = tabList.filter((t) => t.itemKey !== key);
};
</script>
<Tabs onTabClose={close} {tabList} type="card">
{#snippet panel({ item })}{item.tab}{/snippet}
</Tabs>API Reference
Tab
Props
| Property | Description | Type | Default |
|---|---|---|---|
| activeKey | The itemKey of the active tab, bound with bind:activeKey. null activates no tab and is still controlled; omitted or undefined means uncontrolled, with the first enabled tab selected. | string | null | - |
| arrow | Snippet that replaces each scroll arrow in collapsible mode, with { items, position, onClick, defaultNode }: the scrolled-out tabs, the position, the click handler and the default arrow (render it with {@render defaultNode()}). | TypeSnippet<[TabsArrowSnippetProps]> | - |
| arrowPosition | Position of the scroll arrows in collapsible mode. | 'both' | 'start' | 'end' | "both" |
| children | The content area when there is no panel: the content of the active tab, one tabpanel labelled by the selected tab. | Snippet | - |
| collapsible | Whether to collapse overflowing tabs into a scrollable bar (horizontal mode only). 'auto' collapses when the tabs overflow or wrap and leaves the collapse once they fit. | boolean | 'auto' | false |
| contentStyle | Style string of the outer content area. | string | - |
| dropdownProps | In collapsible mode, the Dropdown props passed to the start-side and end-side arrow menus. | TabsDropdownProps | - |
| icon | Snippet for the icon of each tabList entry, with { item, index }; the icon container renders even when the snippet outputs nothing. | TypeSnippet<[TabsTabSnippetProps]> | - |
| keepDOM | With panel, whether to render the DOM of inactive panels. When false only the active panel is rendered, without motion. | boolean | true |
| lazyRender | Lazy rendering: a panel is rendered into the DOM only after it has been active. | boolean | false |
| more | Moves the last tabs into a More dropdown. A number is the count of tabs moved; in an object, count is that number and dropdownProps is passed to the dropdown. The trigger and the menu content are customized with the moreTrigger and moreContent snippets. | number | TabsMore | - |
| moreContent | Snippet that replaces the content of the More menu, with the tabs moved into it as { items }. | TypeSnippet<[TabsMoreContentSnippetProps]> | - |
| moreTrigger | Snippet that replaces the trigger of the More menu. | Snippet | - |
| onChange | Called when the tab changes, with the itemKey of the new active tab. | Type(activeKey: string) => void | - |
| onTabClick | Called when a tab is clicked or activated with Enter or Space; the event is a KeyboardEvent for keyboard activation. | Type(activeKey: string, event: MouseEvent | KeyboardEvent) => void | - |
| onTabClose | Called when a tab is closed, with the itemKey of the closed tab. The caller removes the tab. | Type(tabKey: string) => void | - |
| onVisibleTabsChange | In collapsible mode, called when the visibility of the tabs changes, with a Map from itemKey to whether it is visible. | Type(visibleState: Map<string, boolean>) => void | - |
| panel | Snippet for the content of each tabList entry, with { item, index, itemKey }; it makes every entry its own tabpanel, and keepDOM, lazyRender and motion apply. | TypeSnippet<[TabsPanelSnippetProps]> | - |
| preventScroll | Whether focus calls inside the component stop the browser from scrolling the document to the newly focused element. | boolean | - |
| showRestInDropdown | In collapsible mode, whether the collapsed tabs are listed in a dropdown menu. | boolean | true |
| size | Size of the tab bar; currently only the line type supports it. | TabSize | "large" |
| tab | Snippet for the tab of each tabList entry, with { item, index }; without it the entry's tab text shows. | TypeSnippet<[TabsTabSnippetProps]> | - |
| tabBar | Snippet that replaces the whole tab bar, with { tabBarProps, tabBar }: tabBarProps holds data only and tabBar is the default tab bar, rendered with {@render tabBar()}; a TabItem inside the custom bar controls its Tabs on its own. | TypeSnippet<[TabsTabBarSnippetProps]> | - |
| tabBarClassName | Class name of the tab bar. | string | - |
| tabBarExtraContent | Snippet for the extra content of the tab bar, placed outside the tablist. | Snippet | - |
| tabBarStyle | Style string of the tab bar. | string | - |
| tabList | An array of tab data, each with itemKey, tab, disabled and closable, data only. Tab markup goes in the tab and icon snippets, and the content in the panel snippet or children. | PlainTab[] | [] |
| tabPaneMotion | Whether switching panels is animated. | boolean | true |
| tabPosition | Position of the tab bar: top is horizontal, left is vertical. | TabPosition | "top" |
| type | Style of the tab bar: line, card, button or slash. slash supports horizontal mode only. | TabType | "line" |
| visibleTabsStyle | In collapsible mode, the style string of the whole scrolling area. | string | - |
activeKey is used with bind:activeKey. aria-label and aria-labelledby land on the role="tablist" element; class, style and other native attributes land on the root element.
PlainTab
The data item of tabList; it holds data only.
| Property | Description | Type | Default Value |
|---|---|---|---|
| itemKey | Unique key of the tab, matched against activeKey | string | None |
| tab | Tab text; the tab snippet takes precedence | string | number | None |
| disabled | Whether the tab is disabled | boolean | None |
| closable | Whether the tab can be closed | boolean | None |
TabsMore
The shape of more when it is an object.
| Property | Description | Type | Default Value |
|---|---|---|---|
| count | Number of Tabs moved into the drop-down menu | number | None |
| dropdownProps | Dropdown props passed through to the menu | TabsDropdownItemProps | None |
TabsDropdownItemProps is the props of Dropdown plus class, style and onVisibleChange. The start and end of dropdownProps use the same type.
TabBarProps
The tabBarProps of the tabBar snippet, the data of the default tab bar.
| Property | Description | Type |
|---|---|---|
| activeKey | The active itemKey; null for a controlled empty value | string | null |
| list | Tab data | PlainTab[] |
| type | Style of the tab bar | 'line' | 'card' | 'button' | 'slash' |
| size | Size | 'small' | 'medium' | 'large' |
| tabPosition | Position | 'top' | 'left' |
| collapsible | Whether collapsible | boolean | 'auto' |
| showRestInDropdown | In collapsible mode, whether collapsed tabs are listed in a dropdown | boolean |
| more | Configuration of the More menu | number | TabsMore |
| arrowPosition | Position of the arrows in collapsible mode | 'both' | 'start' | 'end' |
| visibleTabsStyle | Style of the whole scrolling area in collapsible mode | string |
| dropdownProps | Dropdown props of the arrow menus in collapsible mode | TabsDropdownProps |
| class | tabBarClassName | string |
| style | tabBarStyle | string |
TabPane
Svelte has no TabPane; provide the content of a tab with the panel snippet of Tabs.
TabItem
A single tab inside a custom tab bar (the tabBar snippet). Inside a Tabs, clicking it selects its tab by itself and triggers the onChange and onTabClick callbacks of the Tabs.
Props
| Property | Description | Type | Default |
|---|---|---|---|
| closable | Whether to show the close button. | boolean | false |
| disabled | Whether the tab is disabled; clicks, the close button and the Enter, Space, Delete and Backspace keys have no effect, while the close button still shows. | boolean | false |
| icon | Snippet for the tab icon; the icon container renders even when the snippet outputs nothing. | Snippet | - |
| itemKey | Unique key of the tab. | string | "" |
| onClick | Called when the tab is clicked, with the itemKey and the event; not called while disabled. Inside a Tabs the click already selects the tab. | Type(itemKey: string, event: MouseEvent) => void | - |
| selected | Whether the tab is selected. | boolean | false |
| size | Size; defaults to the size of the enclosing Tabs. | TabSize | - |
| tab | Snippet for the tab content. | Snippet | - |
| tabPosition | Position; defaults to the tabPosition of the enclosing Tabs, else top. | TabPosition | - |
| type | Style; defaults to the type of the enclosing Tabs, else line. | TabType | - |
class, style and native attributes and events land on the root element; role, id, aria-selected, aria-disabled, aria-controls and tabindex are managed by the component and are not overridden.
Accessibility
ARIA
- About role
- The element in TabBar that holds only the Tabs has a role of
tablist; the scroll arrows, the "more" trigger andtabBarExtraContentsit outside it - Tab in TabBar has a role of
tab - TabPane has a role of
tabpanel
- The element in TabBar that holds only the Tabs has a role of
- aria-label, aria-labelledby: When passed to Tabs they land on the
role="tablist"element and name the tab bar - aria-orientation: Indicates TabBar's orientation, can be
verticalorhorizontal. When tabPosition isleft,aria-orientation will bevertical, when tabPosition istop, aria-orientation will behorizontal. - aria-disabled: When TabPane is disabled, the related Tab's aria-disabled will be set to true.
- aria-selected: Indicates whether the Tab is selected.
- aria-controls: Indicates the TabPane controlled by the Tab; when only the active tab's panel is in the document (with
tabList, or withkeepDOMset to false), only the selected Tab carries it - aria-labelledby: Indicates the element labels the TabPane
Keyboard and Focus
WAI-ARIA: https://www.w3.org/WAI/ARIA/apg/patterns/tabpanel/
- Tabs can be given focus, except for disabled tabs
- Keyboard users can use the
Tabkey to move the focus to the tab panel of the selected tab element - Use
left and right arrowsto toggle options when focus is on a tab element in a horizontal tab list (the two arrows swap in an RTL page) - Use
up and down arrowsto toggle options when focus is on a tab element in a vertical tab list - When the focus is on an inactive tab element in the tab list, the
SpaceorEnterkeys can be used to activate the tab - When keyboard users want to focus directly on the last tab element in the tab list:
- Mac users:
fn+right arrow - Windows users:
End
- Mac users:
- When keyboard users want to focus directly on the first tab element in the tab list:
- Mac users:
fn+left arrow - Windows users:
Home
- Mac users:
- With
more, the default "More" trigger is a nativebutton: focus it withTab, open the dropdown withEnterorSpace; it carriesaria-haspopup="menu"andaria-expanded - When a tab is allowed to be deleted:
- Users can use the
DeleteorBackspacekey to delete a tab, except a disabled one - After deletion, the focus is transferred to the next element of the deleted tab element; if the deleted element has no subsequent element, it is transferred to the previous element
- Users can use the
Design Token
| Sass variable | Value | Usage |
|---|---|---|
| $transition_duration-tabs_tab_line-border | var(--semi-transition_duration-none) | 线条式标签页标示线-边框-动画持续时间 |
| $transition_function-tabs_tab_line-border | var(--semi-transition_function-easeIn) | 线条式标签页标示线-边框-过渡曲线 |
| $transition_delay-tabs_tab_line-border | var(--semi-transition_delay-none) | 线条式标签页标示线-边框-延迟时间 |
| $transition_duration-tabs_tab_line-text | var(--semi-transition_duration-none) | 线条式标签页-文字-动画持续时间 |
| $transition_function-tabs_tab_line-text | var(--semi-transition_function-easeIn) | 线条式标签页-文字-过渡曲线 |
| $transition_delay-tabs_tab_line-text | var(--semi-transition_delay-none) | 线条式标签页-文字-延迟时间 |
| $transition_duration-tabs_tab_button-bg | var(--semi-transition_duration-none) | 按钮式标签页-背景色-动画持续时间 |
| $transition_function-tabs_tab_button-bg | var(--semi-transition_function-easeIn) | 按钮式标签页-背景色-过渡曲线 |
| $transition_delay-tabs_tab_button-bg | var(--semi-transition_delay-none) | 按钮式标签页-背景色-延迟时间 |
| $transition_duration-tabs_tab_card-bg | var(--semi-transition_duration-none) | 卡片式标签页文字-背景色-动画持续时间 |
| $transition_function-tabs_tab_card-bg | var(--semi-transition_function-easeIn) | 卡片式标签页文字-背景色-过渡曲线 |
| $transition_delay-tabs_tab_card-bg | var(--semi-transition_delay-none) | 卡片式标签页文字-背景色-延迟时间 |
| $transform_scale-tabs_tab_line-item | var(--semi-transform_scale-none) | 线条式标签页item 放大 |
| $transform_scale-tabs_tab_button-item | var(--semi-transform_scale-none) | 按钮式标签页item 放大 |
| $transform_scale-tabs_tab_card-item | var(--semi-transform_scale-none) | 线条式标签页item 放大 |
| $animation_transform_translateX-tabs_tabPanel-leftShow | 60px | 左侧展示时,tabPanel的水平偏移值 |
| $animation_transform_translateX-tabs_tabPanel-rightShow | -60px | 右侧展示时,tabPanel的水平偏移值 |
| $animation_opacity-tabs_tabPanel_show | 0 | tabPanel的动画开始时透明度 |
| $animation_duration-tabs_tabPanel-show | 200ms | tabPanel的展示动画持续时间 |
| $animation_function-tabs_tabPanel-show | ease-in-out | tabPanel的展示动画曲线 |
| $animation_delay-tabs_tabPanel-show | 0s | tabPanel的展示动画延迟时间 |
| $color-tabs_tab_line_default-border-default | var(--semi-color-border) | 线条式页签轨道颜色 - 默认 |
| $color-tabs_tab_line_default-text-default | var(--semi-color-text-2) | 线条式页签文本颜色 - 默认 |
| $color-tabs_tab_line_default-text-hover | var(--semi-color-text-0) | 线条式页签文本颜色 - 悬浮 |
| $color-tabs_tab_line_default-border-hover | var(--semi-color-fill-0) | 线条式页签标示线颜色 - 悬浮 |
| $color-tabs_tab_line_default-text-active | var(--semi-color-text-0) | 线条式页签文本颜色 - 按下 |
| $color-tabs_tab_line_default-border-active | var(--semi-color-fill-1) | 线条式页签标示线颜色 - 按下 |
| $color-tabs_tab_line_selected-text-default | var(--semi-color-text-0) | 线条式页签文本颜色 - 选中 |
| $color-tabs_tab_line_indicator_selected-icon-default | var(--semi-color-primary) | 线条式页签标示线颜色 - 选中 |
| $color-tabs_tab_line_vertical_selected-bg-default | var(--semi-color-primary-light-default) | 垂直线条式页签背景颜色 - 选中 |
| $color-tabs_tab_line_vertical-bg-hover | var(--semi-color-fill-0) | 垂直线条式页签背景颜色 - 悬浮 |
| $color-tabs_tab_line_vertical-bg-active | var(--semi-color-fill-1) | 垂直线条式页签背景颜色 - 按下 |
| $color-tabs_tab_line_disabled-text-default | var(--semi-color-disabled-text) | 禁用线条式页签文本颜色 - 默认 |
| $color-tabs_tab_line_disabled-text-hover | var(--semi-color-disabled-text) | 禁用线条式页签文本颜色 - 悬浮 |
| $color-tabs_tab_card_default-border-default | var(--semi-color-border) | 卡片式页签容器底部长线颜色 - 默认 |
| $color-tabs_tab_button_selected-bg-default | var(--semi-color-primary-light-default) | 按钮式页签背景颜色 - 选中 |
| $color-tabs_tab_button_selected-text-default | var(--semi-color-primary) | 按钮式页签文本颜色 - 选中 |
| $color-tabs_tab_button-text-default | var(--semi-color-text-2) | 按钮式页签文本颜色 - 默认 |
| $color-tabs_tab_button-bg-hover | var(--semi-color-fill-0) | 按钮式页签背景颜色 - 悬浮 |
| $color-tabs_tab_button-bg-active | var(--semi-color-fill-1) | 按钮式页签背景颜色 - 按下 |
| $color-tabs_tab_card_indicator_selected-icon-default | var(--semi-color-border) | 卡片式页签选中页签描边 |
| $color-tabs_tab_card-bg-hover | var(--semi-color-fill-0) | 卡片式页签背景颜色 - 悬浮 |
| $color-tabs_tab_card_selected-bg-default | var(--semi-color-bg-1) | 卡片式页签背景颜色 - 选中 |
| $color-tabs_tab_card-bg-active | var(--semi-color-fill-1) | 卡片式页签背景颜色 -按下 |
| $color-tabs_tab-icon-default | var(--semi-color-text-2) | 页签图标颜色 - 默认 |
| $color-tabs_tab-icon-hover | var(--semi-color-text-0) | 页签图标颜色 - 悬浮 |
| $color-tabs_tab-icon-active | var(--semi-color-text-0) | 页签图标颜色 - 按下 |
| $color-tabs_tab_selected-icon-default | var(--semi-color-primary) | 页签图标颜色 - 选中 |
| $color-tabs_tab-outline-focus | $color-focus-ring | 页签轮廓 - 聚焦 |
| $color-tabs_tab-pane-text-default | var(--semi-color-text-0) | 标签页内容文本颜色 - 默认 |
| $color-tabs_tab-pane_arrow-text-default | var(--semi-color-primary) | 滚动折叠箭头颜色 - 默认 |
| $color-tabs_tab-pane_arrow-border-default | transparent | 滚动折叠箭头边框颜色 - 默认 |
| $color-tabs_tab-pane_arrow-bg-default | transparent | 滚动折叠箭头背景色 - 默认 |
| $color-tabs_tab-pane_arrow-text-hover | var(--semi-color-primary) | 滚动折叠箭头颜色 - 悬浮 |
| $color-tabs_tab-pane_arrow-border-hover | transparent | 滚动折叠箭头边框颜色 - 悬浮 |
| $color-tabs_tab-pane_arrow-text-active | var(--semi-color-primary) | 滚动折叠箭头颜色 - 按下 |
| $color-tabs_tab-pane_arrow-border-active | transparent | 滚动折叠箭头边框颜色 - 按下 |
| $color-tabs_tab-pane_arrow_disabled-bg-default | transparent | |
| $color-tabs_tab-pane_arrow_disabled-bg-hover | transparent | |
| $color-tabs_tab-pane_arrow_disabled-text-default | var(--semi-color-disabled-text) | |
| $color-tabs_tab-pane_arrow_disabled-text-hover | var(--semi-color-disabled-text) | |
| $color-tabs_tab_slash_line | var(--semi-color-text-2) | 斜线式页签分割线颜色 |
| $font-tabs_tab-fontWeight | $font-weight-regular | 页签文本字重 - 默认 |
| $font-tabs_tab_active-fontWeight | $font-weight-bold | 页签文本字重 - 选中 |
| $height-tabs_overflow_list | 300px | 页签折叠收起菜单高度 |
| $width-tabs_bar_line-border | $border-thickness-control | 线条式页签底部分割线宽度 |
| $width-tabs_bar_line_tab-border | 2px | 页签标示线宽度 |
| $width-tabs_bar_card-border | $border-thickness-control | 卡片式页签容器底部长线宽度 |
| $width-tabs-outline | $width-focus-ring | 聚焦轮廓宽度 |
| $width-tabs-outline-offset | -2px | 聚焦轮廓偏移宽度 |
| $width-tabs_bar_line-outline-offset | -1px | 线条式页签聚焦轮廓偏移宽度 |
| $width-tabs_tab-pane_arrow-border | 0px | 滚动折叠箭头边框宽度 |
| $width-tabs_tab_slash_line | 8px | 斜线式页签分割线宽度 |
| $height-tabs_tab_slash_line | 14px | 斜线式页签分割线高度 |
| $height-tabs_bar_extra_large | 50px | 大尺寸页签高度 |
| $font-tabs_bar_extra_large-lineHeight | $height-tabs_bar_extra_large | 大尺寸页签文字行高 |
| $height-tabs_bar_extra_small | 36px | 小尺寸页签高度 |
| $font-tabs_bar_extra_small-lineHeight | $height-tabs_bar_extra_small | 小尺寸页签文字行高 |
| $spacing-tabs_tab-more_trigger_icon-marginLeft | 8px | |
| $spacing-tabs_tab-more_trigger_icon-marginRight | 8px | |
| $spacing-tabs_tab-more_trigger_icon-marginTop | 0px | |
| $spacing-tabs_tab-more_trigger_icon-marginBottom | 0px | |
| $spacing-tabs_tab-pane_arrow | 8px | 滚动折叠箭头内边距 |
| $spacing-tabs_bar_extra-paddingY | 0px | 附加操作垂直内边距 |
| $spacing-tabs_bar_extra-paddingX | 5px | 附加操作水平内边距 |
| $spacing-tabs_tab_icon-marginRight | $spacing-tight | 附加操作垂直内边距 |
| $spacing-tabs_tab_icon-top | 3px | 页签图标顶部位置 |
| $spacing-tabs_overflow_icon-marginRight | 4px | 页签折叠切换按钮右侧外边距 |
| $spacing-tabs_overflow_icon-marginLeft | 4px | 页签折叠切换按钮左侧外边距 |
| $spacing-tabs_bar_line_tab-paddingTop | $spacing-base | 线条式页签 |
| $spacing-tabs_bar_line_tab-paddingRight | $spacing-extra-tight | 线条式页签右侧内边距 |
| $spacing-tabs_bar_line_tab-paddingBottom | $spacing-base - $width-tabs_bar_line_tab-border | 线条式页签底部内边距 |
| $spacing-tabs_bar_line_tab-paddingLeft | $spacing-extra-tight | 线条式页签左侧内边距 |
| $spacing-tabs_bar_line_tab-marginRight | $spacing-loose | 线条式页签右侧外边距 |
| $spacing-tabs_bar_line_tab_small-paddingTop | $spacing-tight | 小尺寸线条式页签顶部内边距 |
| $spacing-tabs_bar_line_tab_small-paddingRight | $spacing-extra-tight | 小尺寸线条式页签右侧内边距 |
| $spacing-tabs_bar_line_tab_small-paddingBottom | $spacing-tight - $width-tabs_bar_line_tab-border | 小尺寸线条式页签底部内边距 |
| $spacing-tabs_bar_line_tab_small-paddingLeft | $spacing-extra-tight | 小尺寸线条式页签左侧内边距 |
| $spacing-tabs_bar_line_tab_medium-paddingTop | $spacing-base-tight | 中等尺寸线条式页签顶部内边距 |
| $spacing-tabs_bar_line_tab_medium-paddingRight | $spacing-extra-tight | 中等尺寸线条式页签右侧内边距 |
| $spacing-tabs_bar_line_tab_medium-paddingBottom | $spacing-base-tight - $width-tabs_bar_line_tab-border | 中等尺寸线条式页签底部内边距 |
| $spacing-tabs_bar_line_tab_medium-paddingLeft | $spacing-extra-tight | 中等尺寸线条式页签左侧内边距 |
| $spacing-tabs_bar_line_tab_left-padding | 12px | 垂直线条式页签左侧内边距 |
| $spacing-tabs_bar_line_tab_left_small-padding | $spacing-tight - 2px | 小尺寸垂直线条式页签左侧内边距 |
| $spacing-tabs_bar_line_tab_left_medium-padding | $spacing-base-tight - 2px | 中等尺寸垂直线条式页签左侧内边距 |
| $spacing-tabs_bar_slash_tab-paddingY | 12px | 斜线式页签上下内边距 |
| $spacing-tabs_bar_slash_tab-paddingX | 0px | 斜线式页签水平内边距 |
| $spacing-tabs_bar_slash-marginRight | 16px | 斜线式页签右侧外边距 |
| $spacing-tabs_bar_slash_line_marginLeft | 16px | 斜线式页签斜线左侧外边距 |
| $spacing-tabs_bar_slash_line_marginTop | 3px | 斜线式页签斜线顶部外边距 |
| $spacing-tabs_bar_slash_line_marginBottom | 3px | 斜线式页签斜线底部外边距 |
| $spacing-tabs_content-paddingY | 5px | 页签内容区垂直方向内边距 |
| $spacing-tabs_content-paddingX | 0 | 页签内容区水平方向内边距 |
| $spacing-tabs_content_left-paddingX | 5px | 垂直页签内容区垂直方向内边距 |
| $spacing-tabs_content_left-paddingY | 0 | 垂直页签内容区水平方向内边距 |
| $spacing-tabs_bar_card_tab-marginRight | $spacing-tight | 卡片式页签右侧外边距 |
| $spacing-tabs_bar_card_tab_active-paddingTop | $spacing-tight | 卡片式选中页签顶部内边距 |
| $spacing-tabs_bar_card_tab_active-paddingBottom | $spacing-tight - 1px | 卡片式选中页签底部内边距 |
| $spacing-tabs_bar_card_tab_active-paddingLeft | $spacing-base-tight | 卡片式选中页签左侧内边距 |
| $spacing-tabs_bar_card_tab_active-paddingRight | $spacing-base-tight | 卡片式选中页签右侧内边距 |
| $spacing-tabs_bar_card_tab_left-marginBottom | $spacing-tight | 垂直卡片式页签底部外边距 |
| $spacing-tabs_bar_card_tab_left_active-paddingY | $spacing-tight | 垂直卡片式选中页签垂直内边距 |
| $spacing-tabs_bar_card_tab_left_active-paddingX | $spacing-base-tight | 垂直卡片式选中页签水平内边距 |
| $spacing-tabs_bar_card_tab-paddingY | $spacing-tight | 卡片式选中页签垂直内边距 |
| $spacing-tabs_bar_card_tab-paddingX | $spacing-base-tight | 卡片式选中页签水平内边距 |
| $spacing-tabs_bar_button_tab_left-marginBottom | $spacing-tight | 垂直按钮式页签底部外边距 |
| $spacing-tabs_bar_button_tab-marginRight | $spacing-tight | 按钮式页签右侧外边距 |
| $spacing-tabs_bar_button_tab-paddingY | $spacing-tight | 按钮式页签垂直内边距 |
| $spacing-tabs_bar_button_tab-paddingX | $spacing-base-tight | 按钮式页签水平内边距 |
| $radius-tabs_tab_card | var(--semi-border-radius-small) var(--semi-border-radius-small) 0 0 | 卡片式页签四向圆角 |
| $radius-tabs_tab_card_left | var(--semi-border-radius-small) 0 0 var(--semi-border-radius-small) | 垂直卡片式页签四向圆角 |
| $radius-tabs_tab_button | var(--semi-border-radius-small) | 按钮式页签圆角 |
| $font-tabs_bar_large-fontSize | $font-size-regular | 大号模式 字体大小 |
| $font-tabs_bar_small-fontSize | $font-size-regular | 小号模式 字体大小 |
| $font-tabs_bar_medium-fontSize | $font-size-regular | 中等模式 字体大小 |
Content Guidelines
- Label copy needs to explain the label content accurately and clearly
- Use short, easily distinguishable labels
- try to stay within one word
FAQ
-
Why typography with ellipses in Tabs doesn't work?
Because when Tabs renders TabPane, the default is to render display: none. At this point these components cannot get the correct width or height values. It is recommended to enable lazyRender in or disable keepDOM.
-
Why are the height or width values wrong when using components such as Collapse/Collapsible/Resizable Table in Tabs?
The reason is the same as above. In addition, if the collapse does not need animation, you can also turn off the animation effect by setting its
motionto false. There is no need to get the height of the component at this point。