editor
Actions for managing the editor app state, including changing, saving, closing, and creating notes, as well as changing the view mode.
Change Action
Flag the editing note as changed, indicating it needs to be saved.
- Name
needsUpdatingDate
- Type
- boolean
- Required
- Description
Whether the note's
updatedAt
field needs to be updated or not.
Set the Editor State as 'Changed'
If you manipulated the note data and want the app to save it:
import { actions } from 'inkdrop'
inkdrop.store.dispatch(actions.editor.change(true))
Save Action
Save the currently editing note.
Do not use this action in your plugin. Use core:save-note
command instead.
- Name
save
- Type
- function
- Description
Saves the editing note.
Close Action
Close the editing note. The changes in the note will be saved.
Create Action
Create a new note and open it.
Do not use this action in your plugin. Use core:new-note
command instead.
Change View Mode Action
Change the editor view mode.
Do not use this action in your plugin. Use view:toggle-preview
command or view:toggle-side-by-side
instead.
- Name
viewMode
- Type
- string
- Required
- Description
The editor view mode.