Skip to content

Latest commit

 

History

History
221 lines (124 loc) · 4.29 KB

browserSettings.rst

File metadata and controls

221 lines (124 loc) · 4.29 KB

≡ browserSettings API

browserSettings API

Use the browser.browserSettings API to control global settings of the browser.

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

Permissions

.. api-member::
   :name: :permission:`browserSettings`

   Read and modify browser settings


.. rst-class:: api-permission-info

Note

The permission browserSettings is required to use messenger.browserSettings.*.

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

Types

ColorManagementMode

.. api-section-annotation-hack::

Color management mode.

.. api-header::
   :label: `string`


   .. container:: api-member-node

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

         Supported values:

         .. api-member::
            :name: :value:`off`

         .. api-member::
            :name: :value:`full`

         .. api-member::
            :name: :value:`tagged_only`

ContextMenuMouseEvent

.. api-section-annotation-hack::

After which mouse event context menus should popup.

.. api-header::
   :label: `string`


   .. container:: api-member-node

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

         Supported values:

         .. api-member::
            :name: :value:`mouseup`

         .. api-member::
            :name: :value:`mousedown`

ImageAnimationBehavior

.. api-section-annotation-hack::

How images should be animated in the browser.

.. api-header::
   :label: `string`


   .. container:: api-member-node

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

         Supported values:

         .. api-member::
            :name: :value:`normal`

         .. api-member::
            :name: :value:`none`

         .. api-member::
            :name: :value:`once`



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

Properties

allowPopupsForUserEvents

.. api-section-annotation-hack::

Allows or disallows pop-up windows from opening in response to user events.

cacheEnabled

.. api-section-annotation-hack::

Enables or disables the browser cache.

contextMenuShowEvent

.. api-section-annotation-hack::

Controls after which mouse event context menus popup. This setting's value is of type ContextMenuMouseEvent, which has possible values of mouseup and mousedown.

ftpProtocolEnabled

.. api-section-annotation-hack::

Returns whether the FTP protocol is enabled. Read-only.

imageAnimationBehavior

.. api-section-annotation-hack::

Controls the behaviour of image animation in the browser. This setting's value is of type ImageAnimationBehavior, defaulting to normal.

overrideContentColorScheme

.. api-section-annotation-hack::

This setting controls whether a light or dark color scheme overrides the page's preferred color scheme.

overrideDocumentColors

.. api-section-annotation-hack::

This setting controls whether the user-chosen colors override the page's colors.

useDocumentFonts

.. api-section-annotation-hack::

This setting controls whether the document's fonts are used.

webNotificationsDisabled

.. api-section-annotation-hack::

Disables webAPI notifications.

zoomFullPage

.. api-section-annotation-hack::

This boolean setting controls whether zoom is applied to the full page or to text only.