InputBase (ui/input)
@ckeditor/ckeditor5-ui/src/input/inputbase
The base input view class.
Filtering
Type parameters
-
TElement
Properties
-
The
id
of the element describing this field, e.g. when it has some error; it helps screen readers read the error text. -
The
aria-label
attribute of the input. -
Shorthand for
bind
, a binding interface pre–configured for the view instance.It provides
to()
andif()
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' ) } } ); } }
-
An HTML element of the view.
null
until rendered from thetemplate
.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 );
Note: The element of the view can also be assigned directly:
view.element = document.querySelector( '#my-container' );
-
Stores information about the editor UI focus and propagates it so various plugins and components are unified as a focus group.
-
Set to
true
when the field has some error. Usually controlled viaerrorText
. -
The
id
attribute of the input (i.e. to pair with a<label>
element). -
An observable flag set to
true
when the input contains no text, i.e. whenvalue
is''
,null
, orfalse
.Defaults to
true
-
An observable flag set to
true
when the input is currently focused by the user. Set tofalse
otherwise.Defaults to
false
-
Controls whether the input view is in read-only mode.
-
Set
true
when the view has already been rendered. -
-
The
placeholder
attribute of the input. -
The
tabindex
attribute of the input. -
The value of the input.
-
protected inherited
_unboundChildren : ViewCollection<View<HTMLElement>>
module:ui/input/inputbase~InputBase#_unboundChildren
A collection of view instances, which have been added directly into the
children
. -
protected inherited
_viewCollections : Collection<ViewCollection<View<HTMLElement>>>
module:ui/input/inputbase~InputBase#_viewCollections
Collections registered with
createCollection
.
Methods
-
constructor( [ locale ] )
module:ui/input/inputbase~InputBase#constructor
-
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, InputBase<TElement>[ K1 ], K2, InputBase<TElement>[ K2 ]>
module:ui/input/inputbase~InputBase#bind:DUAL_BIND
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 associatedcommand
(bothObservable
).A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
or even shorter:
button.bind( 'isEnabled' ).to( command );
which works in the following way:
button.isEnabled
instantly equalscommand.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' );
It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );
which corresponds to:
button.bind( 'isEnabled' ).to( command ); button.bind( 'value' ).to( command );
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 );
Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
It is also possible to bind to the same property in an array of observables. To bind a
button
to multiple commands (alsoObservables
) 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 );
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
-
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 associatedcommand
(bothObservable
).A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
or even shorter:
button.bind( 'isEnabled' ).to( command );
which works in the following way:
button.isEnabled
instantly equalscommand.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' );
It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );
which corresponds to:
button.bind( 'isEnabled' ).to( command ); button.bind( 'value' ).to( command );
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 );
Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
It is also possible to bind to the same property in an array of observables. To bind a
button
to multiple commands (alsoObservables
) 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 );
Parameters
bindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'element' | 'select' | 'template' | 'focus' | 'reset' | 'id' | 'ariaLabel' | 'tabIndex' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'focusTracker' | 'value' | 'placeholder' | 'isReadOnly' | 'isFocused' | 'isEmpty' | 'ariaDescribedById' | 'hasError'>
Observable properties that will be bound to other observable(s).
Returns
MultiBindChain
The bind chain with the
to()
andtoMany()
methods.
-
inherited
bind( bindProperty ) → SingleBindChain<K, InputBase<TElement>[ K ]>
module:ui/input/inputbase~InputBase#bind:SINGLE_BIND
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 associatedcommand
(bothObservable
).A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
or even shorter:
button.bind( 'isEnabled' ).to( command );
which works in the following way:
button.isEnabled
instantly equalscommand.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' );
It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );
which corresponds to:
button.bind( 'isEnabled' ).to( command ); button.bind( 'value' ).to( command );
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 );
Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
It is also possible to bind to the same property in an array of observables. To bind a
button
to multiple commands (alsoObservables
) 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 );
Type parameters
K
Parameters
bindProperty : K
Observable property that will be bound to other observable(s).
Returns
SingleBindChain<K, InputBase<TElement>[ K ]>
The bind chain with the
to()
andtoMany()
methods.
-
inherited
createCollection( [ views ] ) → ViewCollection<T>
module:ui/input/inputbase~InputBase#createCollection
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 );
Type parameters
T : extends [object Object] = default
Parameters
[ views ] : Iterable<T>
Initial views of the collection.
Returns
ViewCollection<T>
A new collection of view instances.
-
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.
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'
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'
Parameters
methodName : 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'element' | 'select' | 'template' | 'focus' | 'reset' | 'id' | 'ariaLabel' | 'tabIndex' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'focusTracker' | 'value' | 'placeholder' | 'isReadOnly' | 'isFocused' | 'isEmpty' | 'ariaDescribedById' | 'hasError'
Name of the method to decorate.
Returns
void
-
inherited
delegate( events ) → EmitterMixinDelegateChain
module:ui/input/inputbase~InputBase#delegate
Delegates selected events to another
Emitter
. For instance:emitterA.delegate( 'eventX' ).to( emitterB ); emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
then
eventX
is delegated (fired by)emitterB
andemitterC
along withdata
:emitterA.fire( 'eventX', data );
and
eventY
is delegated (fired by)emitterC
along withdata
:emitterA.fire( 'eventY', data );
Parameters
events : Array<string>
Event names that will be delegated to another emitter.
Returns
-
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.Parameters
Returns
void
Related:
-
destroy() → void
module:ui/input/inputbase~InputBase#destroy
Recursively destroys the view instance and child views added by
registerChild
and residing in collections created by thecreateCollection
.Destruction disables all event listeners:
- created on the view, e.g.
view.on( 'event', () => {} )
, - defined in the
template
for DOM events.
Returns
void
- created on the view, e.g.
-
Extends the
template
of the view with with given definition.A shorthand for:
Template.extend( view.template, definition );
Note: Is requires the
template
to be already set. SeesetTemplate
.Parameters
definition : Partial<TemplateDefinition>
Definition which extends the
template
.
Returns
void
-
inherited
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]
module:ui/input/inputbase~InputBase#fire
Fires an event, executing all callbacks registered for it.
The first parameter passed to callbacks is an
EventInfo
object, followed by the optionalargs
provided in thefire()
method call.Type parameters
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 theevt.return
's property (the event info is the first param of every callback).
-
focus() → void
module:ui/input/inputbase~InputBase#focus
-
inherited
listenTo( emitter, event, callback, [ options ] ) → void
module:ui/input/inputbase~InputBase#listenTo:DOM_EMITTER
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' );
An event callback can stop the event and set the return value of the
fire
method.Type parameters
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
-
inherited
listenTo( emitter, event, callback, [ options ] ) → void
module:ui/input/inputbase~InputBase#listenTo:BASE_EMITTER
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' );
An event callback can stop the event and set the return value of the
fire
method.Type parameters
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
-
inherited
listenTo( emitter, event, callback, [ options ] ) → void
module:ui/input/inputbase~InputBase#listenTo:HTML_EMITTER
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
.Type parameters
K : extends keyof DomEventMap
Parameters
emitter : Window | Node
The object that fires the event.
event : K
The name of the event.
callback : ( InputBase<TElement>, EventInfo<string, unknown>, DomEventMap[ K ] ) => void
The function to be called on event.
[ options ] : object
Additional options.
Returns
void
-
Stops executing the callback on the given event. Shorthand for
this.stopListening( this, event, callback )
.Parameters
event : string
The name of the event.
callback : Function
The function to stop being called.
Returns
void
-
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).Type parameters
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
-
Registers a callback function to be executed on the next time the event is fired only. This is similar to calling
on
followed byoff
in the callback.Type parameters
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
-
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 );
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 ] } ); } // ... }Parameters
Returns
void
-
render() → void
module:ui/input/inputbase~InputBase#render
Recursively renders the view.
Once the view is rendered:
- the
element
becomes an HTML element out oftemplate
, - the
isRendered
flag is settrue
.
Note: The children of the view:
- defined directly in the
template
- residing in collections created by the
createCollection
method, - and added by
registerChild
are also rendered in the process.
In general,
render()
method is the right place to keep the code which refers to theelement
and should be executed at the very beginning of the view's life cycle.It is possible to
extend
thetemplate
before the view is rendered. To allow an early customization of the view (e.g. by its parent), such references should be done inrender()
.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();
Returns
void
- the
-
reset() → void
module:ui/input/inputbase~InputBase#reset
-
select() → void
module:ui/input/inputbase~InputBase#select
-
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 thatfoo.set( 'bar', 1 )
may be slightly slower thanfoo.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' } ); }
Parameters
values : object
An object with
name=>value
pairs.
Returns
void
-
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 thatfoo.set( 'bar', 1 )
may be slightly slower thanfoo.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 ); }
Type parameters
K
Parameters
name : K
The property's name.
value : InputBase<TElement>[ K ]
The property's value.
Returns
void
-
Sets the
template
of the view with with given definition.A shorthand for:
view.setTemplate( definition );
Parameters
definition : TemplateDefinition
Definition of view's template.
Returns
void
-
inherited
stopDelegating( [ event ], [ emitter ] ) → void
module:ui/input/inputbase~InputBase#stopDelegating
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.
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 ofevent
to all emitters.
Returns
void
-
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → void
module:ui/input/inputbase~InputBase#stopListening:BASE_STOP
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.
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 fromemitter
.[ callback ] : Function
(Requires the
event
) The function to be removed from the call list for the givenevent
.
Returns
void
-
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → void
module:ui/input/inputbase~InputBase#stopListening:DOM_STOP
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.
Parameters
[ emitter ] : Window | 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 fromemitter
.[ callback ] : Function
(Requires the
event
) The function to be removed from the call list for the givenevent
.
Returns
void
-
Removes the binding created with
bind
.// Removes the binding for the 'a' property. A.unbind( 'a' ); // Removes bindings for all properties. A.unbind();
Parameters
unbindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'element' | 'select' | 'template' | 'focus' | 'reset' | 'id' | 'ariaLabel' | 'tabIndex' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'focusTracker' | 'value' | 'placeholder' | 'isReadOnly' | 'isFocused' | 'isEmpty' | 'ariaDescribedById' | 'hasError'>
Observable properties to be unbound. All the bindings will be released if no properties are provided.
Returns
void
-
-
Events
-
change:ariaDescribedById( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:change:ariaDescribedById
Fired when the
ariaDescribedById
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
ariaDescribedById
).value : undefined | string
New value of the
ariaDescribedById
property with given key ornull
, if operation should remove property.oldValue : undefined | string
Old value of the
ariaDescribedById
property with given key ornull
, if property was not set before.
-
change:ariaLabel( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:change:ariaLabel
Fired when the
ariaLabel
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
ariaLabel
).value : undefined | string
New value of the
ariaLabel
property with given key ornull
, if operation should remove property.oldValue : undefined | string
Old value of the
ariaLabel
property with given key ornull
, if property was not set before.
-
change:hasError( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:change:hasError
Fired when the
hasError
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
hasError
).value : boolean
New value of the
hasError
property with given key ornull
, if operation should remove property.oldValue : boolean
Old value of the
hasError
property with given key ornull
, if property was not set before.
-
change:id( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:change:id
Fired when the
id
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
id
).value : undefined | string
New value of the
id
property with given key ornull
, if operation should remove property.oldValue : undefined | string
Old value of the
id
property with given key ornull
, if property was not set before.
-
change:isEmpty( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:change:isEmpty
Fired when the
isEmpty
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
isEmpty
).value : boolean
New value of the
isEmpty
property with given key ornull
, if operation should remove property.oldValue : boolean
Old value of the
isEmpty
property with given key ornull
, if property was not set before.
-
change:isFocused( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:change:isFocused
Fired when the
isFocused
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
isFocused
).value : boolean
New value of the
isFocused
property with given key ornull
, if operation should remove property.oldValue : boolean
Old value of the
isFocused
property with given key ornull
, if property was not set before.
-
change:isReadOnly( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:change:isReadOnly
Fired when the
isReadOnly
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
isReadOnly
).value : boolean
New value of the
isReadOnly
property with given key ornull
, if operation should remove property.oldValue : boolean
Old value of the
isReadOnly
property with given key ornull
, if property was not set before.
-
change:placeholder( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:change:placeholder
Fired when the
placeholder
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
placeholder
).value : undefined | string
New value of the
placeholder
property with given key ornull
, if operation should remove property.oldValue : undefined | string
Old value of the
placeholder
property with given key ornull
, if property was not set before.
-
change:tabIndex( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:change:tabIndex
Fired when the
tabIndex
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
tabIndex
).value : undefined | number
New value of the
tabIndex
property with given key ornull
, if operation should remove property.oldValue : undefined | number
Old value of the
tabIndex
property with given key ornull
, if property was not set before.
-
change:value( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:change:value
Fired when the
value
property changed value.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
value
).value : undefined | string
New value of the
value
property with given key ornull
, if operation should remove property.oldValue : undefined | string
Old value of the
value
property with given key ornull
, if property was not set before.
-
inherited
change:{property}( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:change:{property}
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'
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.
-
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.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
<anonymous> : Parameters<TObservable[ TName ]>
-
set:ariaDescribedById( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:set:ariaDescribedById
Fired when the
ariaDescribedById
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
ariaDescribedById
).value : undefined | string
New value of the
ariaDescribedById
property with given key ornull
, if operation should remove property.oldValue : undefined | string
Old value of the
ariaDescribedById
property with given key ornull
, if property was not set before.
-
set:ariaLabel( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:set:ariaLabel
Fired when the
ariaLabel
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
ariaLabel
).value : undefined | string
New value of the
ariaLabel
property with given key ornull
, if operation should remove property.oldValue : undefined | string
Old value of the
ariaLabel
property with given key ornull
, if property was not set before.
-
set:hasError( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:set:hasError
Fired when the
hasError
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
hasError
).value : boolean
New value of the
hasError
property with given key ornull
, if operation should remove property.oldValue : boolean
Old value of the
hasError
property with given key ornull
, if property was not set before.
-
set:id( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:set:id
Fired when the
id
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
id
).value : undefined | string
New value of the
id
property with given key ornull
, if operation should remove property.oldValue : undefined | string
Old value of the
id
property with given key ornull
, if property was not set before.
-
set:isEmpty( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:set:isEmpty
Fired when the
isEmpty
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
isEmpty
).value : boolean
New value of the
isEmpty
property with given key ornull
, if operation should remove property.oldValue : boolean
Old value of the
isEmpty
property with given key ornull
, if property was not set before.
-
set:isFocused( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:set:isFocused
Fired when the
isFocused
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
isFocused
).value : boolean
New value of the
isFocused
property with given key ornull
, if operation should remove property.oldValue : boolean
Old value of the
isFocused
property with given key ornull
, if property was not set before.
-
set:isReadOnly( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:set:isReadOnly
Fired when the
isReadOnly
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
isReadOnly
).value : boolean
New value of the
isReadOnly
property with given key ornull
, if operation should remove property.oldValue : boolean
Old value of the
isReadOnly
property with given key ornull
, if property was not set before.
-
set:placeholder( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:set:placeholder
Fired when the
placeholder
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
placeholder
).value : undefined | string
New value of the
placeholder
property with given key ornull
, if operation should remove property.oldValue : undefined | string
Old value of the
placeholder
property with given key ornull
, if property was not set before.
-
set:tabIndex( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:set:tabIndex
Fired when the
tabIndex
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
tabIndex
).value : undefined | number
New value of the
tabIndex
property with given key ornull
, if operation should remove property.oldValue : undefined | number
Old value of the
tabIndex
property with given key ornull
, if property was not set before.
-
set:value( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:set:value
Fired when the
value
property is going to be set but is not set yet (before thechange
event is fired).Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (
value
).value : undefined | string
New value of the
value
property with given key ornull
, if operation should remove property.oldValue : undefined | string
Old value of the
value
property with given key ornull
, if property was not set before.
-
inherited
set:{property}( eventInfo, name, value, oldValue )
module:ui/input/inputbase~InputBase#event:set:{property}
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'
Note: The event is fired even when the new value is the same as the old value.
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.
-
Fired by
submitHandler
helper.Parameters
eventInfo : EventInfo
An object containing information about the fired event.
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.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.