ui/client/features/component-docs/hooks/useComponentDoc

Cockpit client (features), v0.8. Source: ui/client/features/component-docs/hooks/useComponentDoc.tsx.

Functions#

useComponentDoc()#

useComponentDoc(path, revision): object

Defined in: ui/client/features/component-docs/hooks/useComponentDoc.tsx:9

The props of one component (react-docgen through the server), reloaded when revision changes (after a save). null while loading or with nothing selected. A network failure is an ok:false answer, never a throw.

Parameters#

path

string | null

revision

number

Returns#

object

description

description: DescribeResponse | null

loading

loading: boolean