action.onUserSettingsChanged

Fired when a change occurs in the user-specified settings that affect an extension's action.

Syntax

js
browser.action.onUserSettingsChanged.addListener(listener)
browser.action.onUserSettingsChanged.removeListener(listener)
browser.action.onUserSettingsChanged.hasListener(listener)

Events have three functions:

addListener(listener)

Adds a listener to this event.

removeListener(listener)

Stop listening to this event. The listener argument is the listener to remove.

hasListener(listener)

Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

listener

The function called when this event occurs. The function is passed these arguments:

change

'object'. Details of the changed user-specified settings.

isOnToolbar

boolean. Whether the extension's action icon is visible on the top-level toolbar of the browser windows (i.e., whether the extension has been 'pinned' by the user).

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
onUserSettingsChanged
Chrome – Full support
Chrome 130 (Release date: 2024-10-15)
footnote Full support
Edge – Full support
Edge 130 (Release date: 2024-10-17)
footnote Full support
Firefox – Full support
Firefox 142 (Release date: 2025-08-19)
footnote Full support
Opera – Full support
Opera 115 (Release date: 2024-11-27)
footnote Full support
Safari – No support
Safari
footnote
footnote See bug 294444
Firefox for Android – Full support
Firefox for Android 142 (Release date: 2025-08-19)
footnote
footnote Never fires as there is no toolbar to pin extensions to in Firefox for Android.
Safari on iOS – No support
Safari on iOS
footnote
footnote See bug 294444

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
See implementation notes.