Skip to content

Commit

Permalink
A few description changes for the theme API (modified in c-c)
Browse files Browse the repository at this point in the history
  • Loading branch information
jobisoft committed Feb 6, 2021
1 parent affdbad commit e5ce6c3
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions theme.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/manife

.. role:: permission

The theme API allows customizing of visual elements of the browser.
The theme API allows customizing of visual elements of Thunderbird.

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

Expand Down Expand Up @@ -175,26 +175,54 @@ ThemeColor

.. api-section-annotation-hack::

Defines a color value.

.. api-header::
:label: string


.. container:: api-member-node

.. container:: api-member-description-only

A string containing a valid `CSS color string <https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#color_keywords>`__ or a hexadecimal representation. For example ``crimson`` or ``#dc143c``.


OR

.. api-header::
:label: array of integer


.. container:: api-member-node

.. container:: api-member-description-only

An RGB array of 3 integers. For example ``[220, 20, 60]`` for the color *crimson*.


OR

.. api-header::
:label: array of number


.. container:: api-member-node

.. container:: api-member-description-only

An RGBA array of 3 integers and a fractional (a float between 0 and 1). For example ``[220, 20, 60, 0.5]`` for the color *crimson* with 50% opacity.


.. _theme.ThemeExperiment:

ThemeExperiment
---------------

.. api-section-annotation-hack::

Defines additional color, image and property keys to be used in :ref:`theme.ThemeType`, extending the theme-able areas of Thunderbird.

.. api-header::
:label: object

Expand Down Expand Up @@ -259,6 +287,8 @@ ThemeType

.. api-section-annotation-hack::

Contains the color, image and property settings of a theme.

.. api-header::
:label: object

Expand Down Expand Up @@ -567,7 +597,7 @@ ThemeType
:name: [``additional_backgrounds``]
:type: (array of string)

Additional images added on the header area and displayed behind the 'theme_frame' image.
URLs of additional images added to the header area and displayed behind the 'theme_frame' image.


.. api-member::
Expand All @@ -579,7 +609,7 @@ ThemeType
:name: [``theme_frame``]
:type: (string)

Foreground image on the header area.
URL of a foreground image on the header area.



Expand Down

0 comments on commit e5ce6c3

Please sign in to comment.