Event Handling

Attaching event listeners

You can add any handler to the events of Sidebar. To do this, use the sidebar.events.on() method with the following parameters:

  • evName - the name of the event
  • evHandler - a user-defined event handler
sidebar.events.on("Click", function(id,e){
    console.log(id);
});

Several handlers can be attached to one and the same event, and all of them will be executed.

The names of the events are case-insensitive.

Detaching event listeners

There is a simple way of removing an event handler with the sidebar.events.detach() method:

var clickEvent = sidebar.events.on("Click", function(id,e){
    console.log(id);
});
 
sidebar.events.detach(clickEvent);

Calling events

A custom event can be called with the fire() method of the events module:

sidebar.events.fire(evName,[args]);

List of supported events

You can find the full list of sidebar events in the API section.

Back to top