ui/client/features/component-docs/domain/ComponentList
Pure (DOMAIN-001): what the Components screen lists and what it says about one component.
Cockpit client (features), next. Source: ui/client/features/component-docs/domain/ComponentList.ts.
Functions#
docReason()#
docReason(
response):string|null
Defined in: ui/client/features/component-docs/domain/ComponentList.ts:32
Why no props are shown, when the reader gave a specific reason (a syntax error, a huge file): one plain sentence, or null.
Parameters#
response
DescribeResponse | null
Returns#
string | null
docView()#
docView(
response):DocView|null
Defined in: ui/client/features/component-docs/domain/ComponentList.ts:19
Props table, "no docs" note or a reader failure: the three things the doc panel can say.
Parameters#
response
DescribeResponse | null
Returns#
DocView | null
findComponent()#
findComponent(
entries,path):ComponentEntry|null
Defined in: ui/client/features/component-docs/domain/ComponentList.ts:14
The entry for a path only when it is in the list (a stale or hand-edited ?component= selects nothing).
Parameters#
entries
path
string | null
Returns#
ComponentEntry | null
toListItems()#
toListItems(
entries):object[]
Defined in: ui/client/features/component-docs/domain/ComponentList.ts:5
A list row: the file's name, and where it lives ("billing · features/billing/components/BillingView.tsx").
Parameters#
entries
Returns#
object[]