Document on* handlers (for extension authors' sake)

This commit is contained in:
Aarni Koskela 2023-05-25 09:03:14 +03:00
parent 9574ebe212
commit 54696dce05
1 changed files with 20 additions and 0 deletions

View File

@ -24,15 +24,35 @@ var uiTabChangeCallbacks = [];
var optionsChangedCallbacks = []; var optionsChangedCallbacks = [];
var uiCurrentTab = null; var uiCurrentTab = null;
/**
* Register callback to be called at each UI update.
* The callback receives an array of MutationRecords as an argument.
*/
function onUiUpdate(callback) { function onUiUpdate(callback) {
uiUpdateCallbacks.push(callback); uiUpdateCallbacks.push(callback);
} }
/**
* Register callback to be called when the UI is loaded.
* The callback receives no arguments.
*/
function onUiLoaded(callback) { function onUiLoaded(callback) {
uiLoadedCallbacks.push(callback); uiLoadedCallbacks.push(callback);
} }
/**
* Register callback to be called when the UI tab is changed.
* The callback receives no arguments.
*/
function onUiTabChange(callback) { function onUiTabChange(callback) {
uiTabChangeCallbacks.push(callback); uiTabChangeCallbacks.push(callback);
} }
/**
* Register callback to be called when the options are changed.
* The callback receives no arguments.
* @param callback
*/
function onOptionsChanged(callback) { function onOptionsChanged(callback) {
optionsChangedCallbacks.push(callback); optionsChangedCallbacks.push(callback);
} }