All documentation ↓← All docs

editor.delete()

Removes whatever is currently selected in the editor. With a range of text selected it deletes that text; with a control such as an image selected it removes the image. It is the programmatic equivalent of the user selecting content and pressing Delete.

Syntax

editor.delete()

Parameters

None.

Returns

Nothing (undefined).

Behavior notes

  • A selected control takes priority. If a control (an image, for instance) is selected,delete() removes that node and places the caret where it was, regardless of any text selection state.
  • A collapsed caret deletes nothing. When the selection is just a caret with no highlighted text, delete() is a no-op — it does not forward-delete the next character. Select a range first if you need content removed.
  • A text range is removed in place, collapsing the surrounding content together as expected.

Example usage

Select the whole document and clear it:

Code example
var editor1 = new RichTextEditor("#div_editor1");
editor1.setHTMLCode("<b>hello world</b>");
editor1.selectDoc();
editor1.delete();

Delete a specific control — select it first, then delete. Here the selected image is removed:

Code example
var img = editor1.getEditable().querySelector("img");
if (img) {
    editor1.selectControl(img);
    editor1.delete();
}

Related

Calling editor.delete() from your app

editor.delete() belongs to the editor instance. Every integration below works the same way: keep the object that new RichTextEditor(...) returns, and call it on that object.

Plain JavaScript

Code example
var editor1 = new RichTextEditor("#div_editor1");
// The constructor is synchronous: the editor is ready on the next line.
editor1.delete();

React and Next.js

Code example
// editorRef is filled by the RichTextEditor wrapper from the React guides.
const editorRef = useRef(null);

function onClick() {
  editorRef.current?.delete();
}

return <RichTextEditor editorRef={editorRef} />;

In Vue and Angular, the wrapper components in the guides keep the instance in a component variable (editor), so the call is the same. See the React, Vue and Angular pages, or download a tested project from the guides.

If the editor is undefined

  • The call ran before the component mounted. Call it from an event handler or after the mount effect has run.
  • In React development mode, Strict Mode mounts, unmounts and mounts again, so the wrapper sets editorRef.current to null in between. Use editorRef.current?. rather than storing the instance elsewhere.
  • The editor was destroyed (editor.destroy()) when its component unmounted.

All methods: method reference · all events: event reference.