# FloatingWindow

- Page: https://jiguang132.com/resources/mantine/docs/floating-window
- Resource: Mantine Core (https://jiguang132.com/resources/mantine.md)
- All guides: https://jiguang132.com/resources/mantine/docs.md

Install: `npm install @mantine/core@9.7.1 @mantine/hooks@9.7.1`

## Version and compatibility

Pinned Mantine Core 9.7.1 requires React and React DOM `^19.2.0` and matching `@mantine/hooks@9.7.1`, from the installed npm package's peerDependencies. Do not force it into React 18 or another incompatible version. Explain upgrade impact and agree on a plan with the project owner; do not hide conflicts with --force/--legacy-peer-deps. The native Provider enables `theme.respectReducedMotion` and uses `forceColorScheme` for light/dark.

## Use case

Display a movable floating content window.

## Native props used by this example

These props are extracted from the local typechecked JSX and grouped by their owning native component. This is not an exhaustive prop list; see pinned source signatures and inheritance below.

| Component prop | Explanation |
| --- | --- |
| `FloatingWindow.initialPosition` | Initial floating-window position. |
| `FloatingWindow.p` | Mantine padding style prop. |

## Interaction and state checks

Current scenarios: Default. Check actual behavior after selecting supported disabled/error/read-only scenarios; components without those native states do not receive invented universal props. Verify keyboard focus and exits, then connect changed values through the native callback signature.

## Business integration boundary

Demo content/state is local, without server persistence, authorization or fetching. A static display component is not a completed business workflow.

## Host setup

Install pinned @mantine/core and @mantine/hooks, import @mantine/core/styles.css at the entry and use MantineProvider. The example's theme/variant are JGuang-authored host props, not universal native component APIs; forceColorScheme synchronizes the app theme. Native implementation source is a reading reference: use npm exports rather than copying internal engines. This batch covers Core, not dates/charts/forms extension packages. Detailed upstream prose remains English.


## Runnable usage

```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>;
}

```


## Preview states

Default

The example uses the native Mantine API. For supported input demos, change the local variant to Disabled, Invalid or Read only; these are example labels, not new component props. Keep the documented data, controlled values, stores and compound children when adapting the example.



## 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:




## Source-backed parameter reference

Implementation signatures and types are generated from the pinned local source. Optional props, native inherited types, union branches and never exclusions are preserved. A forwardRef implementation's ref is a React reference, not an additional business prop.


```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>[];
```


### Native and external types

External types remain defined by React or native dependencies, not manually expanded into guessed props. The installed version's TypeScript definitions are authoritative.


```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
```

---

Index of all JGuang resources: https://jiguang132.com/llms.txt