CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

DomWrapperView (mention/ui)

@ckeditor/ckeditor5-mention/src/ui/domwrapperview

class
See source

This class wraps DOM element as a CKEditor5 UI View.

It allows to render any DOM element and use it in mentions list.

Filtering

Properties

  • domElement : Element

    The DOM element for which wrapper was created.

    See source

  • isOn : Boolean

    observable

    Controls whether the dom wrapper view is "on". This is in line with isOn property.

    See source

    Defaults to true

Methods

  • constructor( [ locale ], domElement )

    Creates an instance of DomWrapperView class.

    See source

    Also see render.

    Parameters

    [ locale ] : Locale

    The localization services instance.

    domElement : Element

  • render()

Events

  • change:isOn( eventInfo, name, value, oldValue )

    Fired when the isOn property changed value.

    See source

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    Name of the changed property (isOn).

    value : Boolean

    New value of the isOn property with given key or null, if operation should remove property.

    oldValue : Boolean

    Old value of the isOn property with given key or null, if property was not set before.