ui/client/features/pages-editor/hooks/usePagesEditor

Cockpit client (features), v0.9. Source: ui/client/features/pages-editor/hooks/usePagesEditor.tsx.

Functions#

usePagesEditor()#

usePagesEditor(): object

Defined in: ui/client/features/pages-editor/hooks/usePagesEditor.tsx:23

Top-level browsing/tree/selection state for the pages editor — one feature -> one file -> a parsed JSX tree -> a selected node.

Returns#

object

allPages

allPages: object

allPages.error

error: string

allPages.pages

pages: object[]

allPages.reload

reload: () => void = load

Returns

void

allPages.status

status: "loading" | "ready" | "error"

dismissExternalChange

dismissExternalChange: () => void = external.dismiss

Returns

void

error

error: string | null

externalChange

externalChange: PageChange | null = external.change

feature

feature: string

features

features: string[]

file

file: string

files

files: string[]

filesLoading

filesLoading: boolean

livePreview

livePreview: object

livePreview.connect

connect: () => void

Returns

void

livePreview.connectTo

connectTo: (target) => void

Point the frame at an address the Cockpit itself was given (the dev server it started, #378).

Parameters

target

string

Returns

void

livePreview.disconnect

disconnect: () => void

Returns

void

livePreview.draft

draft: string

livePreview.frameRef

frameRef: RefObject<HTMLIFrameElement | null>

livePreview.fullScreen

fullScreen: boolean = full.fullScreen

livePreview.message

message: string | null

livePreview.release

release: (target) => void

Let go of target only if that is what the frame is showing: a server stopping must not close a URL the person typed.

Parameters

target

string

Returns

void

livePreview.setDraft

setDraft: Dispatch<SetStateAction<string>>

livePreview.url

url: string | null

livePreview.view

view: LivePreviewView

onTreeSaved

onTreeSaved: (tree) => void

Parameters

tree

PageTree

Returns

void

openFile

openFile: (f) => void

Parameters

f

string

Returns

void

openPageOf

openPageOf: (pageFeature, pageFile) => void

Parameters

pageFeature

string

pageFile

string

Returns

void

previewTitle

previewTitle: (node) => string

Parameters

node

PagesEditorNode

Returns

string

reloadFromDisk

reloadFromDisk: () => void = external.reload

Returns

void

selectedNode

selectedNode: PagesEditorNode | null

selectedNodeId

selectedNodeId: string | null

selectNode

selectNode: (nodeId) => void

Parameters

nodeId

string

Returns

void

setFeature

setFeature: (f) => void

Parameters

f

string

Returns

void

showAllPages

showAllPages: () => void

Returns

void

tree

tree: PageTree | null