Use sidebar actions to add a sidebar to Firefox.

Manifest keys: sidebar_action

Not allowed in: Content scripts, Devtools pages

_GetPanelDetails
_GetTitleDetails
_IsOpenDetails
_SetIconDetails
_SetPanelDetails
_SetTitleDetails
ImageDataType
close
getPanel
getTitle
isOpen
open
setIcon
setPanel
setTitle
toggle
ImageDataType: ImageData

Pixel data for an image. Must be an ImageData object (for example, from a canvas element).

  • Closes the extension sidebar in the active window if the sidebar belongs to the extension.

    Returns Promise<void>

  • Gets the url to the html document set as the panel for this sidebar action.

    Parameters

    Returns Promise<string>

  • Checks whether the sidebar action is open.

    Parameters

    Returns Promise<boolean>

  • Opens the extension sidebar in the active window.

    Returns Promise<void>

  • Sets the icon for the sidebar action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element, or as dictionary of either one of those. Either the path or the imageData property must be specified.

    Parameters

    Returns Promise<void>

  • Sets the url to the html document to be opened in the sidebar when the user clicks on the sidebar action's icon.

    Parameters

    Returns Promise<void>

  • Toggles the extension sidebar in the active window.

    Returns Promise<void>