`@stesura/core/commands`

Document mutations, as ProseMirror Commands or factories that return one, plus a few related predicates and builders. Run a command with command(view.state, view.dispatch, view); call it without dispatch to check whether it applies (for a toolbar’s enabled state) without changing anything. Group commands into one undo step with composeCommands, or all-or-nothing with sequenceCommands.

Core

`clearFormatting`

Parameters:

Name	Type	Default
`options`	`ClearFormattingOptions`

Returns:

Command

`composeCommands`

Parameters:

Name	Type	Default
`commands`	`Command[]`

Returns:

Command

`deleteNode`

Parameters:

Name	Type	Default
`pos`	`number`

Returns:

Command

`insertContent`

Parameters:

Name	Type	Default
`value`	`string \| JSONContent \| JSONContent[] \| Node \| Fragment`

Returns:

Command

`insertOrWrapNode`

Parameters:

Name	Type	Default
`nodeName`	`string`
`attributes`	`Attrs`

Returns:

Command

`insertSymbol`

Parameters:

Name	Type	Default
`symbol`	`string`

Returns:

Command

`resetAttributes`

Parameters:

Name	Type	Default
`__0`	`{ attributes: string \| string[]; typeOrName: string \| NodeType \| MarkType; }`

Returns:

Command

`sequenceCommands`

Parameters:

Name	Type	Default
`commands`	`Command[]`

Returns:

Command

`setMark`

Parameters:

Name	Type	Default
`typeOrName`	`string \| MarkType`
`attributes`	`Attrs`

Returns:

Command

`setNode`

Parameters:

Name	Type	Default
`typeOrName`	`string \| NodeType`
`attributes`	`{}`

Returns:

Command

`toggleHeading`

Parameters:

Name	Type	Default
`level`	`number`

Returns:

Command

`toggleMark`

Parameters:

Name	Type	Default
`markType`	`MarkType`
`attrs`	`Attrs`
`options`	`ToggleMarkOptions`

Returns:

Command

`toggleMarkOnEntireWord`

Parameters:

Name	Type	Default
`markName`	`string`
`attrs`	`Attrs`

Returns:

Command

`toggleNode`

Parameters:

Name	Type	Default
`typeOrName`	`string \| NodeType`
`toggleTypeOrName`	`string \| NodeType`
`attributes`	`{}`

Returns:

Command

`unsetMark`

Parameters:

Name	Type	Default
`typeOrName`	`string \| MarkType`
`options`	`{ extendEmptyMarkRange?: boolean; }`

Returns:

Command

`updateAttributeAt`

Parameters:

Name	Type	Default
`__0`	`{ attribute: string; value: unknown; pos: number; type?: string \| NodeType; }`

Returns:

Command

`updateAttributes`

Parameters:

Name	Type	Default
`__0`	`UpdateAttributesProps`

Returns:

Command

Borders

`insertHorizontalRule`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`setBorders`

Parameters:

Name	Type	Default
`borders`	`Borders`

Returns:

Command

`toggleOutline`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

Code Block

`insertCodeBlock`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`splitCodeBlock`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`updateCodeBlockAttrs`

Parameters:

Name	Type	Default
`attribute`	`keyof CodeBlockAttrs`
`value`	`unknown`
`pos`	`number`

Returns:

Command

Document Attributes

`setDocAttr`

Parameters:

Name	Type	Default
`attr`	`K`
`value`	`DocAttrs[K]`

Returns:

Command

`setDocBgColor`

Parameters:

Name	Type	Default
`color`	`string`

Returns:

Command

`setDocDirection`

Parameters:

Name	Type	Default
`dir`	`TextDirection`

Returns:

Command

File

`applyFileNodeMove`

Parameters:

Name	Type	Default
`tr`	`Transaction`
`pos`	`number`
`direction`	`1 \| -1`

Returns:

number | null

`insertFileUpload`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`moveFileNode`

Parameters:

Name	Type	Default
`pos`	`number`
`direction`	`1 \| -1`

Returns:

Command

`rotateFile`

Parameters:

Name	Type	Default
`pos`	`number`
`delta`	`number`

Returns:

Command

`setFileDisplayPreview`

Parameters:

Name	Type	Default
`pos`	`number`
`displayPreview`	`boolean`

Returns:

Command

`setFileRotation`

Parameters:

Name	Type	Default
`pos`	`number`
`rotation`	`number`

Returns:

Command

Format Painter

`applyFormatPainter`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`disableFormatPainter`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`enableFormatPainter`

Parameters:

Name	Type	Default
`__0`	`{ once: boolean; }` Disarm after the first applyFormatPainter ; false keeps it armed until disableFormatPainter .

Returns:

Command

Formatting

`alignJustifyLeftOnly`

Parameters:

This function does not accept any parameters.

Returns:

Command

`alignJustifyLeftRight`

Parameters:

This function does not accept any parameters.

Returns:

Command

`incrementSpacing`

Parameters:

Name	Type	Default
`__0`	`{ position: "before" \| "after"; value: number; }`

Returns:

Command

`indent`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`outdent`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`resetAlignment`

Parameters:

Name	Type	Default
`ids`	`string[]`

Returns:

Command

`resetIndent`

Parameters:

Name	Type	Default
`ids`	`string[]`

Returns:

Command

`resetLineHeight`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`resetPagination`

Parameters:

This function does not accept any parameters.

Returns:

Command

`resetSpacing`

Parameters:

Name	Type	Default
`ids`	`string[]`

Returns:

Command

`setDirection`

Parameters:

Name	Type	Default
`dir`	`TextDirection`

Returns:

Command

`setFormatting`

Parameters:

Name	Type	Default
`formatting`	`FormattingUpdate`

Returns:

Command

`setLineHeight`

Parameters:

Name	Type	Default
`lineHeight`	`number`

Returns:

Command

`setPaginationAttrs`

Parameters:

Name	Type	Default
`partial`	`PaginationAttrs`

Returns:

Command

`setSpacing`

Parameters:

Name	Type	Default
`spacing`	`SpacingAttrs`

Returns:

Command

`setSpacingBeforeAfter`

Parameters:

Name	Type	Default
`__0`	`{ position: "before" \| "after"; value: number; }`

Returns:

Command

`setTextAlign`

Parameters:

Name	Type	Default
`align`	`TextAlignType`

Returns:

Command

`setTextAlignOnlyOn`

Parameters:

Name	Type	Default
`__0`	`{ applyOnAlignments: string[]; newAlignment: string; }`

Returns:

Command

`toggleDirection`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

Header / Footer

`deleteHeaderFooterContent`

Parameters:

Name	Type	Default
`sectionId`	`string`
`variant`	`HeaderFooterVariant`

Returns:

Command

`fixHeadersFooters`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`insertHeaderFooterContent`

Parameters:

Name	Type	Default
`sectionId`	`string`
`variant`	`HeaderFooterVariant`

Returns:

Command

`insertPageNumberPreset`

Parameters:

Name	Type	Default
`__0`	`{ sectionId: string; variant?: HeaderFooterVariant; position: PageNumberPresetPosition; pageType?: PageNumberType; }`

Returns:

Command

`PageNumberPresetPosition`

Name	Type	Default
`vertical`	`"top" \| "bottom"`
`horizontal`	`"left" \| "center" \| "right"`

Highlight

`disableHighlight`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`enableHighlight`

Parameters:

Name	Type	Default
`color`	`string`

Returns:

Command

`setHighlight`

Parameters:

Name	Type	Default
`color`	`string`

Returns:

Command

`toggleHighlight`

Parameters:

Name	Type	Default
`color`	`string`

Returns:

Command

`unsetHighlight`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

History

`canRedo`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

boolean

`canUndo`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

boolean

`redo`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`undo`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

Images

`insertImageUpload`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`resetAspectRatio`

Parameters:

Name	Type	Default
`attrs`	`AspectRatioAttrs`

Returns:

Command

`resizeImage`

Parameters:

Name	Type	Default
`size`	`Size`

Returns:

Command

`setImageAlignment`

Parameters:

Name	Type	Default
`align`	`ImageAlign`

Returns:

Command

`setImageAlt`

Parameters:

Name	Type	Default
`__0`	`SetImageAltProps`

Returns:

Command

`setImageSide`

Parameters:

Name	Type	Default
`side`	`ImageAnchoredSide`

Returns:

Command

`setImageToFullWidth`

Parameters:

This function does not accept any parameters.

Returns:

Command

`setImageWrap`

Parameters:

Name	Type	Default
`wrap`	`ImageWrapMode`

Returns:

Command

Invisible Characters

`setInvisibleCharacters`

Parameters:

Name	Type	Default
`show`	`boolean`

Returns:

Command

`toggleInvisibleCharacters`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

Language

`setDocLanguage`

Parameters:

Name	Type	Default
`language`	`string`

Returns:

Command

`setLanguage`

Parameters:

Name	Type	Default
`language`	`string` The language code (e.g., “en-GB”, “en-US”, “fr-FR”), or `null` to drop the explicit stamp and follow the style/document language.

Returns:

Command

Links

`cancelPendingLink`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`removeLink`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`setLink`

Parameters:

Name	Type	Default
`url`	`string`

Returns:

Command

`setLinkUrl`

Parameters:

Name	Type	Default
`url`	`string`

Returns:

Command

`setPendingLink`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

Math

`insertMathDisplay`

Parameters:

Name	Type	Default
`initialText`	`string`

Returns:

Command

`insertMathInline`

Parameters:

Name	Type	Default
`initialText`	`string`

Returns:

Command

Marks (shortcuts)

`toggleBold`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`toggleCode`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`toggleItalic`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`toggleStrike`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`toggleSubscript`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`toggleSuperscript`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`toggleUnderline`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

Numbering

`adjustLevel`

Parameters:

Name	Type	Default
`props`	`AdjustLevelProps`

Returns:

Command

`AdjustLevelProps`

Name	Type	Default
`direction`	`"up" \| "down"`
`level`	`number`

`applyListRef`

Parameters:

Name	Type	Default
`listRef`	`string`

Returns:

Command

`cleanupUnusedListRefs`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`continueNumbering`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`removeListConfig`

Parameters:

Name	Type	Default
`reference`	`string` The listRef to remove.

Returns:

Command

`removeNumbering`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`restartNumbering`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`saveListConfigToDocAttrs`

Parameters:

Name	Type	Default
`reference`	`string`
`levels`	`ILevelsOptions[]`

Returns:

Command

`setFollowBy`

Parameters:

Name	Type	Default
`followBy`	`"tab" \| "space" \| "nothing"` What to place between the number and the text.

Returns:

Command

`setListTabStop`

Parameters:

Name	Type	Default
`tabStop`	`number` width of the counter cell in px; null removes the value.

Returns:

Command

`setNumberingAttrs`

Parameters:

Name	Type	Default
`newNumberingAttrs`	`Partial<NumberingAttrs>`

Returns:

Command

`toggleCounter`

Parameters:

Name	Type	Default
`props`	`ToggleCounterTrProps`

Returns:

Command

`updateNumbering`

Parameters:

Name	Type	Default
`props`	`UpdateNumberingProps`

Returns:

Command

Search

`clearSearchState`

Parameters:

This function does not accept any parameters.

Returns:

Command

`disableSearchState`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`enableSearchState`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`findNext`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`findNextNoWrap`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`findPrev`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`findPrevNoWrap`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`replaceAll`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`replaceCurrent`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`replaceNext`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`replaceNextNoWrap`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`toggleSearchState`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

Sections

`addSection`

Parameters:

This function does not accept any parameters.

Returns:

Command

`focusHeaderFooter`

Parameters:

Name	Type	Default
`focusOn`	`"header" \| "footer"`

Returns:

Command

`HeaderFooterDistanceOptions`

Name	Type	Default
`headerFromTop`	`number` Distance (px) from the top of the page to the header.
`footerFromBottom`	`number` Distance (px) from the bottom of the page to the footer.

`insertPageBreak`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`insertPageNumber`

Parameters:

Name	Type	Default
`__0`	`PageNumberAttrs`

Returns:

Command

`insertPageOfPage`

Parameters:

Name	Type	Default
`middleText`	`string` Separator word between the two fields, defaulting to “of”. A space is added on each side, so pass the bare word — ” of ” would render as “1 of 12”.

Returns:

Command

`lineNumbersSuppressed`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

boolean

`openFooter`

Parameters:

Name	Type	Default
`nodeId`	`string`

Returns:

Command

`openHeader`

Parameters:

Name	Type	Default
`nodeId`	`string`

Returns:

Command

`removeSection`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`removeSectionAt`

Parameters:

Name	Type	Default
`sectionPos`	`number`

Returns:

Command

`setHeaderFooterDistance`

Parameters:

Name	Type	Default
`options`	`HeaderFooterDistanceOptions`
`sectionId`	`string`

Returns:

Command

`setLineNumbers`

Parameters:

Name	Type	Default
`lineNumberNewAttrs`	`Partial<LineNumbersAttrs>`

Returns:

Command

`setOrientation`

Parameters:

Name	Type	Default
`orientation`	`"portrait" \| "landscape"`

Returns:

Command

`setSectionFormat`

Parameters:

Name	Type	Default
`options`	`SectionOptions`

Returns:

Command

`toggleLineNumbers`

Parameters:

This function does not accept any parameters.

Returns:

Command

`toggleSuppressLineNumbers`

Parameters:

Name	Type	Default
`suppress`	`boolean` Force a value instead of toggling.

Returns:

Command

Style Sheets

`createStyleDefinition`

Parameters:

Name	Type	Default
`styleId`	`string`
`styleDef`	`StyleDefinition`

Returns:

Command

`deleteStyleDefinition`

Parameters:

Name	Type	Default
`styleDefId`	`string`
`replaceWith`	`string`

Returns:

Command

`replaceStyleDefIds`

Parameters:

Name	Type	Default
`prevStyleDefId`	`string`
`newStyleDefId`	`string`

Returns:

Command

`setStyleNumberingBinding`

Parameters:

Name	Type	Default
`styleId`	`string`
`numbering`	`StyleNumbering`

Returns:

Command

`setStyleSheet`

Parameters:

Name	Type	Default
`styleSheetId`	`string`
`deleteMarks`	`true \| "sameStyle"`

Returns:

Command

`submitStyleDefChange`

Parameters:

Name	Type	Default
`currentStyleDefId`	`string`
`newStyleDefId`	`string`
`styleDef`	`StyleDefinition`

Returns:

Command

`updateStyleDefinition`

Parameters:

Name	Type	Default
`styleId`	`string`
`styleDef`	`Partial<StyleDefinition>`

Returns:

Command

`upsertStyleDefinition`

Parameters:

Name	Type	Default
`styleId`	`string`
`styleDef`	`Partial<StyleDefinition>`
`options`	`UpsertStyleDefinitionOptions` `falseIfExists` / `falseIfNotExists` turn the upsert into a create-only / update-only operation, returning false (with a warning) when the precondition fails. See createStyleDefinition and updateStyleDefinition. `replace` skips the merge and stores `styleDef` as the whole override — for callers that submit a complete definition and need omitted fields to mean “cleared” rather than “unchanged” (the stylesheet panel). Dependent styles are unaffected: they store no copies, the resolver walks basedOn on read.

Returns:

Command

Tables

`createTableNode`

Parameters:

Name	Type	Default
`state`	`EditorState`
`options`	`CreateTableOptions`

Returns:

Node | null

`deleteColumn`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`

Returns:

boolean

`deleteRow`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`deleteTable`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`deleteTableIfSelected`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`distributeColWidths`

Parameters:

Name	Type	Default
`widthInput`	`number`

Returns:

Command

`incrementTableSpacing`

Parameters:

Name	Type	Default
`__0`	`{ position: "before" \| "after"; value: number; }`

Returns:

Command

`insertColumnAfter`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`insertColumnBefore`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`insertRow`

Parameters:

Name	Type	Default
`__0`	`TableRect`
`row`	`number`
`copyRow`	`"bottom" \| "top"`
`updateSelection`	`boolean`

Returns:

TransactionFn

`insertRowAfter`

Parameters:

Name	Type	Default
`updateSelection`	`boolean`

Returns:

Command

`insertRowBefore`

Parameters:

Name	Type	Default
`updateSelection`	`boolean`

Returns:

Command

`insertTable`

Parameters:

Name	Type	Default
`__0`	`{ rows: number; cols: number; borders?: Borders \| null; }`

Returns:

Command

`mergeCells`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`selectEntireTable`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`selectEntireTableAtPos`

Parameters:

Name	Type	Default
`tablePos`	`number`

Returns:

Command

`setCellAlignment`

Parameters:

Name	Type	Default
`alignment`	`"top-start" \| "top-center" \| "top-end" \| "middle-start" \| "middle-center" \| "middle-end" \| "bottom-start" \| "bottom-center" \| "bottom-end"`

Returns:

Command

`setCellAttr`

Parameters:

Name	Type	Default
`name`	`string`
`value`	`unknown`
`returnTrueOnSameValue`	`boolean`

Returns:

Command

`setRowHeight`

Parameters:

Name	Type	Default
`height`	`number`

Returns:

Command

`setTableAlignment`

Parameters:

Name	Type	Default
`alignment`	`TableAlign`

Returns:

Command

`setTableSortOptions`

Parameters:

Name	Type	Default
`options`	`SortOptions`

Returns:

Command

`setTableSpacing`

Parameters:

Name	Type	Default
`spacing`	`SpacingAttrs`

Returns:

Command

`setTableSpacingBeforeAfter`

Parameters:

Name	Type	Default
`__0`	`{ position: "before" \| "after"; value: number; }`

Returns:

Command

`sortTableRows`

Parameters:

Name	Type	Default
`options`	`SortOptions`

Returns:

Command

`splitCell`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`

Returns:

boolean

`splitTable`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

Text Style

`changeCase`

Parameters:

Name	Type	Default
`mode`	`CaseChange`

Returns:

Command

`clearBackgroundColor`

Parameters:

This function does not accept any parameters.

Returns:

Command

`clearFontColor`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`cycleCase`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`incrementFontSize`

Parameters:

Name	Type	Default
`direction`	`"up" \| "down"`

Returns:

Command

`setBackgroundColor`

Parameters:

Name	Type	Default
`color`	`string`

Returns:

Command

`setCaps`

Parameters:

Name	Type	Default
`value`	`Caps`

Returns:

Command

`setFontColor`

Parameters:

Name	Type	Default
`color`	`string`

Returns:

Command

`setFontFamily`

Parameters:

Name	Type	Default
`font`	`string`

Returns:

Command

`setFontSize`

Parameters:

Name	Type	Default
`fontSize`	`number`

Returns:

Command

`insertTOC`

Parameters:

This function does not accept any parameters.

Returns:

Command

Escape

`hasEscapeConsumer`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

boolean

`registerEscapeConsumer`

Parameters:

Name	Type	Default
`rootEditorId`	`string`

Returns:

() => void