Event Actions

Event actions allow event providers to specify the intent of the operation for which the event is being raised. This can be picked up by consumers of the event and processed accordingly. 
Standard Actions
Standard actions in the WireBootstrap data event system are centered around keeping data selections in sync among the components displaying data on a page.
In the example below, the event is telling consumers that the product SKU001 was selected and should replace the product value in any data set or query on the page.
1
const dataevent = new wire.data.DataEvent()
2
    .dataselect()
3
    .action().replace()
4
    .cell("product", "SKU001")
5
    .raise();
Copied!
With standard data events, replace is the default action.  If no action is specified, consumers should consider the data event a replace action.
Other standard actions include add which tells consumers to add the cell value to a query or data set,  remove which will remove the cell value from a dataset or query, and clear which clears the selections all together for the column, product in this example. 
1
...
2
​
3
ev.action().add();
4
 
5
ev.action().remove();
6
 
7
ev.action().clear();      
8
​
9
...
Copied!
Custom Actions
In the example below, an event is raised telling listeners that data has been selected and that the data should be passed to an external system via a custom link.  Consumers of this event would need to be programmed to process the link based on the data and the action
1
const dataevent = new wire.data.DataEvent()
2
    .dataselect()
3
    .action("link")
4
    .data( { url: "https://somesite?product=SKU001" } )
5
    .raise();
Copied!

Working With Data Events - Previous

Event Data

Next - Working with Themes

Introduction

Last modified 22d ago

Copy link

Contents

Standard Actions

Custom Actions