Spec-Zone.ru › Web Extensions

sidebar_action

Тип Object
Обязательно Нет
Версия манифеста 2 или выше
Пример
"sidebar_action": {
  "default_icon": {
    "16": "button/geo-16.png",
    "32": "button/geo-32.png"
  },
  "default_title": "My sidebar",
  "default_panel": "sidebar/sidebar.html",
  "open_at_install":true
}

Панель боковой панели — это область, отображаемая слева от окна браузера, рядом со страницей веб-сайта. Браузер предоставляет интерфейс пользователя, который позволяет пользователю видеть доступные в данный момент боковые панели и выбирать боковую панель для отображения.

Ключ sidebar_action позволяет определять свойства по умолчанию для боковой панели. Вы можете изменить эти свойства во время выполнения, используя API sidebarAction.

Синтаксис

Ключ sidebar_action — это объект, который может иметь любые из перечисленных ниже свойств. Единственным обязательным свойством является default_panel.

Имя Тип Описание
browser_style Boolean

Необязательно, по умолчанию true.

Используйте это, чтобы включить таблицу стилей в свой всплывающий элемент, который сделает его согласованным с интерфейсом пользователя браузера и с другими расширениями, использующими свойство browser_style.

В Firefox, таблицу стилей можно найти по адресу chrome://browser/content/extension.css, или chrome://browser/content/extension-mac.css на macOS. При установке размеров обратите внимание, что эта таблица стилей в настоящее время устанавливает box-sizing: border-box (см. box-sizing).

Руководство по стилю Firefox описывает классы, которые вы можете применять к элементам в боковой панели, чтобы получить определенные стили.

default_icon Object или String

Используйте это, чтобы указать один или несколько значков для боковой панели. Значок отображается в интерфейсе пользователя браузера для открытия и закрытия боковых панелей.

Значки указываются как URL-адреса, относительные к файлу manifest.json.

Вы можете указать один файл значка, указав строку:

"default_icon": "path/to/geo.svg"

Чтобы указать несколько значков разных размеров, укажите здесь объект. Имя каждой свойства — высота значка в пикселях, и оно должно быть преобразуемо в целое число. Значение — URL-адрес. Например:

    "default_icon": {
      "16": "path/to/geo-16.png",
      "32": "path/to/geo-32.png"
    }

См. Выбор размеров значков для получения более подробной информации по этому вопросу.

Это необязательное свойство: если его пропустить, значок боковой панели не отображается.

default_panel String

Путь к файлу HTML, содержащему содержимое боковой панели.

Файл HTML может содержать CSS и JavaScript-файлы с помощью элементов <link> и <script>, как и обычная веб-страница.

В отличие от обычной веб-страницы, JavaScript, работающий в панели, может получить доступ ко всем API расширений WebExtension (при условии, что у расширения есть соответствующие разрешения).

Это обязательное свойство.

Это свойство переводимое.

default_title String

Заголовок боковой панели. Он используется в пользовательском интерфейсе браузера для перечисления и открытия боковых панелей и отображается в верхней части боковой панели при ее открытии.

Это необязательное свойство: если оно опущено, заголовок боковой панели — это name расширения.

Это свойство переводимое.

open_at_install Булево Необязательно, по умолчанию true. Определяет, должна ли боковая панель открываться при установке. По умолчанию боковая панель открывается после завершения установки.

Пример

"sidebar_action": {
  "default_icon": "sidebar.svg",
  "default_title": "My sidebar!",
  "default_panel": "sidebar.html",
  "browser_style": true
}

Для простого примера расширения, использующего боковую панель, см. annotate-page.

Совместимость с браузером

Рабочий стол Мобильный
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari на IOS Samsung Internet
sidebar_action Нет Нет 54 ? 30 Нет ? ? Нет ? Нет ?
browser_style Нет Нет 55 ? Нет Нет ? ? Нет ? Нет ?
default_icon Нет Нет 54 ?
30Значки SVG не поддерживаются.
Нет ? ? Нет ? Нет ?
default_panel Нет Нет 54 ? 30 Нет ? ? Нет ? Нет ?
default_title Нет Нет 54 ? 30 Нет ? ? Нет ? Нет ?
open_at_install Нет Нет 62 ? Нет Нет ? ? Нет ? Нет ?

См. также

  • browser_action
  • page_action
  • Стили браузера

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/sidebar_action

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API