ui/client/features/shell/hooks/useShellLayout

Cockpit client (features), v0.9. Source: ui/client/features/shell/hooks/useShellLayout.tsx.

Functions#

useShellLayout()#

useShellLayout(projectDir, projectKnown): object

Defined in: ui/client/features/shell/hooks/useShellLayout.tsx:11

Pane sizes/collapse state, remembered per project (guarded localStorage). Until the project is known the defaults are shown and nothing is saved; once projectDir resolves, that project's saved layout is loaded.

Parameters#

projectDir

string | null

projectKnown

boolean

Returns#

object

layout

layout: ShellLayoutState

resize

resize: (pane, size) => void

Parameters

pane

PaneId

size

number

Returns

void

toggle

toggle: (pane, open?) => void