标签页
Mantine Core 的独立组件,请不要替换为 JGuang UI/Base UI 的同名 API。
安装
npm install @mantine/core@9.7.1 @mantine/hooks@9.7.1
入口引入 @mantine/core/styles.css,并在根组件使用 MantineProvider;通过 forceColorScheme 同步深浅色主题。
使用与验证
在左侧选择组件,在预览中操作它的状态;使用“查看代码”检查真实源码。安装后执行类型检查和构建,再验证键盘焦点、手机布局与深浅色主题。
来源
https://github.com/mantinedev/mantine/tree/f0e2bc6d28b0f0b8aaefb5b859937bf77f539df7 MIT 许可证;不包括付费内容。下方提供上游英文参考内容,中文使用指南已适配;上游详细参考暂保留英文。
版本与兼容性
固定的 Mantine Core 9.7.1 要求 React 和 React DOM 满足 ^19.2.0,并配套 @mantine/hooks@9.7.1。此条件来自实际 npm 包的 peerDependencies。React 18 或其他不兼容版本不能强行安装;先向项目负责人说明升级影响并确认方案,不使用 --force/--legacy-peer-deps 掩盖冲突。入口的原生 Provider 开启 theme.respectReducedMotion,并用 forceColorScheme 控制深浅色。
适用场景
切换互斥内容面板。
本地示例使用的原生参数
以下参数由本地、经过类型检查的 JSX 示例提取,按所属组件区分。不是全部属性清单;完整签名和继承关系见下方固定源码参考。
| 组件参数 | 说明 |
|---|---|
Tabs.defaultValue | 非受控初始值,不是持续更新的受控值。 |
Tabs.Tab.value | 受控值,具体结构由原生类型定义。 |
Tabs.Panel.value | 受控值,具体结构由原生类型定义。 |
Tabs.Panel.pt | Mantine 顶部内边距样式参数。 |
交互与状态检查
当前场景:默认。切换支持的禁用、错误或只读场景后检查真实行为;无此原生状态的组件不会被强行添加统一属性。验证键盘焦点和退出方式,修改值后按原生回调签名连接业务状态。
业务接入边界
示例内容和状态仅保存在本地,不提供服务端持久化、授权或数据请求。静态展示组件不应被当作已完成的业务流程。
宿主配置
先安装固定版本 @mantine/core 和 @mantine/hooks,在入口引入 @mantine/core/styles.css,并使用 MantineProvider。示例的 theme 和 variant 是 JGuang 编写的宿主参数,不是所有原生组件都接受的统一 API;通过 forceColorScheme 同步应用主题。源码面板中的原生实现仅供阅读,使用 npm 导出,不要单独复制内部实现。此批只覆盖 Core,不包括日期、图表和表单扩展包。上游详细说明保留英文,不宣称全文中文化。
可运行用法
以下代码使用资源原生 API;不是把其他设计系统的同名组件替换进来。
import { useState } from 'react';
import * as M from '@mantine/core';
import '@mantine/core/styles.css';
function ComponentPreview({ variant = 'Default' }: { variant?: string }) {
const [value, setValue] = useState(35);
const content = <M.Text>Build something beautiful / 构建美好的界面</M.Text>;
return <M.Tabs defaultValue="preview"><M.Tabs.List><M.Tabs.Tab value="preview">Preview</M.Tabs.Tab><M.Tabs.Tab value="code">Code</M.Tabs.Tab></M.Tabs.List><M.Tabs.Panel value="preview" pt="md">{content}</M.Tabs.Panel><M.Tabs.Panel value="code" pt="md"><M.Code>npm install @mantine/core</M.Code></M.Tabs.Panel></M.Tabs>;
}
export default function Example({ variant = 'Default', theme = 'light' }: { variant?: string; theme?: 'light' | 'dark' }) {
return <M.MantineProvider forceColorScheme={theme} theme={{ respectReducedMotion: true }}><ComponentPreview variant={variant} /></M.MantineProvider>;
}
可用状态与示例
默认
示例遵循 Mantine 原生 API。支持多状态的输入组件可将示例中的 variant 改为 Disabled、Invalid 或 Read only;这些只是示例标签,不是新增的组件属性。改造时保留组件要求的数据、受控值、store 和复合子组件结构。
Usage
Controlled Tabs
To control the Tabs state, use value and onChange props:
import { useState } from 'react';
import { Tabs } from '@mantine/core';
function Demo() {
const [activeTab, setActiveTab] = useState<string | null>('first');
return (
<Tabs value={activeTab} onChange={setActiveTab}>
<Tabs.List>
<Tabs.Tab value="first">First tab</Tabs.Tab>
<Tabs.Tab value="second">Second tab</Tabs.Tab>
</Tabs.List>
<Tabs.Panel value="first">First panel</Tabs.Panel>
<Tabs.Panel value="second">Second panel</Tabs.Panel>
</Tabs>
);
}
Uncontrolled Tabs
If you do not need to subscribe to Tabs state changes, use defaultValue:
import { Tabs } from '@mantine/core';
function Demo() {
return (
<Tabs defaultValue="first">
<Tabs.List>
<Tabs.Tab value="first">First tab</Tabs.Tab>
<Tabs.Tab value="second">Second tab</Tabs.Tab>
</Tabs.List>
<Tabs.Panel value="first">First panel</Tabs.Panel>
<Tabs.Panel value="second">Second panel</Tabs.Panel>
</Tabs>
);
}
Change colors
To change the colors of all tabs, set color on the Tabs component; to change the color of an individual tab,
set color on Tabs.Tab.
Tabs position
To display a tab on the opposite side, set margin-left: auto with the ml="auto" prop or with className:
Inverted tabs
To make tabs inverted, place Tabs.Panel components before Tabs.List and add the inverted prop to the Tabs component:
Vertical tabs placement
To change the placement of Tabs.List in vertical orientation, set the placement prop:
Custom variants
Example of custom variant with FloatingIndicator:
Disabled tabs
Set the disabled prop on the Tabs.Tab component to disable a tab.
Disabled tabs cannot be activated with the mouse or keyboard, and they will be skipped when the user navigates with arrow keys:
Activation mode
By default, tabs are activated when the user presses arrow keys or Home/End keys.
To disable that, set activateTabWithKeyboard={false} on the Tabs component:
Tab deactivation
By default, the active tab cannot be deactivated. To allow that, set allowTabDeactivation on the Tabs component:
Unmount inactive tabs
By default, inactive Tabs.Panel will stay mounted; to unmount inactive tabs, set keepMounted={false} on Tabs.
This is useful when you want to render components that impact performance inside Tabs.Panel. Note that
components that are rendered inside Tabs.Panel will reset their state on each mount (tab change).
import { Tabs } from '@mantine/core';
// Second tab panel will be mounted only when the user activates the second tab
function Demo() {
return (
<Tabs keepMounted={false} defaultValue="first">
<Tabs.List>
<Tabs.Tab value="first">First tab</Tabs.Tab>
<Tabs.Tab value="second">Second tab</Tabs.Tab>
</Tabs.List>
<Tabs.Panel value="first">First panel</Tabs.Panel>
<Tabs.Panel value="second">Second panel</Tabs.Panel>
</Tabs>
);
}
Get tab control ref
import { useRef } from 'react';
import { Tabs } from '@mantine/core';
function Demo() {
const secondTabRef = useRef<HTMLButtonElement>(null);
return (
<Tabs defaultValue="first">
<Tabs.List>
<Tabs.Tab value="first">First tab</Tabs.Tab>
<Tabs.Tab value="Second" ref={secondTabRef}>
Second tab
</Tabs.Tab>
<Tabs.Tab value="third">Third tab</Tabs.Tab>
</Tabs.List>
</Tabs>
);
}
Tab as a link
You can render Tabs.Tab as an a element by using the renderRoot prop. This gives you
native link behavior: right-click to open in a new tab, middle-click, and href for
crawlers and accessibility.
import { Tabs } from '@mantine/core';
function Demo() {
return (
<Tabs defaultValue="home">
<Tabs.List>
<Tabs.Tab
value="home"
renderRoot={(props) => <a href="/home" {...props} />}
>
Home
</Tabs.Tab>
<Tabs.Tab
value="about"
renderRoot={(props) => <a href="/about" {...props} />}
>
About
</Tabs.Tab>
<Tabs.Tab
value="contacts"
renderRoot={(props) => <a href="/contacts" {...props} />}
>
Contacts
</Tabs.Tab>
</Tabs.List>
</Tabs>
);
}
You can also use the component prop to render tabs as links:
import { Tabs } from '@mantine/core';
function Demo() {
return (
<Tabs defaultValue="home">
<Tabs.List>
<Tabs.Tab value="home" component="a" href="/home">
Home
</Tabs.Tab>
<Tabs.Tab value="about" component="a" href="/about">
About
</Tabs.Tab>
</Tabs.List>
</Tabs>
);
}
Tab as a link with Next.js
Use the renderRoot prop to render Tabs.Tab as a Next.js Link component. The renderRoot prop
is required instead of component because Next.js Link is a generic component:
import Link from 'next/link';
import { usePathname } from 'next/navigation';
import { Tabs } from '@mantine/core';
function Demo() {
const pathname = usePathname();
return (
<Tabs value={pathname}>
<Tabs.List>
<Tabs.Tab
value="/home"
renderRoot={(props) => <Link href="/home" {...props} />}
>
Home
</Tabs.Tab>
<Tabs.Tab
value="/about"
renderRoot={(props) => <Link href="/about" {...props} />}
>
About
</Tabs.Tab>
</Tabs.List>
</Tabs>
);
}
Tab as a link with React Router
Use the renderRoot prop to render Tabs.Tab as a React Router NavLink or Link component:
import {
Link,
Route,
useLocation,
} from 'react-router-dom';
import { Tabs } from '@mantine/core';
// Route: <Route path="/tabs/:tabValue" element={<Demo />} />
function Demo() {
const location = useLocation();
return (
<Tabs value={location.pathname}>
<Tabs.List>
<Tabs.Tab
value="/tabs/first"
renderRoot={(props) => (
<Link to="/tabs/first" {...props} />
)}
>
First tab
</Tabs.Tab>
<Tabs.Tab
value="/tabs/second"
renderRoot={(props) => (
<Link to="/tabs/second" {...props} />
)}
>
Second tab
</Tabs.Tab>
</Tabs.List>
</Tabs>
);
}
Usage with react-router
<Route path="/tabs/:tabValue" element={<Demo />} />
import { useNavigate, useParams } from 'react-router-dom';
import { Tabs } from '@mantine/core';
function Demo() {
const navigate = useNavigate();
const { tabValue } = useParams();
return (
<Tabs
value={tabValue}
onChange={(value) => navigate(`/tabs/${value}`)}
>
<Tabs.List>
<Tabs.Tab value="first">First tab</Tabs.Tab>
<Tabs.Tab value="second">Second tab</Tabs.Tab>
</Tabs.List>
</Tabs>
);
}
Usage with Next.js Pages Router
// For file /tabs/[activeTab].tsx
import { useRouter } from 'next/router';
import { Tabs } from '@mantine/core';
function Demo() {
const router = useRouter();
return (
<Tabs
value={router.query.activeTab as string}
onChange={(value) => router.push(`/tabs/${value}`)}
>
<Tabs.List>
<Tabs.Tab value="first">First tab</Tabs.Tab>
<Tabs.Tab value="second">Second tab</Tabs.Tab>
</Tabs.List>
</Tabs>
);
}
Usage with Next.js App Router
In the App Router, get the current tab value from the pathname with the usePathname
hook and change tabs with the router returned by useRouter. Both hooks are imported
from next/navigation. Note that components that use these hooks must be
Client Components
(add the 'use client' directive at the top of the file).
// For file /tabs/[activeTab]/page.tsx
'use client';
import { usePathname, useRouter } from 'next/navigation';
import { Tabs } from '@mantine/core';
function Demo() {
const router = useRouter();
const pathname = usePathname();
const activeTab = pathname.split('/').pop();
return (
<Tabs
value={activeTab}
onChange={(value) => router.push(`/tabs/${value}`)}
>
<Tabs.List>
<Tabs.Tab value="first">First tab</Tabs.Tab>
<Tabs.Tab value="second">Second tab</Tabs.Tab>
</Tabs.List>
</Tabs>
);
}
Example of Styles API usage to customize tab styles:
Example with Scroller component
Use Scroller component to make the tabs list scrollable when there are too many tabs to fit in the available space:
Accessibility
The Tabs component follows WAI-ARIA recommendations on accessibility.
Tabs as links
When Tabs.Tab is rendered as a link (<a> tag), the role="tab" attribute overrides
the implicit link role. Screen readers will announce the element as a "tab", not a "link".
This is the expected behavior per the WAI-ARIA specification.
When using tabs as navigation links without Tabs.Panel components, the aria-controls attribute
on each tab references a panel element that does not exist in the DOM. This is a minor
accessibility consideration – most screen readers handle this gracefully.
If you use Tabs.Tab without text content, for example, only with an icon, then set aria-label
or use the VisuallyHidden component:
import { CoinIcon } from '@phosphor-icons/react';
import { Tabs, VisuallyHidden } from '@mantine/core';
function Demo() {
return (
<Tabs defaultValue="chat">
<Tabs.List>
{/* aria-label is not required, tab is labelled by children */}
<Tabs.Tab value="chat">Chat</Tabs.Tab>
{/* aria-label is required, tab is not labelled by children */}
<Tabs.Tab
value="money"
aria-label="Get money"
leftSection={<CoinIcon size={14} />}
/>
{/* You can use VisuallyHidden instead of aria-label */}
<Tabs.Tab value="money" leftSection={<CoinIcon size={14} />}>
<VisuallyHidden>Get money</VisuallyHidden>
</Tabs.Tab>
</Tabs.List>
</Tabs>
);
}
To set the tabs list label, set aria-label on the Tabs.List component; it will be announced by screen reader:
import { Tabs } from '@mantine/core';
function Demo() {
return (
<Tabs defaultValue="recent">
{/* Tabs.List aria-label will be announced when tab is focused for the first time */}
<Tabs.List aria-label="Chats">
<Tabs.Tab value="recent">Most recent</Tabs.Tab>
<Tabs.Tab value="recent">Unanswered</Tabs.Tab>
<Tabs.Tab value="archived">Archived</Tabs.Tab>
</Tabs.List>
</Tabs>
);
}
Keyboard interactions
源码参数参考
以下实现签名和类型从本地固定版本源码生成。保留可选属性、原生继承类型、联合分支和 never 限制;不会将其他设计系统的 API 混入。forwardRef 实现中的 ref 属于 React 引用,不是新增业务属性。此区域是原始类型参考,不是上游说明的全文翻译。
Tabs(_props)
export type TabsStylesNames =
| 'root'
| TabsListStylesNames
| TabsPanelStylesNames
| TabsTabStylesNames;
export type TabsVariant = 'default' | 'outline' | 'pills';
export type TabsCssVariables = {
root: '--tabs-color' | '--tabs-radius';
};
export interface TabsProps
extends
BoxProps,
StylesApiProps<TabsFactory>,
ElementProps<'div', 'defaultValue' | 'value' | 'onChange'> {
/** Uncontrolled component default value */
defaultValue?: string | null;
/** Controlled component value */
value?: string | null;
/** Called when value changes */
onChange?: (value: string | null) => void;
/** Tabs orientation @default 'horizontal' */
orientation?: 'vertical' | 'horizontal';
/** `Tabs.List` placement relative to `Tabs.Panel`, applicable only when `orientation="vertical"` @default 'left' */
placement?: 'left' | 'right';
/** Base id, used to generate ids to connect labels with controls, generated randomly by default */
id?: string;
/** If set, arrow key presses loop though items (first to last and last to first) @default true */
loop?: boolean;
/** If set, tab is activated with arrow key press @default true */
activateTabWithKeyboard?: boolean;
/** If set, tab can be deactivated @default false */
allowTabDeactivation?: boolean;
/** Tabs content */
children?: React.ReactNode;
/** Changes colors of `Tabs.Tab` components when variant is `pills` or `default`, does nothing for other variants */
color?: MantineColor;
/** Key of `theme.radius` or any valid CSS value to set `border-radius` @default theme.defaultRadius */
radius?: MantineRadius;
/** Determines whether tabs should have inverted styles @default false */
inverted?: boolean;
/** If set to `false`, `Tabs.Panel` content will be unmounted when the associated tab is not active @default true */
keepMounted?: boolean;
/** Controls how inactive tabs content is hidden when `keepMounted` is `true`, `'activity'` – hidden with `Activity` component, `'display-none'` – hidden with `display: none` styles @default 'activity' */
keepMountedMode?: 'activity' | 'display-none';
/** If set, adjusts text color based on background color for `pills` variant */
autoContrast?: boolean;
}
export type TabsFactory = Factory<{
props: TabsProps;
ref: HTMLDivElement;
variant: TabsVariant;
stylesNames: TabsStylesNames;
vars: TabsCssVariables;
staticComponents: {
Tab: typeof TabsTab;
Panel: typeof TabsPanel;
List: typeof TabsList;
};
}>;
export type Mod = Record<string, any> | string;
export type BoxMod = Mod | Mod[] | BoxMod[];
export interface BoxProps extends MantineStyleProps {
/** Class added to the root element, if applicable */
className?: string | undefined;
/** Inline style added to root component element, can subscribe to theme defined on MantineProvider */
style?: MantineStyleProp;
/** CSS variables defined on root component element */
__vars?: CssVarsProp;
/** `size` property passed down the HTML element */
__size?: string;
/** Breakpoint above which the component is hidden with `display: none` */
hiddenFrom?: MantineBreakpoint;
/** Breakpoint below which the component is hidden with `display: none` */
visibleFrom?: MantineBreakpoint;
/** Determines whether component should be hidden in light color scheme with `display: none` */
lightHidden?: boolean;
/** Determines whether component should be hidden in dark color scheme with `display: none` */
darkHidden?: boolean;
/** Element modifiers transformed into `data-` attributes, for example, `{ 'data-size': 'xl' }`, falsy values are removed */
mod?: BoxMod;
}
export type ElementProps<
ElementType extends React.ElementType,
PropsToOmit extends string = never,
> = Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>;
export interface CSSProperties extends React.CSSProperties {
[key: string]: any;
}
type MantineStyle = CSSProperties | ((theme: MantineTheme) => CSSProperties);
export type MantineStyleProp = MantineStyle | MantineStyle[] | MantineStyleProp[] | undefined;
export type CssVariable = `--${string}`;
export type CssVariables<Variable extends string = CssVariable> = Partial<Record<Variable, string>>;
export type CssVars<Variable extends string = CssVariable> =
| CssVariables<Variable>
| ((theme: MantineTheme) => CssVariables<Variable>)
| CssVars<Variable>[];
export type CssVarsProp<Variable extends string = CssVariable> =
| CssVars<Variable>
| CssVars<Variable>[];
原生与外部类型
以下外部类型仍由 React 或资源自身依赖定义,没有手工展开为虚构属性。实际可用类型以安装版本的 TypeScript 检查为准。
Factory<{
props: TabsProps;
ref: HTMLDivElement;
variant: TabsVariant;
stylesNames: TabsStylesNames;
vars: TabsCssVariables;
staticComponents: {
Tab: typeof TabsTab;
Panel: typeof TabsPanel;
List: typeof TabsList;
};
}>
MantineStyleProps
React.CSSProperties
MantineTheme
Partial<Record<Variable, string>>
Record<Variable, string>
Variable
MantineBreakpoint
Record<string, any>
StylesApiProps<TabsFactory>
React.ElementType
Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>
React.ComponentProps<ElementType>
ElementType
PropsToOmit
React.ReactNode
MantineColor
MantineRadius
HTMLDivElement
TabsListStylesNames
TabsPanelStylesNames
TabsTabStylesNames