CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

DataSchemaInlineElementDefinition (html-support)

@ckeditor/ckeditor5-html-support/src/dataschema

interface
See source

A definition of data schema for inline elements.

Filtering

Properties

  • allowEmpty : boolean | undefined

    See source

    Indicates that an element should be preserved even if it has no content.

  • appliesToBlock : string | boolean | undefined

    See source

    Indicates that element should not be converted as a model text attribute. It is used to map view elements that do not have a separate model element but their data is stored in a model attribute. For example <tbody> element does not have a dedicated model element and GHS stores attributes of <tbody> in the htmlTbodyAttributes model attribute of the table model element.

  • attributeProperties : AttributeProperties | undefined

    See source

    Additional metadata describing the model attribute.

  • coupledAttribute : string | undefined

    See source

    The name of the model attribute that generates the same view element. GHS inline attribute will be removed from the model tree as soon as the coupled attribute is removed. See GHS post-fixer for more details.

  • inherited

    isBlock : boolean | undefined

    See source

    Indicates that the definition describes block element. Set by registerBlockElement method.

  • inherited

    isInline : boolean | undefined

    See source

    Indicates that the definition describes inline element.

  • inherited

    isObject : boolean | undefined

    See source

    Indicates that the definition describes object element.

  • inherited

    model : string

    See source

    Name of the model.

  • inherited

    modelSchema : SchemaItemDefinition | undefined

    See source

    The model schema item definition describing registered model.

  • priority : number | undefined

    See source

    Element priority. Decides in what order elements are wrapped by DowncastWriter. Set by registerInlineElement method.

  • inherited

    view : string | undefined

    See source

    Name of the view element.