@manta-eu/react/use-resizable-panel

Reference for @manta-eu/react/use-resizable-panel as it is on main.

Type Aliases

ClampPanelWidthProps

ClampPanelWidthProps = object

Properties

containerWidth

containerWidth: number

maxWidthRatio?

optional maxWidthRatio?: number

minRemainingWidth?

optional minRemainingWidth?: number

minWidth

minWidth: number

requestedWidth

requestedWidth: number

UseResizablePanelProps

UseResizablePanelProps = object

Properties

initialWidth

initialWidth: number

maxWidthRatio?

optional maxWidthRatio?: number

minRemainingWidth?

optional minRemainingWidth?: number

minWidth

minWidth: number

onResize?

optional onResize?: (width) => void

Parameters

width

number

Returns

void

onResizeEnd?

optional onResizeEnd?: (width) => void

Parameters

width

number

Returns

void

resizeFrom?

optional resizeFrom?: "left" | "right"

Functions

clampPanelWidth()

clampPanelWidth(props): number

Parameters

props

ClampPanelWidthProps

Returns

number

useResizablePanel()

useResizablePanel(props): object

Parameters

props

UseResizablePanelProps

Returns

object

cancelResize

cancelResize: () => void | undefined

Returns

void | undefined

handleResizeStart

handleResizeStart: (event) => void

Parameters

event

MouseEvent<HTMLDivElement>

Returns

void

panelRef

panelRef: RefObject<HTMLDivElement | null>

panelWidth

panelWidth: number

setWidth

setWidth: (requestedWidth) => number

Parameters

requestedWidth

number

Returns

number