Summary
The Home.banner API lets you customize a banner that appears at the bottom of the home page. You can use this API to add and remove messages from the set of messages that rotate through this banner.
Methods
add(options)
Adds a message to the set of messages that rotate through the banner.
Parameters
Takes an object with parameters describing the message.
| Parameter | Description |
text |
The text to show in the message |
icon |
An icon to show next to the message. Can be a URI for a local resource, or a data URI |
onclick |
A function that will be called when the banner is clicked while this message is showing |
onshown |
A function that will be called when this message is shown in the banner |
ondismiss |
A function that will be called when the user dismisses this message |
Return value
Returns a unique id for the message that was added.
remove(id)
Removes a message from the set of messages that rotate through the banner.
Parameters
Takes an id for the message to remove.
| Parameter | Description |
id |
The id of the message to remove |
Return value
None.
Example
var myMessageId = Home.banner.add({
text: "This is the text in my banner message",
icon: "chrome://myaddon/skin/icon.png",
onclick: function() {
alert("Clicked on home banner!");
}
});
Home.banner.remove(myMessageId);
See also
Some demo add-ons are available on Github: