The :doc:`browserAction` and composeAction APIs first appeared in Thunderbird 64. They are very similar to Firefox's browserAction API.
Use a composeAction to put an icon in the message composition toolbars. In addition to its icon, a composeAction can also have a tooltip, a badge, and a popup.
.. rst-class:: api-main-section
.. api-member::
:name: [``compose_action``]
:type: (object)
.. api-member::
:name: [``browser_style``]
:type: (boolean)
.. api-member::
:name: [``default_area``]
:type: (`string`)
Defines the location the composeAction will appear by default. The default location is maintoolbar.
Supported values:
.. api-member::
:name: ``maintoolbar``
.. api-member::
:name: ``formattoolbar``
.. api-member::
:name: [``default_icon``]
:type: (string)
.. api-member::
:name: [``default_popup``]
:type: (string)
.. api-member::
:name: [``default_title``]
:type: (string)
.. api-member::
:name: [``theme_icons``]
:type: (array of :ref:`composeAction.ThemeIcons`)
Specifies icons to use for dark and light themes
.. rst-class:: api-permission-info
Note
A manifest entry named compose_action is required to use composeAction.
.. rst-class:: api-main-section
.. api-section-annotation-hack::
Sets the title of the composeAction. This shows up in the tooltip.
.. api-header::
:label: Parameters
.. api-member::
:name: ``details``
:type: (object)
.. api-member::
:name: ``title``
:type: (string or null)
The string the composeAction should display when moused over.
.. api-section-annotation-hack::
Gets the title of the composeAction.
.. api-header::
:label: Parameters
.. api-member::
:name: ``details``
:type: (:ref:`composeAction.Details`)
.. api-header::
:label: Return type (`Promise`_)
.. api-member::
:type: string
.. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
.. api-section-annotation-hack::
Sets the icon for the composeAction. 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.
.. api-header::
:label: Parameters
.. api-member::
:name: ``details``
:type: (object)
.. api-member::
:name: [``imageData``]
:type: (:ref:`composeAction.ImageDataType` or object)
Either an ImageData object or a dictionary {size -> ImageData} representing icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals ``scale``, then image with size ``scale`` * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.imageData = foo' is equivalent to 'details.imageData = {'19': foo}'
.. api-member::
:name: [``path``]
:type: (string or object)
Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals ``scale``, then image with size ``scale`` * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}'
.. api-section-annotation-hack::
Sets the html document to be opened as a popup when the user clicks on the composeAction's icon.
.. api-header::
:label: Parameters
.. api-member::
:name: ``details``
:type: (object)
.. api-member::
:name: ``popup``
:type: (string or null)
The html file to show in a popup. If set to the empty string (''), no popup is shown.
.. api-section-annotation-hack::
Gets the html document set as the popup for this composeAction.
.. api-header::
:label: Parameters
.. api-member::
:name: ``details``
:type: (:ref:`composeAction.Details`)
.. api-header::
:label: Return type (`Promise`_)
.. api-member::
:type: string
.. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
.. api-section-annotation-hack::
Sets the badge text for the composeAction. The badge is displayed on top of the icon.
.. api-header::
:label: Parameters
.. api-member::
:name: ``details``
:type: (object)
.. api-member::
:name: ``text``
:type: (string or null)
Any number of characters can be passed, but only about four can fit in the space.
.. api-section-annotation-hack::
Gets the badge text of the composeAction. If no tab nor window is specified is specified, the global badge text is returned.
.. api-header::
:label: Parameters
.. api-member::
:name: ``details``
:type: (:ref:`composeAction.Details`)
.. api-header::
:label: Return type (`Promise`_)
.. api-member::
:type: string
.. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
.. api-section-annotation-hack::
Sets the background color for the badge.
.. api-header::
:label: Parameters
.. api-member::
:name: ``details``
:type: (object)
.. api-member::
:name: ``color``
:type: (string or :ref:`composeAction.ColorArray` or null)
An array of four integers in the range [0,255] that make up the RGBA color of the badge. For example, opaque red is ``[255, 0, 0, 255]``. Can also be a string with a CSS value, with opaque red being ``#FF0000`` or ``#F00``.
.. api-section-annotation-hack::
Gets the background color of the composeAction.
.. api-header::
:label: Parameters
.. api-member::
:name: ``details``
:type: (:ref:`composeAction.Details`)
.. api-header::
:label: Return type (`Promise`_)
.. api-member::
:type: :ref:`composeAction.ColorArray`
.. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
.. api-section-annotation-hack::
Enables the composeAction for a tab. By default, a composeAction is enabled.
.. api-header::
:label: Parameters
.. api-member::
:name: [``tabId``]
:type: (integer)
The id of the tab for which you want to modify the composeAction.
.. api-section-annotation-hack::
Disables the composeAction for a tab.
.. api-header::
:label: Parameters
.. api-member::
:name: [``tabId``]
:type: (integer)
The id of the tab for which you want to modify the composeAction.
.. api-section-annotation-hack::
Checks whether the composeAction is enabled.
.. api-header::
:label: Parameters
.. api-member::
:name: ``details``
:type: (:ref:`composeAction.Details`)
.. api-section-annotation-hack::
Opens the extension popup window in the active window.
.. rst-class:: api-main-section
.. api-section-annotation-hack::
Fired when a composeAction icon is clicked. This event will not fire if the composeAction has a popup.
.. rst-class:: api-main-section
.. api-section-annotation-hack::
An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is [255, 0, 0, 255].
.. api-header:: :label: array of integer
.. api-section-annotation-hack::
Specifies to which tab or window the value should be set, or from which one it should be retrieved. If no tab nor window is specified, the global value is set or retrieved.
.. api-header::
:label: object
.. api-member::
:name: [``tabId``]
:type: (integer)
When setting a value, it will be specific to the specified tab, and will automatically reset when the tab navigates. When getting, specifies the tab to get the value from; if there is no tab-specific value, the window one will be inherited.
.. api-member::
:name: [``windowId``]
:type: (integer)
When setting a value, it will be specific to the specified window. When getting, specifies the window to get the value from; if there is no window-specific value, the global one will be inherited.
.. api-section-annotation-hack::
Pixel data for an image. Must be an ImageData object (for example, from a canvas element).
.. api-header:: :label: `ImageData <https://developer.mozilla.org/en-US/docs/Web/API/ImageData>`_
.. rst-class:: api-main-section
The following types are not defined by this API, but by the underlying Mozilla WebExtension code base. They are included here, because there is no other public documentation available.
.. api-section-annotation-hack::
Define a set of icons for themes depending on whether Thunderbird detects that the theme uses dark or light text. All provided URLs must be relative to the manifest.json file.
.. api-header::
:label: object
.. api-member::
:name: ``dark``
:type: (string)
A URL pointing to an icon. This icon displays when a theme using dark text is active (such as the Light theme, and the Default theme if no ``default_icon`` is specified).
.. api-member::
:name: ``light``
:type: (string)
A URL pointing to an icon. This icon displays when a theme using light text is active (such as the Dark theme).
.. api-member::
:name: ``size``
:type: (integer)
The size of the two icons in pixels, for example ``16`` or ``32``.