传送门
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 控制深浅色。
适用场景
将子内容渲染到通常 DOM 父节点之外。
本地示例使用的原生参数
以下参数由本地、经过类型检查的 JSX 示例提取,按所属组件区分。不是全部属性清单;完整签名和继承关系见下方固定源码参考。
此最小示例仅传入子内容,未虚构额外属性。可选参数见源码参考。
交互与状态检查
当前场景:默认。切换支持的禁用、错误或只读场景后检查真实行为;无此原生状态的组件不会被强行添加统一属性。验证键盘焦点和退出方式,修改值后按原生回调签名连接业务状态。
业务接入边界
内容渲染到通常父节点之外,但仍在当前 iframe 文档内,Portal 不会跨越隔离边界。
宿主配置
先安装固定版本 @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 content = <M.Text>Build something beautiful / 构建美好的界面</M.Text>;
return <M.Portal>{content}</M.Portal>;
}
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
Portal is a wrapper component for the ReactDOM.createPortal API.
Render any component or element at the end of document.body or at a given element. The Modal and Drawer components are wrapped in Portal by default.
Use Portal to render a component or an element at a different place (defaults to the end of document.body).
Portal is useful when you want to prevent parent styles from interfering with children.
Usually all these styles are related to position and z-index properties,
and portals are used for components with fixed position, for example, modals.
import { useState } from 'react';
import { Portal } from '@mantine/core';
function Demo() {
const [opened, setOpened] = useState(false);
return (
<main style={{ position: 'relative', zIndex: 1 }}>
{opened && (
<Portal>
<div>Your modal content</div>
</Portal>
)}
<button onClick={() => setOpened(true)} type="button">
Open modal
</button>
</main>
);
}
In the example above, the div element is rendered outside of the parent main (before the closing body tag),
but still receives the opened and onClose props. The element will not be affected by the parent z-index.
Reuse target node
By default, Portal reuses the same target node for all instances (reuseTargetNode={true}).
To create a new target node for each instance, set reuseTargetNode={false}. In the following
example, all three paragraphs will be rendered in separate target nodes:
import { Portal } from '@mantine/core';
function Demo() {
return (
<>
<Portal reuseTargetNode={false}>
<p>First</p>
</Portal>
<Portal reuseTargetNode={false}>
<p>Second</p>
</Portal>
<Portal reuseTargetNode={false}>
<p>Third</p>
</Portal>
</>
);
}
Specify target DOM node
You can specify the DOM node where the portal will be rendered by passing the target prop:
import { Portal } from '@mantine/core';
const container = document.createElement('div');
document.body.appendChild(container);
function Demo() {
return <Portal target={container}>My portal</Portal>;
}
Alternatively, you can specify a selector to render the portal in an existing element:
import { Portal } from '@mantine/core';
function Demo() {
return <Portal target="#portal-container">My portal</Portal>;
}
If you don't specify the target element, a new one will be created and appended to the document.body for each Portal component.
Server side rendering
createPortal is not supported during server-side rendering.
All components inside Portal are rendered only after the application was mounted to the DOM.
OptionalPortal component
The OptionalPortal component lets you configure whether children should be rendered in Portal.
It accepts the same props as the Portal component:
import { OptionalPortal } from '@mantine/core';
function Demo() {
return (
<>
<OptionalPortal withinPortal>
This text is rendered in Portal
</OptionalPortal>
<OptionalPortal withinPortal={false}>
This text is rendered as regular child
</OptionalPortal>
</>
);
}
源码参数参考
以下实现签名和类型从本地固定版本源码生成。保留可选属性、原生继承类型、联合分支和 never 限制;不会将其他设计系统的 API 混入。forwardRef 实现中的 ref 属于 React 引用,不是新增业务属性。此区域是原始类型参考,不是上游说明的全文翻译。
Portal(props)
export interface BasePortalProps extends React.ComponentProps<'div'> {
/**
* Target element where portal should be rendered. Accepts:
* - HTMLElement: Renders portal inside this element
* - string: CSS selector - renders inside first matching element
* - undefined: Uses shared portal node or creates new one based on `reuseTargetNode`
*
* Note: If selector doesn't match any element, portal will not render
*/
target?: HTMLElement | string;
/**
* When true and target is not specified, all Portal instances share a single
* container node appended to document.body. When false, each Portal creates
* its own container node.
*
* Has no effect when target is specified.
*
* @default true
*/
reuseTargetNode?: boolean;
}
export interface PortalProps extends BasePortalProps {
/** Content to render inside the portal */
children: React.ReactNode;
}
export type PortalFactory = Factory<{
props: PortalProps;
ref: HTMLDivElement;
}>;
原生与外部类型
以下外部类型仍由 React 或资源自身依赖定义,没有手工展开为虚构属性。实际可用类型以安装版本的 TypeScript 检查为准。
Factory<{
props: PortalProps;
ref: HTMLDivElement;
}>
React.ComponentProps<'div'>
HTMLElement
React.ReactNode
HTMLDivElement