API Reference

v3.1.4

K

Event Callbacks

Editor Instance

Main Methods

Core ($) ↓

$ (Core)

400

Core (L1)

facade

Config (L2)

contextProvider

optionProvider

instanceCheck

eventManager

Accessors (L2)

frameRoots

context

frameContext

options

frameOptions

icons

lang

DOM (L3)

offset

selection

format

inline

listFormat

html

nodeTransform

char

Shell (L3)

component

focusManager

pluginManager

commandDispatcher

history

shortcuts

Panel (L3)

toolbar

viewer

finder

constructor

documentType

$.store

Methods

State

Mode

$.plugins

200

Command

Dropdown

Field

Input

Modal

Popup

Plugin Interfacesextends

Plugin Hooksimplements

Modules

Browser

Color Picker

Controller

Figure

Hue Slider

Modal

Api Manager

File Manager

Modal Anchor Editor

Select Menu

Helper Utilities

132

Clipboard

Converter

Env

Key Code Map

Markdown

Ms Office

Numbers

Unicode

Dom Check

Dom Query

Dom Utils

Internals

Type Definitions

158

Editor Instance - Main Methods

Main editor methods (editor.method())

The editor instance contains the Core ($), the internal engine that powers all subsystems. Access it via editor.$ — e.g. editor.$.store, editor.$.selection, editor.$.format, etc.

4 methodsPrefix: editor.

isEmpty

(fc?: SunEditor.FrameContext | null)

Parameters

fcoptionalFrame context, if not present, currently selected frame context.

Returns

boolean

Checks if the content of the editor is empty.

•Display criteria for placeholder.

resetOptions

(newOptions: SunEditor.InitOptions)

Parameters

newOptionsOptions

Returns

void

Add or reset option property (Editor is reloaded)

Example

// Change toolbar buttons and height
editor.resetOptions({
buttonList: [['bold', 'italic'], ['image']],
height: '500px',
});

changeFrameContext

(rootKey: any)

Parameters

rootKeyRoot frame key.

Returns

void

Change the current root index.

Example

// Switch to the 'body' frame in a multi-root editor
editor.changeFrameContext('body');
// Switch back to the 'header' frame
editor.changeFrameContext('header');

destroy

Returns

any

Destroy the suneditor

API Documentation | SunEditor