ui/client/features/dashboard/hooks/useDashboard

Cockpit client (features), v0.8. Source: ui/client/features/dashboard/hooks/useDashboard.tsx.

Functions#

useDashboard()#

useDashboard(): object

Defined in: ui/client/features/dashboard/hooks/useDashboard.tsx:114

Composes the Dashboard's four independent command forms — one hook per form (kept in this same file rather than four separate files since each is a small, private implementation detail of the Dashboard feature, not something any other feature or route needs on its own).

Returns#

object

create

create: object

create.allLayers

allLayers: readonly ["domain", "service", "workflow", "hook", "component", "page", "controller"] = LAYERS

create.busy

busy: boolean

create.feature

feature: string

create.kind

kind: string

create.layer

layer: string

create.layers

layers: string[]

create.name

name: string

create.result

result: CommandResult | null

create.run

run: (e) => Promise<void>

Parameters

e

FormEvent

Returns

Promise<void>

create.setFeature

setFeature: Dispatch<SetStateAction<string>>

create.setKind

setKind: Dispatch<SetStateAction<string>>

create.setLayer

setLayer: Dispatch<SetStateAction<string>>

create.setName

setName: Dispatch<SetStateAction<string>>

create.setUseLlm

setUseLlm: Dispatch<SetStateAction<boolean>>

create.toggleLayer

toggleLayer: (l) => void

Parameters

l

string

Returns

void

create.useLlm

useLlm: boolean

create.visibility

visibility: object

create.visibility.feature

feature: boolean

create.visibility.layer

layer: boolean

create.visibility.layers

layers: boolean

create.visibility.llm

llm: boolean

importForm

importForm: object

importForm.allLayers

allLayers: readonly ["domain", "service", "workflow", "hook", "component", "page", "controller"] = LAYERS

importForm.busy

busy: boolean

importForm.feature

feature: string

importForm.from

from: string

importForm.layers

layers: string[]

importForm.mode

mode: string

importForm.name

name: string

importForm.planPath

planPath: string

importForm.result

result: CommandResult | null

importForm.run

run: (e) => Promise<void>

Parameters

e

FormEvent

Returns

Promise<void>

importForm.setFeature

setFeature: Dispatch<SetStateAction<string>>

importForm.setFrom

setFrom: Dispatch<SetStateAction<string>>

importForm.setMode

setMode: Dispatch<SetStateAction<string>>

importForm.setName

setName: Dispatch<SetStateAction<string>>

importForm.setPlanPath

setPlanPath: Dispatch<SetStateAction<string>>

importForm.setUseLlm

setUseLlm: Dispatch<SetStateAction<boolean>>

importForm.toggleLayer

toggleLayer: (l) => void

Parameters

l

string

Returns

void

importForm.useLlm

useLlm: boolean

importForm.visibility

visibility: object

importForm.visibility.plan

plan: boolean

importForm.visibility.unit

unit: boolean

refactor

refactor: object

refactor.action

action: string

refactor.allLayers

allLayers: readonly ["domain", "service", "workflow", "hook", "component", "page", "controller"] = LAYERS

refactor.busy

busy: boolean

refactor.feature

feature: string

refactor.from

from: string

refactor.layer

layer: string

refactor.name

name: string

refactor.newName

newName: string

refactor.result

result: CommandResult | null

refactor.run

run: (e) => Promise<void>

Parameters

e

FormEvent

Returns

Promise<void>

refactor.setAction

setAction: Dispatch<SetStateAction<string>>

refactor.setFeature

setFeature: Dispatch<SetStateAction<string>>

refactor.setFrom

setFrom: Dispatch<SetStateAction<string>>

refactor.setLayer

setLayer: Dispatch<SetStateAction<string>>

refactor.setName

setName: Dispatch<SetStateAction<string>>

refactor.setNewName

setNewName: Dispatch<SetStateAction<string>>

refactor.setTo

setTo: Dispatch<SetStateAction<string>>

refactor.to

to: string

refactor.visibility

visibility: object

refactor.visibility.move

move: boolean

refactor.visibility.rename

rename: boolean

research

research: object

research.action

action: string

research.busy

busy: boolean

research.feature

feature: string

research.format

format: string

research.result

result: CommandResult | null

research.run

run: (e) => Promise<void>

Parameters

e

FormEvent

Returns

Promise<void>

research.setAction

setAction: Dispatch<SetStateAction<string>>

research.setFeature

setFeature: Dispatch<SetStateAction<string>>

research.setFormat

setFormat: Dispatch<SetStateAction<string>>

research.setSince

setSince: Dispatch<SetStateAction<string>>

research.since

since: string

research.visibility

visibility: object

research.visibility.summarize

summarize: boolean