Class EditorCommands

Constructors

constructor

new EditorCommands(editor: Editor): EditorCommands
Parameters
- editor: Editor
Returns EditorCommands
- Defined in packages/core/src/editor/editor.ts:512

Methods

clearAllFormatting

clearAllFormatting(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:567

clearBlockFormatting

clearBlockFormatting(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:563

clearFormatting

clearFormatting(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:559

continueNumbering

continueNumbering(start: number): boolean
Parameters
- start: number
Returns boolean
- Defined in packages/core/src/editor/editor.ts:669

continueNumberingFromPrevious

continueNumberingFromPrevious(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:673

convertCase

convertCase(mode: CaseMode): boolean
Rewrite the selected text to upper, lower or title case.
Parameters
- mode: CaseMode
Returns boolean
- Defined in packages/core/src/editor/editor.ts:595

deleteSelection

deleteSelection(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:518

indent

indent(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:599

insertHardBreak

insertHardBreak(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:631

insertHorizontalRule

insertHorizontalRule(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:635

insertText

insertText(text: string): boolean
Parameters
- text: string
Returns boolean
- Defined in packages/core/src/editor/editor.ts:514

joinBackward

joinBackward(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:627

lift

lift(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:693

liftListItem

liftListItem(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:685

outdent

outdent(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:603

redo

redo(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:705

restartNumbering

restartNumbering(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:665

selectAll

selectAll(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:697

setBackgroundColor

setBackgroundColor(color: string): boolean
Parameters
- color: string
Returns boolean
- Defined in packages/core/src/editor/editor.ts:547

setBlockAttrs

setBlockAttrs(attrs: Attrs): boolean
Parameters
- attrs: Attrs
Returns boolean
- Defined in packages/core/src/editor/editor.ts:607

setBlockType

setBlockType(name: string, attrs?: Readonly<Record<string, unknown>>): boolean
Parameters
- name: string
- Optionalattrs: Readonly<Record<string, unknown>>
Returns boolean
- Defined in packages/core/src/editor/editor.ts:611

setCodeBlock

setCodeBlock(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:689

setFontFamily

setFontFamily(family: string): boolean
Parameters
- family: string
Returns boolean
- Defined in packages/core/src/editor/editor.ts:535

setFontSize

setFontSize(size: string): boolean
Parameters
- size: string
Returns boolean
- Defined in packages/core/src/editor/editor.ts:539

setHeading

setHeading(level: number): boolean
Parameters
- level: number
Returns boolean
- Defined in packages/core/src/editor/editor.ts:619

setLetterSpacing

setLetterSpacing(spacing: string | null): boolean
Letter spacing on the selection; null removes it.
Parameters
- spacing: string | null
Returns boolean
- Defined in packages/core/src/editor/editor.ts:586

setLineHeight

setLineHeight(value: string | number | null): boolean
Line height on the selected blocks; a bare number is a multiplier.
Parameters
- value: string | number | null
Returns boolean
- Defined in packages/core/src/editor/editor.ts:576

setLink

setLink(href: string, title?: string): boolean
Parameters
- href: string
- Optionaltitle: string
Returns boolean
- Defined in packages/core/src/editor/editor.ts:551

setListStyle

setListStyle(style: string | null): boolean
Set the marker style of the list at the selection; null clears it.
Parameters
- style: string | null
Returns boolean
- Defined in packages/core/src/editor/editor.ts:661

setMark

setMark(name: string, attrs: Attrs): boolean
Apply a mark with attributes, replacing any existing one of its type.
Parameters
- name: string
- attrs: Attrs
Returns boolean
- Defined in packages/core/src/editor/editor.ts:527

setParagraph

setParagraph(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:615

setParagraphSpacing

setParagraphSpacing(
opts: { after?: string | null; before?: string | null },
): boolean
Space above and/or below the selected blocks.
Parameters
- opts: { after?: string | null; before?: string | null }
Returns boolean
- Defined in packages/core/src/editor/editor.ts:581

setTextAlign

setTextAlign(align: "left" | "center" | "right" | "justify" | null): boolean
Parameters
- align: "left" | "center" | "right" | "justify" | null
Returns boolean
- Defined in packages/core/src/editor/editor.ts:571

setTextColor

setTextColor(color: string): boolean
Parameters
- color: string
Returns boolean
- Defined in packages/core/src/editor/editor.ts:543

sinkListItem

sinkListItem(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:681

splitBlock

splitBlock(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:623

splitListItem

splitListItem(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:677

toggleBulletList

toggleBulletList(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:643

toggleMark

toggleMark(name: string, attrs?: Readonly<Record<string, unknown>>): boolean
Parameters
- name: string
- Optionalattrs: Readonly<Record<string, unknown>>
Returns boolean
- Defined in packages/core/src/editor/editor.ts:522

toggleOrderedList

toggleOrderedList(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:647

toggleSmallCaps

toggleSmallCaps(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:590

toggleTaskChecked

toggleTaskChecked(): boolean
Flip the done state of the task item holding the selection.

Returns boolean
- Defined in packages/core/src/editor/editor.ts:656

toggleTaskList

toggleTaskList(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:651

undo

undo(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:701

unsetLink

unsetLink(): boolean
Returns boolean
- Defined in packages/core/src/editor/editor.ts:555

unsetMark

unsetMark(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in packages/core/src/editor/editor.ts:531

wrapIn

wrapIn(name: string, attrs?: Readonly<Record<string, unknown>>): boolean
Parameters
- name: string
- Optionalattrs: Readonly<Record<string, unknown>>
Returns boolean
- Defined in packages/core/src/editor/editor.ts:639