Edit

IPanelResizeOptions interface

Options for controlling the horizontal width and resizing behavior of the panel.

Note: Resizing is automatically disabled on small screens (xsmall breakpoint) where the panel renders in fullscreen mode. The resize handle is not shown and any user-set width is ignored in that layout.

Properties

maxWidth

The maximum width in pixels the panel can be resized to. Only applies when userResizable is true.

minWidth

The minimum width in pixels the panel can be resized to. Only applies when userResizable is true.

onWidthChanged

Callback fired when the panel width changes due to user interaction.

userResizable

Whether the user can interactively resize the panel width by dragging the resize handle or using keyboard arrow keys. When false, the panel width is locked to the size determined by the size prop.

The resize handle is not rendered on small screens where the panel is displayed fullscreen.

Property Details

maxWidth

The maximum width in pixels the panel can be resized to. Only applies when userResizable is true.

maxWidth?: number

Property Value

number

minWidth

The minimum width in pixels the panel can be resized to. Only applies when userResizable is true.

minWidth?: number

Property Value

number

onWidthChanged

Callback fired when the panel width changes due to user interaction.

onWidthChanged?: (width: number) => void

Property Value

(width: number) => void

userResizable

Whether the user can interactively resize the panel width by dragging the resize handle or using keyboard arrow keys. When false, the panel width is locked to the size determined by the size prop.

The resize handle is not rendered on small screens where the panel is displayed fullscreen.

userResizable?: boolean

Property Value

boolean