TemplateBinding (ui)

@ckeditor/ckeditor5-ui/src/template

Properties

• readonly

  attribute : stringmodule:ui/template~TemplateBinding#attribute

  See source

  The name of the observed attribute.

• readonly

  callback : ( any, Node ) => TemplateSimpleValue | undefinedmodule:ui/template~TemplateBinding#callback

  See source

  A custom function to process the value of the attribute.

• readonly

  emitter : Emittermodule:ui/template~TemplateBinding#emitter

  See source

  An Emitter used by the binding to:

  • listen to the attribute change in the observable,
  • or listen to the event in the DOM.

• readonly

  observable : Observablemodule:ui/template~TemplateBinding#observable

  See source

  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

  See source

  Creates an instance of the TemplateBinding class.

  Parameters

  def : object

  The definition of the binding.

  Properties

  def.attribute : string

  [ def.callback ] : ( any, Node ) => TemplateSimpleValue

  def.emitter : Emitter

  def.observable : Observable

• activateAttributeListener( schema, updater, data ) → () => voidmodule:ui/template~TemplateBinding#activateAttributeListener

  See source

  Activates the listener which waits for changes of the attribute in observable, then updates the DOM with the aggregated value of TemplateValueSchema.

  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 ) → TemplateSimpleValuemodule:ui/template~TemplateBinding#getValue

  See source

  Returns the value of the binding. It is the value of the attribute in observable. The value may be processed by the callback, 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 in observable.