Events

Components event callbacks are configured using the events configuration attribute.  
User Events
User events are those initiated by a user working with a component.  User events can have any name but the data passed into the user event callback will have the same format.
Event Data
Name
Description
base
Underlying component or plugin event that raised the WireBootstrap event
data
Standard WireBootstrap event data​
component
The WireBootstrap component that raised the event
1
const select = new wire.bsSelect().render("#select", {
2
    ...
3
    events: {
4
        change: (config) => {
5
            ...
6
            // config.base
7
            // config.data
8
            // config.component
9
        }    
10
    }
11
});
Copied!
Life Cycle Events
Ready
The ready event is called when the component is done initialing the first time.  This includes retrieving data from a data service if bound to a dataset as well as rendering the component in the DOM.
1
const select = new wire.bsSelect().render("#select", {
2
    ...
3
    events: {
4
        ready: (config) => {
5
            ...
6
        }                
7
    }
8
});
Copied!
​
DataBind
The databind event is called each time the component gets new data.  If bound to static data such as an array of objects, this event will be called one time at the same time as the ready event.  If bound to a dataset, it will be called any time the component receives data updates from the dataset and has made the necessary changes to reflect them in its UI.
1
const select = new wire.bsSelect().render("#select", {
2
    ...
3
    events: {       
4
        databind: (config) => {
5
            ...
6
        }            
7
    }
8
});
Copied!
Fail
The fail event is called when the component fails during one of the life cycle events.  This event replaces ready and databind passing in the exception. 
1
const select = new wire.bsSelect().render("#select", {
2
    ...
3
    events: {
4
        fail: (ex) => {
5
            ...
6
        }                
7
    }
8
});
Copied!
Note, there is no need to handle the exception object with any type of UI message as this is handled by the component.
For more on component events, visit the wire.ui.Component reference page.

Data

Observables

Last modified 1yr ago

Copy link

Contents