CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Typedef

AttributeCreatorFunction (engine/conversion)

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

typedef
function
See source

A function that takes the model attribute value and downcast conversion API as parameters.

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

Object | null

A { key, value } object. If key is 'class', value can be a String or an array of Strings. If key is 'style', value is an object with key-value pairs. In other cases, value is a String.

Related: