AttributeElementCreatorFunction (engine/conversion)

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

typedeffunction

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

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Parameters

attributeValue : any

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.attributeKey : string: Attribute key.
data.attributeNewValue : unknown: New attribute value.
data.attributeOldValue : unknown: Attribute value before the change. This is null when selection attribute is converted.
data.item : Item | Selection | DocumentSelection: Changed item or converted selection.
data.range : Range: Range spanning over changed item or selection range.

Returns

AttributeElement | null: The view attribute element.

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.