ElementObjectDefinition (engine/view)
@ckeditor/ckeditor5-engine/src/view/elementdefinition
A plain object that describes a view element in a way that a concrete, exact view element could be created from that description.
const viewDefinition = {
name: 'h1',
classes: [ 'foo', 'bar' ]
};
Above describes a view element:
<h1 class="foo bar"></h1>
An example with styles and attributes:
const viewDefinition = {
name: 'span',
styles: {
'font-size': '12px',
'font-weight': 'bold'
},
attributes: {
'data-id': '123'
}
};
Describes:
<span style="font-size:12px;font-weight:bold" data-id="123"></span>
Filtering
Properties
-
attributes : Record<string, string> | undefined
module:engine/view/elementdefinition~ElementObjectDefinition#attributes
Object with key-value pairs representing attributes. Each object key represents attribute name. Value under that key must be a string.
-
classes : ArrayOrItem<string> | undefined
module:engine/view/elementdefinition~ElementObjectDefinition#classes
Class name or array of class names to match. Each name can be provided in a form of string.
-
name : string
module:engine/view/elementdefinition~ElementObjectDefinition#name
View element name.
-
priority : number | undefined
module:engine/view/elementdefinition~ElementObjectDefinition#priority
Element's priority.
-
styles : Record<string, string> | undefined
module:engine/view/elementdefinition~ElementObjectDefinition#styles
Object with key-value pairs representing styles. Each object key represents style name. Value under that key must be a string.
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.