ui/client/features/directory-browser/hooks/useDirectoryBrowser

Cockpit client (features), v0.8. Source: ui/client/features/directory-browser/hooks/useDirectoryBrowser.tsx.

Functions#

useDirectoryBrowser()#

useDirectoryBrowser(initialPath?): object

Defined in: ui/client/features/directory-browser/hooks/useDirectoryBrowser.tsx:9

Drives the folder picker: navigate, up, toggle hidden folders and page through large directories on top of the loader.

Parameters#

initialPath?

string

Returns#

object

error

error: string | null

goUp

goUp: () => void

Returns

void

listing

listing: DirListingView | null

loading

loading: boolean

loadMore

loadMore: () => Promise<void>

Returns

Promise<void>

navigate

navigate: (path?) => Promise<DirListingView | null>

Parameters

path?

string

Returns

Promise<DirListingView | null>

showHidden

showHidden: boolean

toggleHidden

toggleHidden: (value) => void

Parameters

value

boolean

Returns

void