导航链接
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 示例提取,按所属组件区分。不是全部属性清单;完整签名和继承关系见下方固定源码参考。
| 组件参数 | 说明 |
|---|---|
NavLink.label | 可见标签或当前组件的标签内容。 |
NavLink.active | 当前激活状态或索引,以当前组件类型为准。 |
NavLink.onClick | 本地点击处理,应按需替换为明确的业务操作。 |
NavLink.children | 原生子内容或渲染函数,以所属组件的类型为准。 |
交互与状态检查
当前场景:默认。切换支持的禁用、错误或只读场景后检查真实行为;无此原生状态的组件不会被强行添加统一属性。验证键盘焦点和退出方式,修改值后按原生回调签名连接业务状态。
业务接入边界
示例内容和状态仅保存在本地,不提供服务端持久化、授权或数据请求。静态展示组件不应被当作已完成的业务流程。
宿主配置
先安装固定版本 @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 [open, setOpen] = useState(false);
return <M.NavLink label="Resources" active onClick={() => setOpen(!open)} children={open ? <M.NavLink label="Components" /> : null} />;
}
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
Active
Set the active prop to add active styles to NavLink.
Note that if you're using a React Router NavLink inside renderRoot, the active styles will be based on the
aria-current attribute that's set by React Router,
so you won't need to explicitly set the active prop.
You can customize active styles with the color and variant props:
Nested NavLinks
To create nested links, put NavLink as children of another NavLink:
源码参数参考
以下实现签名和类型从本地固定版本源码生成。保留可选属性、原生继承类型、联合分支和 never 限制;不会将其他设计系统的 API 混入。forwardRef 实现中的 ref 属于 React 引用,不是新增业务属性。此区域是原始类型参考,不是上游说明的全文翻译。
NavLink(_props)
export type NavLinkStylesNames =
| 'root'
| 'section'
| 'body'
| 'label'
| 'description'
| 'chevron'
| 'collapse'
| 'children';
export type NavLinkVariant = 'filled' | 'light' | 'subtle';
export type NavLinkCssVariables = {
root: '--nl-color' | '--nl-bg' | '--nl-hover';
children: '--nl-offset';
};
export interface NavLinkProps extends BoxProps, StylesApiProps<NavLinkFactory> {
/** Main link label */
label?: React.ReactNode;
/** Link description, displayed below the label */
description?: React.ReactNode;
/** Section displayed on the left side of the label */
leftSection?: React.ReactNode;
/** Section displayed on the right side of the label */
rightSection?: React.ReactNode;
/** Determines whether the link should have active styles @default false */
active?: boolean;
/** Key of `theme.colors` or any valid CSS color to control active styles @default theme.primaryColor */
color?: MantineColor;
/** If set, label and description are truncated with ellipsis instead of wrapping @default false */
noWrap?: boolean;
/** Child `NavLink` components */
children?: React.ReactNode;
/** Controlled nested items collapse state */
opened?: boolean;
/** Uncontrolled nested items collapse initial state */
defaultOpened?: boolean;
/** Called when open state changes */
onChange?: (opened: boolean) => void;
/** If set, right section will not be rotated when collapse is opened @default false */
disableRightSectionRotation?: boolean;
/** Controls indentation of nested NavLink components, key of `theme.spacing` or any valid CSS value @default 'lg' */
childrenOffset?: MantineSpacing;
/** If set, disabled styles will be added to the root element @default false */
disabled?: boolean;
/** If set, adjusts text color based on background color for `filled` variant */
autoContrast?: boolean;
/** Called when the root element is clicked */
onClick?: React.MouseEventHandler<HTMLElement>;
/** Called on keydown of the root element */
onKeyDown?: React.KeyboardEventHandler<HTMLElement>;
/** If set to `false`, child `NavLinks` are unmounted when collapsed */
keepMounted?: boolean;
}
export type NavLinkFactory = PolymorphicFactory<{
props: NavLinkProps;
defaultRef: HTMLAnchorElement;
defaultComponent: 'a';
stylesNames: NavLinkStylesNames;
vars: NavLinkCssVariables;
variant: NavLinkVariant;
}>;
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 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 检查为准。
PolymorphicFactory<{
props: NavLinkProps;
defaultRef: HTMLAnchorElement;
defaultComponent: 'a';
stylesNames: NavLinkStylesNames;
vars: NavLinkCssVariables;
variant: NavLinkVariant;
}>
MantineStyleProps
React.CSSProperties
MantineTheme
Partial<Record<Variable, string>>
Record<Variable, string>
Variable
MantineBreakpoint
Record<string, any>
StylesApiProps<NavLinkFactory>
React.ReactNode
MantineColor
MantineSpacing
React.MouseEventHandler<HTMLElement>
HTMLElement
React.KeyboardEventHandler<HTMLElement>
HTMLAnchorElement