NEWCKEditor 5 Long-term Support is here! Find out more
Sign up (with export icon)

ViewWithCssTransitionDisabler

Api-class icon class

The basic view class, which represents an HTML element created out of a template. Views are building blocks of the user interface and handle interaction

Views aggregate children in collections and manage the life cycle of DOM listeners e.g. by handling rendering and destruction.

See the TemplateDefinition syntax to learn more about shaping view elements, attributes and listeners.

class SampleView extends View {
	constructor( locale ) {
		super( locale );

		const bind = this.bindTemplate;

		// Views define their interface (state) using observable attributes.
		this.set( 'elementClass', 'bar' );

		this.setTemplate( {
			tag: 'p',

			// The element of the view can be defined with its children.
			children: [
				'Hello',
				{
					tag: 'b',
					children: [ 'world!' ]
				}
			],
			attributes: {
				class: [
					'foo',

					// Observable attributes control the state of the view in DOM.
					bind.to( 'elementClass' )
				]
			},
			on: {
				// Views listen to DOM events and propagate them.
				click: bind.to( 'clicked' )
			}
		} );
	}
}

const view = new SampleView( locale );

view.render();

// Append <p class="foo bar">Hello<b>world</b></p> to the <body>
document.body.appendChild( view.element );

// Change the class attribute to <p class="foo baz">Hello<b>world</b></p>
view.elementClass = 'baz';

// Respond to the "click" event in DOM by executing a custom action.
view.on( 'clicked', () => {
	console.log( 'The view has been clicked!' );
} );
Copy code
See source (with github icon)

Properties

  • Chevron-right icon

    bindTemplate : BindChain<this>
    readonlyinherited

    Shorthand for bind, a binding interface pre–configured for the view instance.

    It provides to() and if() methods that initialize bindings with observable attributes and attach DOM listeners.

    class SampleView extends View {
	constructor( locale ) {
		super( locale );

		const bind = this.bindTemplate;

		// These observable attributes will control
		// the state of the view in DOM.
		this.set( {
			elementClass: 'foo',
		 	isEnabled: true
		 } );

		this.setTemplate( {
			tag: 'p',

			attributes: {
				// The class HTML attribute will follow elementClass
				// and isEnabled view attributes.
				class: [
					bind.to( 'elementClass' )
					bind.if( 'isEnabled', 'present-when-enabled' )
				]
			},

			on: {
				// The view will fire the "clicked" event upon clicking <p> in DOM.
				click: bind.to( 'clicked' )
			}
		} );
	}
}
    Copy code
    See source (with github icon)
  • Chevron-right icon

    element : null | HTMLElement
    inherited

    An HTML element of the view. null until rendered from the template.

    class SampleView extends View {
	constructor() {
		super();

		// A template instance the #element will be created from.
		this.setTemplate( {
			tag: 'p'

			// ...
		} );
	}
}

const view = new SampleView();

// Renders the #template.
view.render();

// Append the HTML element of the view to <body>.
document.body.appendChild( view.element );
    Copy code

    Note: The element of the view can also be assigned directly:

    view.element = document.querySelector( '#my-container' );
    Copy code
    See source (with github icon)
  • Chevron-right icon

    isRendered : boolean
    readonlyinherited

    Set true when the view has already been rendered.

    See source (with github icon)
  • Chevron-right icon

    locale : undefined | Locale
    readonlyinherited

    A set of tools to localize the user interface.

    Also see locale.

    See source (with github icon)
  • Chevron-right icon

    t : undefined | LocaleTranslate
    inherited

    Shorthand for t.

    Note: If locale instance hasn't been passed to the view this method may not be available.

    See source (with github icon)

    Related:

  • Chevron-right icon

    template : Template | undefined
    inherited

    Template of this view. It provides the element representing the view in DOM, which is rendered.

    See source (with github icon)

  • viewUid : string | undefined
    inherited

    See source (with github icon)
  • Chevron-right icon

    _unboundChildren : ViewCollection
    protectedinherited

    A collection of view instances, which have been added directly into the children.

    See source (with github icon)
  • Chevron-right icon

    _viewCollections : Collection<ViewCollection<View<HTMLElement>>>
    protectedinherited

    Collections registered with createCollection.

    See source (with github icon)

Methods

  • Chevron-right icon

    constructor( [ locale ] )
    inherited

    Creates an instance of the View class.

    Also see render.

    See source (with github icon)

    Parameters

    [ locale ] : Locale

    The localization services instance.

  • Chevron-right icon

    bind( bindProperties ) → ObservableMultiBindChain
    inherited

    Binds observable properties to other objects implementing the Observable interface.

    Read more in the dedicated guide covering the topic of property bindings with some additional examples.

    Consider two objects: a button and an associated command (both Observable).

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );
    Copy code

    or even shorter:

    button.bind( 'isEnabled' ).to( command );
    Copy code

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

    Note: To release the binding, use unbind.

    You can also "rename" the property in the binding by specifying the new name in the to() chain:

    button.bind( 'isEnabled' ).to( command, 'isWorking' );
    Copy code

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );
    Copy code

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
    Copy code

    The binding can include more than one observable, combining multiple data sources in a custom callback:

    button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
    Copy code

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
    Copy code

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

    button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
    Copy code
    See source (with github icon)

    Parameters

    bindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'template' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'disableCssTransitions' | 'enableCssTransitions'>

    Observable properties that will be bound to other observable(s).

    Returns

    ObservableMultiBindChain

    The bind chain with the to() and toMany() methods.

  • Chevron-right icon

    bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, ViewWithCssTransitionDisabler[ K1 ], K2, ViewWithCssTransitionDisabler[ K2 ]>
    inherited

    Binds observable properties to other objects implementing the Observable interface.

    Read more in the dedicated guide covering the topic of property bindings with some additional examples.

    Consider two objects: a button and an associated command (both Observable).

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );
    Copy code

    or even shorter:

    button.bind( 'isEnabled' ).to( command );
    Copy code

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

    Note: To release the binding, use unbind.

    You can also "rename" the property in the binding by specifying the new name in the to() chain:

    button.bind( 'isEnabled' ).to( command, 'isWorking' );
    Copy code

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );
    Copy code

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
    Copy code

    The binding can include more than one observable, combining multiple data sources in a custom callback:

    button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
    Copy code

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
    Copy code

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

    button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
    Copy code
    See source (with github icon)

    Type parameters

    K1
    K2

    Parameters

    bindProperty1 : K1

    Observable property that will be bound to other observable(s).

    bindProperty2 : K2

    Observable property that will be bound to other observable(s).

    Returns

    ObservableDualBindChain<K1, ViewWithCssTransitionDisabler[ K1 ], K2, ViewWithCssTransitionDisabler[ K2 ]>

    The bind chain with the to() and toMany() methods.

  • Chevron-right icon

    bind( bindProperty ) → ObservableSingleBindChain<K, ViewWithCssTransitionDisabler[ K ]>
    inherited

    Binds observable properties to other objects implementing the Observable interface.

    Read more in the dedicated guide covering the topic of property bindings with some additional examples.

    Consider two objects: a button and an associated command (both Observable).

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );
    Copy code

    or even shorter:

    button.bind( 'isEnabled' ).to( command );
    Copy code

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

    Note: To release the binding, use unbind.

    You can also "rename" the property in the binding by specifying the new name in the to() chain:

    button.bind( 'isEnabled' ).to( command, 'isWorking' );
    Copy code

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );
    Copy code

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
    Copy code

    The binding can include more than one observable, combining multiple data sources in a custom callback:

    button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
    Copy code

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
    Copy code

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

    button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
    Copy code
    See source (with github icon)

    Type parameters

    K

    Parameters

    bindProperty : K

    Observable property that will be bound to other observable(s).

    Returns

    ObservableSingleBindChain<K, ViewWithCssTransitionDisabler[ K ]>

    The bind chain with the to() and toMany() methods.

  • Chevron-right icon

    createCollection( [ views ] ) → ViewCollection<T>
    inherited

    Creates a new collection of views, which can be used as children of this view.

    class SampleView extends View {
	constructor( locale ) {
		super( locale );

		const child = new ChildView( locale );
		this.items = this.createCollection( [ child ] );
 *
		this.setTemplate( {
			tag: 'p',

			// `items` collection will render here.
			children: this.items
		} );
	}
}

const view = new SampleView( locale );
view.render();

// It will append <p><child#element></p> to the <body>.
document.body.appendChild( view.element );
    Copy code
    See source (with github icon)

    Type parameters

    T : extends [object Object] = View

    Parameters

    [ views ] : Iterable<T>

    Initial views of the collection.

    Returns

    ViewCollection<T>

    A new collection of view instances.

  • Chevron-right icon

    decorate( methodName ) → void
    inherited

    Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

    Read more in the dedicated guide covering the topic of decorating methods with some additional examples.

    Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

    For example, to cancel the method execution the event can be stopped:

    class Foo extends ObservableMixin() {
	constructor() {
		super();
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.
    Copy code

    Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

    It is also possible to change the returned value:

    foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
    Copy code

    Finally, it is possible to access and modify the arguments the method is called with:

    method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'
    Copy code
    See source (with github icon)

    Parameters

    methodName : 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'template' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'disableCssTransitions' | 'enableCssTransitions'

    Name of the method to decorate.

    Returns

    void
  • Chevron-right icon

    delegate( events ) → EmitterMixinDelegateChain
    inherited

    Delegates selected events to another Emitter. For instance:

    emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
    Copy code

    then eventX is delegated (fired by) emitterB and emitterC along with data:

    emitterA.fire( 'eventX', data );
    Copy code

    and eventY is delegated (fired by) emitterC along with data:

    emitterA.fire( 'eventY', data );
    Copy code
    See source (with github icon)

    Parameters

    events : Array<string>

    Event names that will be delegated to another emitter.

    Returns

    EmitterMixinDelegateChain
  • Chevron-right icon

    deregisterChild( children ) → void
    inherited

    The opposite of registerChild. Removes a child view from this view instance. Once removed, the child is no longer managed by its parent, e.g. it can safely become a child of another parent view.

    See source (with github icon)

    Parameters

    children : View<HTMLElement> | Iterable<View<HTMLElement>>

    Child views to be removed.

    Returns

    void

    Related:

  • Chevron-right icon

    destroy() → void
    inherited

    Recursively destroys the view instance and child views added by registerChild and residing in collections created by the createCollection.

    Destruction disables all event listeners:

    • created on the view, e.g. view.on( 'event', () => {} ),
    • defined in the template for DOM events.
    See source (with github icon)

    Returns

    void
  • Chevron-right icon

    disableCssTransitions() → void

    See source (with github icon)

    Returns

    void
  • Chevron-right icon

    enableCssTransitions() → void

    See source (with github icon)

    Returns

    void
  • Chevron-right icon

    extendTemplate( definition ) → void
    inherited

    Extends the template of the view with with given definition.

    A shorthand for:

    Template.extend( view.template, definition );
    Copy code

    Note: Is requires the template to be already set. See setTemplate.

    See source (with github icon)

    Parameters

    definition : Partial<TemplateDefinition>

    Definition which extends the template.

    Returns

    void
  • Chevron-right icon

    fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]
    inherited

    Fires an event, executing all callbacks registered for it.

    The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

    See source (with github icon)

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    eventOrInfo : GetNameOrEventInfo<TEvent>

    The name of the event or EventInfo object if event is delegated.

    args : TEvent[ 'args' ]

    Additional arguments to be passed to the callbacks.

    Returns

    GetEventInfo<TEvent>[ 'return' ]

    By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).

  • Chevron-right icon

    listenTo( emitter, event, callback, [ options ] ) → void
    inherited

    Registers a callback function to be executed when an event is fired in a specific (emitter) object.

    Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.

    // myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
    Copy code

    An event callback can stop the event and set the return value of the fire method.

    See source (with github icon)

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    emitter : Emitter

    The object that fires the event.

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : CallbackOptions

    Additional options.

    Returns

    void
  • Chevron-right icon

    listenTo( emitter, event, callback, [ options ] ) → void
    inherited

    Registers a callback function to be executed when an event is fired in a specific (emitter) object.

    Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.

    // myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
    Copy code

    An event callback can stop the event and set the return value of the fire method.

    See source (with github icon)

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    emitter : Emitter

    The object that fires the event.

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void
  • Chevron-right icon

    listenTo( emitter, event, callback, [ options ] ) → void
    inherited

    Registers a callback function to be executed when an event is fired in a specific Emitter or DOM Node. It is backwards compatible with listenTo.

    See source (with github icon)

    Type parameters

    K : extends keyof DomEventMap

    Parameters

    emitter : Window | EventTarget | Node

    The object that fires the event.

    event : K

    The name of the event.

    callback : ( this: this, ev: EventInfo, event: DomEventMap[ K ] ) => void

    The function to be called on event.

    [ options ] : object

    Additional options.

    Returns

    void
  • Chevron-right icon

    off( event, callback ) → void
    inherited

    Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

    See source (with github icon)

    Parameters

    event : string

    The name of the event.

    callback : Function

    The function to stop being called.

    Returns

    void
  • Chevron-right icon

    on( event, callback, [ options ] ) → void
    inherited

    Registers a callback function to be executed when an event is fired.

    Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

    See source (with github icon)

    Type parameters

    TEvent : extends BaseEvent

    The type descibing the event. See BaseEvent.

    Parameters

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void
  • Chevron-right icon

    once( event, callback, [ options ] ) → void
    inherited

    Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

    See source (with github icon)

    Type parameters

    TEvent : extends BaseEvent

    The type descibing the event. See BaseEvent.

    Parameters

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void
  • Chevron-right icon

    registerChild( children ) → void
    inherited

    Registers a new child view under the view instance. Once registered, a child view is managed by its parent, including rendering and destruction.

    To revert this, use deregisterChild.

    class SampleView extends View {
	constructor( locale ) {
		super( locale );

		this.childA = new SomeChildView( locale );
		this.childB = new SomeChildView( locale );

		this.setTemplate( { tag: 'p' } );

		// Register the children.
		this.registerChild( [ this.childA, this.childB ] );
	}

	render() {
		super.render();

		this.element.appendChild( this.childA.element );
		this.element.appendChild( this.childB.element );
	}
}

const view = new SampleView( locale );

view.render();

// Will append <p><childA#element><b></b><childB#element></p>.
document.body.appendChild( view.element );
    Copy code

    Note: There's no need to add child views if they're already referenced in the template:

    class SampleView extends View {
	constructor( locale ) {
		super( locale );

		this.childA = new SomeChildView( locale );
		this.childB = new SomeChildView( locale );

		this.setTemplate( {
			tag: 'p',

 * 			// These children will be added automatically. There's no
 * 			// need to call registerChild for any of them.
			children: [ this.childA, this.childB ]
		} );
	}

	// ...
}
    Copy code
    See source (with github icon)

    Parameters

    children : View<HTMLElement> | Iterable<View<HTMLElement>>

    Children views to be registered.

    Returns

    void
  • Chevron-right icon

    render() → void
    inherited

    Recursively renders the view.

    Once the view is rendered:

    Note: The children of the view:

    In general, render() method is the right place to keep the code which refers to the element and should be executed at the very beginning of the view's life cycle.

    It is possible to extend the template before the view is rendered. To allow an early customization of the view (e.g. by its parent), such references should be done in render().

    class SampleView extends View {
	constructor() {
		this.setTemplate( {
			// ...
		} );
	},

	render() {
		// View#element becomes available.
		super.render();

		// The "scroll" listener depends on #element.
		this.listenTo( window, 'scroll', () => {
			// A reference to #element would render the #template and make it non-extendable.
			if ( window.scrollY > 0 ) {
				this.element.scrollLeft = 100;
			} else {
				this.element.scrollLeft = 0;
			}
		} );
	}
}

const view = new SampleView();

// Let's customize the view before it gets rendered.
view.extendTemplate( {
	attributes: {
		class: [
			'additional-class'
		]
	}
} );

// Late rendering allows customization of the view.
view.render();
    Copy code
    See source (with github icon)

    Returns

    void
  • Chevron-right icon

    set( values ) → void
    inherited

    Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.

    It accepts a single object literal containing key/value pairs with properties to be set.

    This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

    In TypeScript, those properties should be declared in class using declare keyword. In example:

    public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}
    Copy code
    See source (with github icon)

    Parameters

    values : object

    An object with name=>value pairs.

    Returns

    void
  • Chevron-right icon

    set( name, value ) → void
    inherited

    Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

    This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

    In TypeScript, those properties should be declared in class using declare keyword. In example:

    public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}
    Copy code
    See source (with github icon)

    Type parameters

    K

    Parameters

    name : K

    The property's name.

    value : ViewWithCssTransitionDisabler[ K ]

    The property's value.

    Returns

    void
  • Chevron-right icon

    setTemplate( definition ) → void
    inherited

    Sets the template of the view with with given definition.

    A shorthand for:

    view.setTemplate( definition );
    Copy code
    See source (with github icon)

    Parameters

    definition : TemplateDefinition

    Definition of view's template.

    Returns

    void
  • Chevron-right icon

    stopDelegating( [ event ], [ emitter ] ) → void
    inherited

    Stops delegating events. It can be used at different levels:

    • To stop delegating all events.
    • To stop delegating a specific event to all emitters.
    • To stop delegating a specific event to a specific emitter.
    See source (with github icon)

    Parameters

    [ event ] : string

    The name of the event to stop delegating. If omitted, stops it all delegations.

    [ emitter ] : Emitter

    (requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

    Returns

    void
  • Chevron-right icon

    stopListening( [ emitter ], [ event ], [ callback ] ) → void
    inherited

    Stops listening for events. It can be used at different levels:

    • To stop listening to a specific callback.
    • To stop listening to a specific event.
    • To stop listening to all events fired by a specific object.
    • To stop listening to all events fired by all objects.
    See source (with github icon)

    Parameters

    [ emitter ] : Emitter

    The object to stop listening to. If omitted, stops it for all objects.

    [ event ] : string

    (Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

    [ callback ] : Function

    (Requires the event) The function to be removed from the call list for the given event.

    Returns

    void
  • Chevron-right icon

    stopListening( [ emitter ], [ event ], [ callback ] ) → void
    inherited

    Stops listening for events. It can be used at different levels: It is backwards compatible with listenTo.

    • To stop listening to a specific callback.
    • To stop listening to a specific event.
    • To stop listening to all events fired by a specific object.
    • To stop listening to all events fired by all objects.
    See source (with github icon)

    Parameters

    [ emitter ] : Window | EventTarget | Node | Emitter

    The object to stop listening to. If omitted, stops it for all objects.

    [ event ] : string

    (Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

    [ callback ] : Function

    (Requires the event) The function to be removed from the call list for the given event.

    Returns

    void
  • Chevron-right icon

    unbind( unbindProperties ) → void
    inherited

    Removes the binding created with bind.

    // Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
    Copy code
    See source (with github icon)

    Parameters

    unbindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'template' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'disableCssTransitions' | 'enableCssTransitions'>

    Observable properties to be unbound. All the bindings will be released if no properties are provided.

    Returns

    void
  • Chevron-right icon

    initializeCssTransitionDisablerMixin() → void
    protected

    See source (with github icon)

    Returns

    void

Events

  • Chevron-right icon

    change:{property}( eventInfo, name, value, oldValue )
    inherited

    Fired when a property changed value.

    observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'
    Copy code
    See source (with github icon)

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    The property name.

    value : TValue

    The new property value.

    oldValue : TValue

    The previous property value.

  • Chevron-right icon

    render( eventInfo, <anonymous> )
    inherited

    Event fired by the render method. Actual rendering is executed as a listener to this event with the default priority.

    See decorate for more information and samples.

    See source (with github icon)

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    <anonymous> : Parameters<TObservable[ TName ]>
  • Chevron-right icon

    set:{property}( eventInfo, name, value, oldValue )
    inherited

    Fired when a property value is going to be set but is not set yet (before the change event is fired).

    You can control the final value of the property by using the event's return property.

    observable.set( 'prop', 1 );

observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
                     // -> 'Current property value is 1'
                     // -> 'Value has changed from 1 to 3'
    Copy code

    Note: The event is fired even when the new value is the same as the old value.

    See source (with github icon)

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    The property name.

    value : TValue

    The new property value.

    oldValue : TValue

    The previous property value.

  • Chevron-right icon

    submit( eventInfo )
    inherited

    Fired by submitHandler helper.

    See source (with github icon)

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

Was this page helpful?

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.

GitHubSupportContact Us

© 2003 - 2025  CKSource. All rights reserved.