Home/CKEditor 5/API

ElementApi (core/editor/utils)

@ckeditor/ckeditor5-core/src/editor/utils/elementapimixin

interface

See source

Interface describing an editor that replaced a DOM element (was "initialized on an element").

Such an editor should provide a method to update the replaced element with the current data.

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

sourceElement : undefined | HTMLElement

See source
The element on which the editor has been initialized.

Methods

updateSourceElement( [ data ] ) → void

See source
Updates the editor source element's content with the data if the updateSourceElementOnDestroy configuration option is set to true.

Parameters

[ data ] : string

Data that the editor source element should be updated with.

Returns

void

Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.

With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.

ElementApi (core/editor/utils)

Filtering

Properties

`sourceElement : undefined | HTMLElement`

Methods

`updateSourceElement( [ data ] ) → void`

Parameters

Returns

ElementApi (core/editor/utils)

Filtering

Properties

sourceElement : undefined | HTMLElementmodule:core/editor/utils/elementapimixin~ElementApi#sourceElement

Methods

updateSourceElement( [ data ] ) → voidmodule:core/editor/utils/elementapimixin~ElementApi#updateSourceElement

Parameters

Returns

`sourceElement : undefined | HTMLElement`

`updateSourceElement( [ data ] ) → void`