ui/client/features/live-preview/hooks/usePreviewSize

Cockpit client (features), next. Source: ui/client/features/live-preview/hooks/usePreviewSize.tsx.

Functions#

usePreviewSize()#

usePreviewSize(): object

Defined in: ui/client/features/live-preview/hooks/usePreviewSize.tsx:13

The preview's device size, remembered per project, plus the frame's real measured size. Fit until the project is known, so the frame never opens at a width nobody asked for.

Returns#

object

boxRef

boxRef: (node) => void

Parameters

node

HTMLDivElement | null

Returns

void

choose

choose: (next) => void

Parameters

next

string

Returns

void

measured

measured: { height: number; width: number; } | null

option

option: PreviewSizeOption

size

size: PreviewSizeId

sizes

sizes: PreviewSizeOption[] = PREVIEW_SIZES