ui/client/features/notes/hooks/useNoteActions

Cockpit client (features), v0.9. Source: ui/client/features/notes/hooks/useNoteActions.tsx.

Functions#

useNoteActions()#

useNoteActions(stateRef, send, save): object

Defined in: ui/client/features/notes/hooks/useNoteActions.tsx:9

Everything a person does on the Notes screen apart from typing: switch, create, duplicate, delete, and the way out of a stale write.

Parameters#

stateRef

MutableRefObject<ScreenState>

send

(a) => void

save

() => Promise<boolean>

Returns#

object

confirmDelete

confirmDelete: (on) => void

Parameters

on

boolean

Returns

void

create

create: () => Promise<void>

Returns

Promise<void>

duplicate

duplicate: () => Promise<void>

Returns

Promise<void>

edit

edit: (e) => void

Parameters

e

Partial<Draft>

Returns

void

flush

flush: () => Promise<boolean> = save

Returns

Promise<boolean>

keepMine

keepMine: () => void

Returns

void

loadTheirs

loadTheirs: () => void

Returns

void

open

open: (id) => Promise<void>

Parameters

id

string

Returns

Promise<void>

remove

remove: () => Promise<void>

Returns

Promise<void>

retry

retry: () => Promise<boolean> = save

Returns

Promise<boolean>

toggleCompare

toggleCompare: () => void

Returns

void