Line

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

ui/client/features/component-docs/pages/ComponentsPage

Cockpit client (features), next. Source: ui/client/features/component-docs/pages/ComponentsPage.tsx.

Functions#

ComponentsPage()#

ComponentsPage(__namedParameters): Element

Defined in: ui/client/features/component-docs/pages/ComponentsPage.tsx:21

The stage of the Components screen: documentation for the chosen component, its isolated view (State switcher + Flow inset, ), what uses it, then its file as plain text. The list is in the Browser pane (registered by the controller).

Props#

Prop Type Required Default Description
hasSelection boolean Yes — What the stage shows: null = nothing selected.
staleName `string null` Yes —
onClearStale () => void Yes —
listReady boolean Yes — Where the project has no components at all.
doc ReactNode Yes —
isolated ReactNode Yes —
usedBy ReactNode Yes —
source ReactNode Yes —

Returns#

Element