Class Editor

eventEmitter

setTheme

• setTheme(theme: string): void

  light, dark or a custom theme, styled through the uf-{theme} class

  Parameters

  • theme: string

  Returns void

changePreviewStyle

• changePreviewStyle(style: PreviewStyle): void

  Parameters

  • style: PreviewStyle

  Returns void

exec

• exec(name: string, payload?: Record<string, any>): void

  Runs a command in the current mode.

  Parameters

  • name: string
  • Optionalpayload: Record<string, any>

  Returns void

addCommand

• addCommand(type: EditorType, name: string, command: CommandFn): void

  Parameters

  • type: EditorType
  • name: string
  • command: CommandFn

  Returns void

on

• on(type: EventName, handler: Handler): void

  Parameters

  • type: EventName
  • handler: Handler

  Returns void

off

• off(type: EventName): void

  Removes all the handlers of an event.

  Parameters

  • type: EventName

  Returns void

addHook

• addHook(type: string, handler: Handler): void

  Replaces the handler of a hook, like addImageBlobHook.

  Parameters

  • type: string
  • handler: Handler

  Returns void

removeHook

• removeHook(type: string): void

  Parameters

  • type: string

  Returns void

focus

• focus(): void

  Returns void

blur

• blur(): void

  Returns void

moveCursorToEnd

• moveCursorToEnd(focus?: boolean): void

  Parameters

  • focus: boolean = true

  Returns void

moveCursorToStart

• moveCursorToStart(focus?: boolean): void

  Parameters

  • focus: boolean = true

  Returns void

moveCursorTo

• moveCursorTo(line: number, focus?: boolean): void

  Moves the cursor to the start of a line (1-based); in WYSIWYG, each text block, table row and code line is a line.

  Parameters

  • line: number
  • focus: boolean = true

  Returns void

getCursorLine

• getCursorLine(): number

  The cursor's line (1-based), counted as in moveCursorTo().

  Returns number

getCurrentToolbarState

• getCurrentToolbarState(): ToolbarStateMap

  Returns ToolbarStateMap

setMarkdown

• setMarkdown(markdown?: string, cursorToEnd?: boolean, focus?: boolean): void

  focus applies when the cursor moves to the end.

  Parameters

  • markdown: string = ''
  • cursorToEnd: boolean = true
  • focus: boolean = true

  Returns void

setHTML

• setHTML(html?: string, cursorToEnd?: boolean, focus?: boolean): void

  Sets the content from HTML, converted to markdown; focus applies when the cursor moves to the end.

  Parameters

  • html: string = ''
  • cursorToEnd: boolean = true
  • focus: boolean = true

  Returns void

getMarkdown

• getMarkdown(): string

  Returns string

getHTML

• getHTML(): string

  The content as HTML, sanitized, with widgets as they render outside the WYSIWYG editor.

  Returns string

insertText

• insertText(text: string): void

  Parameters

  • text: string

  Returns void

setSelection

• setSelection(start: EditorPos, end?: EditorPos): void

  Parameters

  • start: EditorPos
  • Optionalend: EditorPos

  Returns void

replaceSelection

• replaceSelection(text: string, start?: EditorPos, end?: EditorPos): void

  Replaces the selection, or the given range, with the text.

  Parameters

  • text: string
  • Optionalstart: EditorPos
  • Optionalend: EditorPos

  Returns void

deleteSelection

• deleteSelection(start?: EditorPos, end?: EditorPos): void

  Deletes the selection, or the given range.

  Parameters

  • Optionalstart: EditorPos
  • Optionalend: EditorPos

  Returns void

getSelectedText

• getSelectedText(start?: EditorPos, end?: EditorPos): string

  The text of the selection, or of the given range.

  Parameters

  • Optionalstart: EditorPos
  • Optionalend: EditorPos

  Returns string

getRangeInfoOfNode

• getRangeInfoOfNode(pos?: EditorPos): NodeRangeInfo

  The range and type of the node at the position, or at the cursor.

  Parameters

  • Optionalpos: EditorPos

  Returns NodeRangeInfo

addWidget

• addWidget(node: Node, style: WidgetStyle, pos?: EditorPos): void

  Shows an element above or below the cursor, or the given position, like a popup.

  Parameters

  • node: Node
  • style: WidgetStyle
  • Optionalpos: EditorPos

  Returns void

replaceWithWidget

• replaceWithWidget(start: EditorPos, end: EditorPos, text: string): void

  Replaces the range with text that the widget rules show as a widget.

  Parameters

  • start: EditorPos
  • end: EditorPos
  • text: string

  Returns void

setHeight

• setHeight(height: string): void

  CSS height, toolbar included, e.g. 300px, 100% or auto

  Parameters

  • height: string

  Returns void

getHeight

• getHeight(): string

  Returns string

setMinHeight

• setMinHeight(minHeight: string): void

  CSS min-height, e.g. 200px

  Parameters

  • minHeight: string

  Returns void

getMinHeight

• getMinHeight(): string

  Returns string

isMarkdownMode

• isMarkdownMode(): boolean

  Returns boolean

isWysiwygMode

• isWysiwygMode(): boolean

  Returns boolean

isViewer

• isViewer(): boolean

  Returns boolean

getCurrentPreviewStyle

• getCurrentPreviewStyle(): PreviewStyle

  Returns PreviewStyle

changeMode

• changeMode(mode: EditorType, withoutFocus?: boolean): void

  Parameters

  • mode: EditorType
  • OptionalwithoutFocus: boolean

  Returns void

hide

• hide(): void

  Returns void

show

• show(): void

  Returns void

setScrollTop

• setScrollTop(value: number): void

  Scrolls the current mode's editing area.

  Parameters

  • value: number

  Returns void

getScrollTop

• getScrollTop(): number

  Returns number

reset

• reset(): void

  Clears the content.

  Returns void

getSelection

• getSelection(): SelectionPos

  Returns SelectionPos

setPlaceholder

• setPlaceholder(placeholder: string): void

  Parameters

  • placeholder: string

  Returns void

getEditorElements

• getEditorElements(): Slots

  The elements an application places in the page when it uses EditorCore without the default UI.

  Returns Slots

convertPosToMatchEditorMode

• convertPosToMatchEditorMode(
      start: EditorPos,
      end?: EditorPos,
      mode?: EditorType,
  ): EditorPos[]

  Converts a position from one mode's format to the other's.

  Parameters

  • start: EditorPos
  • end: EditorPos = start
  • mode: EditorType = ...

  Returns EditorPos[]

StaticsetLanguage

• setLanguage(code: string | string[], data: Record<string, string>): void

  Registers the UI texts of a language under its codes.

  Parameters

  • code: string | string[]
  • data: Record<string, string>

  Returns void