Line

You are reading docs for v0.8. See latest (v0.9)

ui/client/features/auth/hooks/useUserMenu

Cockpit client (features), v0.8. Source: ui/client/features/auth/hooks/useUserMenu.tsx.

Functions#

useUserMenu()#

useUserMenu(): object

Defined in: ui/client/features/auth/hooks/useUserMenu.tsx:11

Everything the top bar's account chip needs: whether to show one at all, how to label it, and the open/close + sign-out actions. Keeps UserMenuController a pure wiring layer (CONTROLLER-001).

Returns#

object

close

close: () => void

Returns

void

handleSignOut

handleSignOut: () => void

Returns

void

initial

initial: string

label

label: string

open

open: boolean

toggle

toggle: () => void

Returns

void

user

user: AuthUser | null

visible

visible: boolean