CKEditor Ecosystem Documentation
Search
⚠️ WarningNightly documentation ahead. Switch to the stable editor documentation.
Home/CKEditor 5/API
Typedef

AttributeElementCreatorFunction (engine/conversion)

@ckeditor/ckeditor5-engine/src/conversion/downcasthelpers

typedef
function
See source

A view element creator function that takes the model attribute value and downcast conversion API as parameters and returns a view attribute element.

Filtering

Parameters

attributeValue : *

The model attribute value to be converted to the view attribute element.

conversionApi : DowncastConversionApi

The conversion interface.

data : Object

Additional information about the change (same as for attribute event).

Properties
data.item : Item | DocumentSelection

Changed item or converted selection.

data.range : Range

Range spanning over changed item or selection range.

data.attributeKey : String

Attribute key.

data.attributeOldValue : *

Attribute value before the change. This is null when selection attribute is converted.

data.attributeNewValue : *

New attribute value.

Returns

AttributeElement

The view attribute element.

Related: