Line

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

ui/client/features/directory-browser/workflows/DirectoryBrowser

Cockpit client (features), next. Source: ui/client/features/directory-browser/workflows/DirectoryBrowser.tsx.

Type Aliases#

DirectoryBrowserAction#

DirectoryBrowserAction = { type: "LOAD_START"; } | { listing: DirListingView; type: "LOADED"; } | { error: string; type: "LOAD_ERROR"; }

Defined in: ui/client/features/directory-browser/workflows/DirectoryBrowser.tsx:12


DirectoryBrowserState#

DirectoryBrowserState = { status: "idle"; } | { listing: DirListingView | null; status: "loading"; } | { error: string; listing: DirListingView | null; status: "error"; } | { listing: DirListingView; status: "ready"; }

Defined in: ui/client/features/directory-browser/workflows/DirectoryBrowser.tsx:6

Variables#

initialDirectoryBrowserState#

const initialDirectoryBrowserState: DirectoryBrowserState

Defined in: ui/client/features/directory-browser/workflows/DirectoryBrowser.tsx:17

Functions#

directoryBrowserReducer()#

directoryBrowserReducer(state, action): DirectoryBrowserState

Defined in: ui/client/features/directory-browser/workflows/DirectoryBrowser.tsx:29

Parameters#

state

DirectoryBrowserState

action

DirectoryBrowserAction

Returns#

DirectoryBrowserState


directoryError()#

directoryError(state): string | null

Defined in: ui/client/features/directory-browser/workflows/DirectoryBrowser.tsx:27

The failure of the last read; null when there is none.

Parameters#

state

DirectoryBrowserState

Returns#

string | null


directoryIsLoading()#

directoryIsLoading(state): boolean

Defined in: ui/client/features/directory-browser/workflows/DirectoryBrowser.tsx:24

True while a read is in flight.

Parameters#

state

DirectoryBrowserState

Returns#

boolean


directoryListing()#

directoryListing(state): DirListingView | null

Defined in: ui/client/features/directory-browser/workflows/DirectoryBrowser.tsx:20

The listing to show: the current one, or the last good one while loading or after a failure.

Parameters#

state

DirectoryBrowserState

Returns#

DirListingView | null