ui/client/features/shell/hooks/useShellDrawer

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

Type Aliases#

ShellDrawerApi#

ShellDrawerApi = object

Defined in: ui/client/features/shell/hooks/useShellDrawer.tsx:6

What a screen may ask of the shell's drawer. Provided by the shell around every screen.

Properties#

openLogs

openLogs: () => void

Defined in: ui/client/features/shell/hooks/useShellDrawer.tsx:6

Returns

void

openProcesses

openProcesses: () => void

Defined in: ui/client/features/shell/hooks/useShellDrawer.tsx:6

Returns

void

Variables#

ShellDrawerContext#

const ShellDrawerContext: Context<ShellDrawerApi>

Defined in: ui/client/features/shell/hooks/useShellDrawer.tsx:10

Functions#

useShellDrawer()#

useShellDrawer(): ShellDrawerApi

Defined in: ui/client/features/shell/hooks/useShellDrawer.tsx:13

Lets a screen open the Processes or Logs tab of the drawer (for example after it starts a process, or to show a dev server's output). A no-op outside the shell.

Returns#

ShellDrawerApi