CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Typedef

HeadingOption (heading)

@ckeditor/ckeditor5-heading/src/heading

typedef
Object
See source

Heading option descriptor.

Filtering

Properties

  • class : String

    The class which will be added to the dropdown item representing this option.

  • inherited

    converterPriority : PriorityString | undefined

    The converter priority.

  • icon : String | undefined

    Icon used by HeadingButtonsUI. It can be omitted when using the default configuration.

  • model : String

    Name of the model element to convert.

  • title : String

    The user-readable title of the option.

  • inherited

    upcastAlso : MatcherPattern | Array.<MatcherPattern> | undefined

    Any view element matching upcastAlso will also be converted to the model. If model describes multiple values, upcastAlso is an object that assigns these values (upcastAlso object keys) to MatcherPatterns (upcastAlso object values).

  • view : ElementDefinition

    Definition of a view element to convert from/to.