Line

You are reading the unreleased docs (next). See latest (v0.9)

ui/client/features/shell/hooks/useRailCollapsed

Cockpit client (features), next. Source: ui/client/features/shell/hooks/useRailCollapsed.tsx.

Functions#

useRailCollapsed()#

useRailCollapsed(): object

Defined in: ui/client/features/shell/hooks/useRailCollapsed.tsx:8

Whether the screens rail is collapsed to icons only, remembered per person (this browser). First paint is the expanded rail (matches the server render); the saved choice is applied right after mount.

Returns#

object

collapsed

collapsed: boolean

toggle

toggle: () => void

Returns

void