ui/client/features/shell/hooks/useShellTools

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

Type Aliases#

ShellToolsApi#

ShellToolsApi = object

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

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

Properties#

showTool

showTool: (id) => void

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

Parameters

id

string

Returns

void

Variables#

ShellToolsContext#

const ShellToolsContext: Context<ShellToolsApi>

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

Functions#

useShellTools()#

useShellTools(): ShellToolsApi

Defined in: ui/client/features/shell/hooks/useShellTools.tsx:15

Brings a tab of the Tools pane into view: opens the pane, selects the tab, and in the narrow one-pane layout shows the pane. A screen calls it when an action in another pane produced something that lives there (the Blocks tab's "Run this block" adds a step to the plan). A no-op outside the shell.

Returns#

ShellToolsApi