# 浮动窗口

- 页面: https://jiguang132.com/zh/resources/mantine/docs/floating-window
- 资源: Mantine Core (https://jiguang132.com/zh/resources/mantine.md)
- 全部指南: https://jiguang132.com/zh/resources/mantine/docs.md

Mantine Core 的独立组件，请不要替换为 JGuang UI/Base UI 的同名 API。

## 安装

```bash
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 示例提取，按所属组件区分。不是全部属性清单；完整签名和继承关系见下方固定源码参考。

| 组件参数 | 说明 |
| --- | --- |
| `FloatingWindow.initialPosition` | 浮动窗口初始位置。 |
| `FloatingWindow.p` | Mantine 内边距样式参数。 |

## 交互与状态检查

当前场景：默认。切换支持的禁用、错误或只读场景后检查真实行为；无此原生状态的组件不会被强行添加统一属性。验证键盘焦点和退出方式，修改值后按原生回调签名连接业务状态。

## 业务接入边界

示例内容和状态仅保存在本地，不提供服务端持久化、授权或数据请求。静态展示组件不应被当作已完成的业务流程。

## 宿主配置

先安装固定版本 @mantine/core 和 @mantine/hooks，在入口引入 @mantine/core/styles.css，并使用 MantineProvider。示例的 theme 和 variant 是 JGuang 编写的宿主参数，不是所有原生组件都接受的统一 API；通过 forceColorScheme 同步应用主题。源码面板中的原生实现仅供阅读，使用 npm 导出，不要单独复制内部实现。此批只覆盖 Core，不包括日期、图表和表单扩展包。上游详细说明保留英文，不宣称全文中文化。


## 可运行用法

以下代码使用资源原生 API；不是把其他设计系统的同名组件替换进来。

```tsx
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.FloatingWindow initialPosition={{ top: 20, left: 20 }} p="md">{content}</M.FloatingWindow>;
}
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

`FloatingWindow` creates a draggable element with a fixed position:



## Constrain to viewport

Use the `constrainToViewport` prop to restrict element movement to the viewport boundaries.
Without it, the element can be dragged outside the viewport:



## Constrain offset

Use the `constrainOffset` prop to set the offset from the viewport edges when constraining the element:



## Drag handle selector

The `dragHandleSelector` prop allows specifying a selector of an element (or a group of elements) that should be used to drag the floating window.
If not specified, the entire root element is used as a drag target.

The `excludeDragHandleSelector` prop excludes elements within `dragHandleSelector` from the drag event.
In the following example, the close button is excluded from the drag event:



## Enabled prop

Use the `enabled` option to enable or disable dragging:



## Set position

Call the `setPosition` function to set the position of the element programmatically.
This function accepts an object with `top`, `left`, `right` and `bottom` properties,
from which you should only specify two (for example, `top` and `left`, `bottom` and `right`).



## Resize handle

Use `FloatingWindow.ResizeHandle` compound component to add a resize handle to the floating window.
The `dimensions` prop on `FloatingWindow` controls the resize behavior:

- `initialWidth` / `initialHeight` – initial size of the window in px
- `minWidth` / `minHeight` – minimum size the window can be resized to
- `maxWidth` / `maxHeight` – maximum size the window can be resized to

The resize handle respects `constrainToViewport` and `constrainOffset` props.
It can be used with keyboard: arrow keys resize the window in 10px steps,
`Home` and `End` keys set the minimum and maximum size.



## Resize callbacks

Resize callbacks require the `dimensions` prop and `FloatingWindow.ResizeHandle`:

- `onSizeChange` – called with the `{ width, height }` of the window every time it is resized
- `onResizeStart` – called when the resize starts, pointer resize only
- `onResizeEnd` – called when the resize stops, pointer resize only



## Lock axis

Use the `axis` option to restrict movement to the specified axis:



## use-floating-window hook

If you prefer the hook API, you can use the [useFloatingWindow](/hooks/use-floating-window) hook.
It supports most of the `FloatingWindow` features:




## 源码参数参考

以下实现签名和类型从本地固定版本源码生成。保留可选属性、原生继承类型、联合分支和 never 限制；不会将其他设计系统的 API 混入。forwardRef 实现中的 ref 属于 React 引用，不是新增业务属性。此区域是原始类型参考，不是上游说明的全文翻译。


```ts
FloatingWindow(_props)
```



```ts
export type FloatingWindowStylesNames = 'root';

export interface FloatingWindowProps
  extends
    UseFloatingWindowOptions,
    PaperBaseProps,
    BoxProps,
    StylesApiProps<FloatingWindowFactory>,
    ElementProps<'div', keyof UseFloatingWindowOptions> {
  /** Assigns ref to set position programmatically */
  setPositionRef?: React.RefObject<SetFloatingWindowPosition | null>;

  /** Determines whether the window should be rendered inside `Portal` @default true */
  withinPortal?: boolean;

  /** Props passed down to `Portal` component */
  portalProps?: Omit<PortalProps, 'children'>;

  /** `z-index` of the root element @default 400 */
  zIndex?: React.CSSProperties['zIndex'];

  /** Dimensions configuration for resizable floating window */
  dimensions?: FloatingWindowDimensions;

  /** Called when the window is resized with `FloatingWindow.ResizeHandle` */
  onSizeChange?: (size: FloatingWindowSize) => void;

  /** Called when the resize with `FloatingWindow.ResizeHandle` starts. Not called for keyboard resize. */
  onResizeStart?: () => void;

  /** Called when the resize with `FloatingWindow.ResizeHandle` stops. Not called for keyboard resize. */
  onResizeEnd?: () => void;
}

export type FloatingWindowFactory = Factory<{
  props: FloatingWindowProps;
  ref: HTMLDivElement;
  stylesNames: FloatingWindowStylesNames;
  staticComponents: {
    ResizeHandle: typeof FloatingWindowResizeHandle;
  };
}>;

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 检查为准。


```ts
Factory<{
  props: FloatingWindowProps;
  ref: HTMLDivElement;
  stylesNames: FloatingWindowStylesNames;
  staticComponents: {
    ResizeHandle: typeof FloatingWindowResizeHandle;
  };
}>
UseFloatingWindowOptions
PaperBaseProps
MantineStyleProps
React.CSSProperties
MantineTheme
Partial<Record<Variable, string>>
Record<Variable, string>
Variable
MantineBreakpoint
Record<string, any>
StylesApiProps<FloatingWindowFactory>
React.ElementType
Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>
React.ComponentProps<ElementType>
ElementType
PropsToOmit
React.RefObject<SetFloatingWindowPosition | null>
SetFloatingWindowPosition
Omit<PortalProps, 'children'>
PortalProps
FloatingWindowDimensions
FloatingWindowSize
HTMLDivElement
```

---

JGuang 全部资源索引: https://jiguang132.com/llms.txt