Skip to content

Commit

Permalink
no longer use toolbar action to not confuse users
Browse files Browse the repository at this point in the history
  • Loading branch information
jobisoft committed Mar 12, 2021
1 parent 0910c15 commit 66a91d7
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 32 deletions.
32 changes: 16 additions & 16 deletions browserAction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ __ https://github.com/thundernest/sample-extensions

.. role:: permission

Use toolbar actions to put icons in the mail window toolbar. In addition to its icon, a toolbar action can also have a tooltip, a badge, and a popup. This namespace is called browserAction for compatibility with browser WebExtensions.
Use a browserAction to put an icon in the mail window toolbar. In addition to its icon, a browserAction can also have a tooltip, a badge, and a popup. This namespace is called browserAction for compatibility with browser WebExtensions.

.. rst-class:: api-main-section

Expand Down Expand Up @@ -77,7 +77,7 @@ setTitle(details)

.. api-section-annotation-hack::

Sets the title of the toolbar action. This shows up in the tooltip.
Sets the title of the browserAction. This shows up in the tooltip.

.. api-header::
:label: Parameters
Expand All @@ -91,7 +91,7 @@ Sets the title of the toolbar action. This shows up in the tooltip.
:name: ``title``
:type: (string or null)

The string the toolbar action should display when moused over.
The string the browserAction should display when moused over.



Expand All @@ -102,7 +102,7 @@ getTitle(details)

.. api-section-annotation-hack::

Gets the title of the toolbar action.
Gets the title of the browserAction.

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -130,7 +130,7 @@ setIcon(details)

.. api-section-annotation-hack::

Sets the icon for the toolbar 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.
Sets the icon for the browserAction. 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
Expand Down Expand Up @@ -162,7 +162,7 @@ setPopup(details)

.. api-section-annotation-hack::

Sets the html document to be opened as a popup when the user clicks on the toolbar action's icon.
Sets the html document to be opened as a popup when the user clicks on the browserAction's icon.

.. api-header::
:label: Parameters
Expand All @@ -187,7 +187,7 @@ getPopup(details)

.. api-section-annotation-hack::

Gets the html document set as the popup for this toolbar action.
Gets the html document set as the popup for this browserAction.

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -215,7 +215,7 @@ setBadgeText(details)

.. api-section-annotation-hack::

Sets the badge text for the toolbar action. The badge is displayed on top of the icon.
Sets the badge text for the browserAction. The badge is displayed on top of the icon.

.. api-header::
:label: Parameters
Expand All @@ -240,7 +240,7 @@ getBadgeText(details)

.. api-section-annotation-hack::

Gets the badge text of the toolbar action. If no tab nor window is specified is specified, the global badge text is returned.
Gets the badge text of the browserAction. If no tab nor window is specified is specified, the global badge text is returned.

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -293,7 +293,7 @@ getBadgeBackgroundColor(details)

.. api-section-annotation-hack::

Gets the background color of the toolbar action.
Gets the background color of the browserAction.

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -321,7 +321,7 @@ enable([tabId])

.. api-section-annotation-hack::

Enables the toolbar action for a tab. By default, toolbar actions are enabled.
Enables the browserAction for a tab. By default, a browserAction is enabled.

.. api-header::
:label: Parameters
Expand All @@ -331,7 +331,7 @@ Enables the toolbar action for a tab. By default, toolbar actions are enabled.
:name: [``tabId``]
:type: (integer)

The id of the tab for which you want to modify the toolbar action.
The id of the tab for which you want to modify the browserAction.


.. _browserAction.disable:
Expand All @@ -341,7 +341,7 @@ disable([tabId])

.. api-section-annotation-hack::

Disables the toolbar action for a tab.
Disables the browserAction for a tab.

.. api-header::
:label: Parameters
Expand All @@ -351,7 +351,7 @@ Disables the toolbar action for a tab.
:name: [``tabId``]
:type: (integer)

The id of the tab for which you want to modify the toolbar action.
The id of the tab for which you want to modify the browserAction.


.. _browserAction.isEnabled:
Expand All @@ -361,7 +361,7 @@ isEnabled(details)

.. api-section-annotation-hack::

Checks whether the toolbar action is enabled.
Checks whether the browserAction is enabled.

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -393,7 +393,7 @@ onClicked()

.. api-section-annotation-hack::

Fired when a toolbar action icon is clicked. This event will not fire if the toolbar action has a popup.
Fired when a browserAction icon is clicked. This event will not fire if the browserAction has a popup.

.. rst-class:: api-main-section

Expand Down
32 changes: 16 additions & 16 deletions composeAction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ __ https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/br

.. role:: permission

Use toolbar actions to put icons in the message composition toolbars. In addition to its icon, a toolbar action can also have a tooltip, a badge, and a popup.
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

Expand Down Expand Up @@ -82,7 +82,7 @@ setTitle(details)

.. api-section-annotation-hack::

Sets the title of the toolbar action. This shows up in the tooltip.
Sets the title of the composeAction. This shows up in the tooltip.

.. api-header::
:label: Parameters
Expand All @@ -96,7 +96,7 @@ Sets the title of the toolbar action. This shows up in the tooltip.
:name: ``title``
:type: (string or null)

The string the toolbar action should display when moused over.
The string the composeAction should display when moused over.



Expand All @@ -107,7 +107,7 @@ getTitle(details)

.. api-section-annotation-hack::

Gets the title of the toolbar action.
Gets the title of the composeAction.

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -135,7 +135,7 @@ setIcon(details)

.. api-section-annotation-hack::

Sets the icon for the toolbar 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.
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
Expand Down Expand Up @@ -167,7 +167,7 @@ setPopup(details)

.. api-section-annotation-hack::

Sets the html document to be opened as a popup when the user clicks on the toolbar action's icon.
Sets the html document to be opened as a popup when the user clicks on the composeAction's icon.

.. api-header::
:label: Parameters
Expand All @@ -192,7 +192,7 @@ getPopup(details)

.. api-section-annotation-hack::

Gets the html document set as the popup for this toolbar action.
Gets the html document set as the popup for this composeAction.

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -220,7 +220,7 @@ setBadgeText(details)

.. api-section-annotation-hack::

Sets the badge text for the toolbar action. The badge is displayed on top of the icon.
Sets the badge text for the composeAction. The badge is displayed on top of the icon.

.. api-header::
:label: Parameters
Expand All @@ -245,7 +245,7 @@ getBadgeText(details)

.. api-section-annotation-hack::

Gets the badge text of the toolbar action. If no tab nor window is specified is specified, the global badge text is returned.
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
Expand Down Expand Up @@ -298,7 +298,7 @@ getBadgeBackgroundColor(details)

.. api-section-annotation-hack::

Gets the background color of the toolbar action.
Gets the background color of the composeAction.

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -326,7 +326,7 @@ enable([tabId])

.. api-section-annotation-hack::

Enables the toolbar action for a tab. By default, toolbar actions are enabled.
Enables the composeAction for a tab. By default, a composeAction is enabled.

.. api-header::
:label: Parameters
Expand All @@ -336,7 +336,7 @@ Enables the toolbar action for a tab. By default, toolbar actions are enabled.
:name: [``tabId``]
:type: (integer)

The id of the tab for which you want to modify the toolbar action.
The id of the tab for which you want to modify the composeAction.


.. _composeAction.disable:
Expand All @@ -346,7 +346,7 @@ disable([tabId])

.. api-section-annotation-hack::

Disables the toolbar action for a tab.
Disables the composeAction for a tab.

.. api-header::
:label: Parameters
Expand All @@ -356,7 +356,7 @@ Disables the toolbar action for a tab.
:name: [``tabId``]
:type: (integer)

The id of the tab for which you want to modify the toolbar action.
The id of the tab for which you want to modify the composeAction.


.. _composeAction.isEnabled:
Expand All @@ -366,7 +366,7 @@ isEnabled(details)

.. api-section-annotation-hack::

Checks whether the toolbar action is enabled.
Checks whether the composeAction is enabled.

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -398,7 +398,7 @@ onClicked()

.. api-section-annotation-hack::

Fired when a toolbar action icon is clicked. This event will not fire if the toolbar action has a popup.
Fired when a composeAction icon is clicked. This event will not fire if the composeAction has a popup.

.. rst-class:: api-main-section

Expand Down

0 comments on commit 66a91d7

Please sign in to comment.