TemplateBinding (ui)
@ckeditor/ckeditor5-ui/src/template
Describes a binding created by the bind
interface.
Filtering
Properties
-
The name of the observed attribute.
-
readonly
callback : ( any, Node ) => TemplateSimpleValue | undefined
module:ui/template~TemplateBinding#callback
A custom function to process the value of the
attribute
. -
An
Emitter
used by the binding to:- listen to the attribute change in the
observable
, - or listen to the event in the DOM.
- listen to the attribute change in the
-
An observable instance of the binding. It either:
- provides the attribute with the value,
- or passes the event when a corresponding DOM event is fired.
Methods
-
constructor( def = { def.attribute, [def.callback], def.emitter, def.observable } )
module:ui/template~TemplateBinding#constructor
Creates an instance of the
TemplateBinding
class.Parameters
def : object
The definition of the binding.
Propertiesdef.attribute : string
[ def.callback ] : ( any, Node ) => TemplateSimpleValue
def.emitter : Emitter
def.observable : Observable
-
activateAttributeListener( schema, updater, data ) → () => void
module:ui/template~TemplateBinding#activateAttributeListener
Activates the listener which waits for changes of the
attribute
inobservable
, then updates the DOM with the aggregated value ofTemplateValueSchema
.Parameters
schema : Array<TemplateSimpleValue | TemplateBinding>
A full schema to generate an attribute or text in the DOM.
updater : Updater
A DOM updater function used to update the native DOM attribute or text.
data : RenderData
Rendering data.
Returns
() => void
A function to sever the listener binding.
-
getValue( node ) → TemplateSimpleValue
module:ui/template~TemplateBinding#getValue
Returns the value of the binding. It is the value of the
attribute
inobservable
. The value may be processed by thecallback
, if such has been passed to the binding.Parameters
node : Node
A native DOM node, passed to the custom
callback
.
Returns
TemplateSimpleValue
The value of
attribute
inobservable
.
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.