TemplateBinding (ui)
@ckeditor/ckeditor5-ui/src/template
Describes a binding created by the bind interface.
Filtering
Properties
-
attribute : Stringmodule:ui/template~TemplateBinding#attributeThe name of the observed attribute.
-
callback : functionmodule:ui/template~TemplateBinding#callbackA custom function to process the value of the
attribute. -
emitter : EmitterMixinmodule:ui/template~TemplateBinding#emitterAn
Emitterused 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
-
observable : ObservableMixinmodule:ui/template~TemplateBinding#observableAn 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 )module:ui/template~TemplateBinding#constructorCreates an instance of the
TemplateBindingclass.Parameters
def : TemplateDefinitionThe definition of the binding.
-
activateAttributeListener( schema, updater, data ) → functionmodule:ui/template~TemplateBinding#activateAttributeListenerActivates the listener which waits for changes of the
attributeinobservable, then updates the DOM with the aggregated value ofTemplateValueSchema.Parameters
schema : TemplateValueSchemaA full schema to generate an attribute or text in the DOM.
updater : functionA DOM updater function used to update the native DOM attribute or text.
data : RenderDataRendering data.
Returns
functionA function to sever the listener binding.
-
getValue( [ node ] ) → *module:ui/template~TemplateBinding#getValueReturns the value of the binding. It is the value of the
attributeinobservable. The value may be processed by thecallback, if such has been passed to the binding.Parameters
[ node ] : NodeA native DOM node, passed to the custom
callback.
Returns
*The value of
attributeinobservable.
Every day, we work hard to keep our documentation complete. Have you spotted an outdated information? Is something missing? Please report it via our issue tracker.