Resizable flyouts

You can use EuiFlyoutResizable to render a flyout that users can drag with their mouse or use arrow keys to resize. This may be useful for scenarios where the space the user needs can be unpredictable, if content is dynamic. Resizable flyouts allow users to adjust content to better fit their individual screens and workflows.

We strongly recommend setting reasonable numerical minWidth and maxWidth props based on the flyout content and page content that you can predict.

Props

EuiFlyoutResizable

Extends HTMLAttributes


Prop	Description and type	Default value
Prop onClose#	Description and type Type: `(event: MouseEvent \| KeyboardEvent \| TouchEvent) => void`	Default value Required
Prop size#	Description and type Defines the width of the panel. Pass a predefined size of `s \| m \| l`, or pass any number/string compatible with the CSS `width` attribute Type: `Width<string \| number>`	Default value `m`
Prop style#	Description and type Type: `CSSProperties`	Default value
Prop className#	Description and type Type: `string`	Default value
Prop css#	Description and type Type: `Interpolation<Theme>`	Default value
Prop side#	Description and type Which side of the window to attach to. The `left` option should only be used for navigation. Type: `"left" \| "right"`	Default value `right`
Prop maxWidth#	Description and type Type: `number`	Default value
Prop minWidth#	Description and type Type: `number`	Default value `200`
Prop type#	Description and type How to display the the flyout in relation to the body content; `push` keeps it visible, pushing the `<body>` content via padding Type: `"push" \| "overlay"`	Default value `overlay`
Prop aria-label#	Description and type Defines a string value that labels the current element. @see aria-labelledby. Type: `string`	Default value
Prop data-test-subj#	Description and type Type: `string`	Default value
Prop onResize#	Description and type Optional callback that fires on user resize with the new flyout width Type: `(width: number) => void`	Default value
Prop paddingSize#	Description and type Customize the padding around the content of the flyout header, body and footer Type: `"s" \| "m" \| "l" \| "none"`	Default value `l`
Prop closeButtonProps#	Description and type Extends EuiButtonIconProps onto the close button Type: `Partial<EuiButtonIconPropsForButton>`	Default value
Prop ownFocus#	Description and type Adds an EuiOverlayMask and wraps in an EuiPortal Type: `boolean`	Default value `true`
Prop hideCloseButton#	Description and type Hides the default close button. You must provide another close button somewhere within the flyout. Type: `boolean`	Default value `false`
Prop closeButtonPosition#	Description and type Position of close button. `inside`: Floating to just inside the flyout, always top right; `outside`: Floating just outside the flyout near the top (side dependent on `side`). Helpful when the close button may cover other interactable content. Type: `"inside" \| "outside"`	Default value `inside`
Prop maskProps#	Description and type Adjustments to the EuiOverlayMask that is added when `ownFocus = true` Type: `EuiOverlayMaskProps`	Default value
Prop outsideClickCloses#	Description and type Forces this interaction on the mask overlay or body content. Defaults depend on `ownFocus` and `type` values Type: `boolean`	Default value
Prop pushMinBreakpoint#	Description and type Named breakpoint (`xs` through `xl`) for customizing the minimum window width to enable the `push` type Type: `string`	Default value `l`
Prop pushAnimation#	Description and type Enables a slide in animation on push flyouts Type: `boolean`	Default value `false`
Prop focusTrapProps#	Description and type Object of props passed to EuiFocusTrap. `shards` specifies an array of elements that will be considered part of the flyout, preventing the flyout from being closed when clicked. `closeOnMouseup` will delay the close callback, allowing time for external toggle buttons to handle close behavior. Type: `Pick<EuiFocusTrapProps, "shards" \| "closeOnMouseup">`	Default value
Prop includeFixedHeadersInFocusTrap#	Description and type By default, EuiFlyout will consider any fixed `EuiHeader`s that sit alongside or above the EuiFlyout as part of the flyout's focus trap. This prevents focus fighting with interactive elements within fixed headers. Set this to `false` if you need to disable this behavior for a specific reason. Type: `boolean`	Default value
Prop as#	Description and type Sets the HTML element for `EuiFlyout` Type: `"div"`	Default value
Prop ref#	Description and type Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs} Type: `LegacyRef<unknown>`	Default value