manifest-detail

Подробное изучение файла manifest.json: Ключевые поля и их значение

Файл manifest.json – это как паспорт вашего расширения. Он содержит всю необходимую информацию для Chrome, чтобы правильно установить, запустить и отобразить ваше расширение. В Модуле 2 мы коснулись основных полей, но давайте углубимся в наиболее важные из них, особенно для начинающих.

Ключевые поля manifest.json для новичков:

• manifest_version (обязательное):

  • Указывает версию формата манифеста. На данный момент рекомендуется использовать 3 для новых расширений.
  • Пример: "manifest_version": 3
  • Важность: Обеспечивает совместимость вашего расширения с текущей версией Chrome. Использование устаревшей версии может привести к проблемам.
  • Ссылка: Manifest file format

• name (обязательное):

  • Название вашего расширения. Оно будет отображаться в Chrome Web Store, на странице chrome://extensions/ и во всплывающих подсказках.
  • Пример: "name": "Мой Блокнот"
  • Важность: Идентифицирует ваше расширение для пользователей. Выберите понятное и запоминающееся название.

• version (обязательное):

  • Версия вашего расширения. Используется для управления обновлениями. Формат обычно major.minor.patch.build (например, 1.0.0.1).
  • Пример: "version": "1.0"
  • Важность: Chrome использует версию для определения, нужно ли обновлять расширение пользователя. При каждом обновлении расширения в Chrome Web Store, увеличивайте номер версии.

• description (рекомендуемое):

  • Краткое описание функциональности расширения. Отображается в Chrome Web Store и на странице chrome://extensions/.
  • Пример: "description": "Простое расширение для создания быстрых заметок прямо в браузере."
  • Важность: Помогает пользователям понять, что делает ваше расширение, и принять решение об установке. Напишите описание четко и привлекательно.

• action (рекомендуемое):

  • Определяет поведение иконки расширения в панели инструментов браузера. Заменяет устаревший browser_action.
  • default_popup: Указывает HTML-файл, который будет открываться во всплывающем окне при нажатии на иконку.
    • Пример: "default_popup": "popup.html"
  • default_icon: Набор иконок для иконки расширения разных размеров.
    • Пример:

      "default_icon": {
        "16": "images/icon16.png",
        "32": "images/icon32.png",
        "48": "images/icon48.png",
        "128": "images/icon128.png"
      }
      

  • default_title: Текст, который отображается при наведении курсора на иконку расширения.
    • Пример: "default_title": "Открыть блокнот"
  • Важность: Обеспечивает основной способ взаимодействия пользователя с расширением через иконку в панели инструментов.

• icons (рекомендуемое):

  • Набор иконок расширения разных размеров, которые используются в различных местах Chrome (страница расширений, Chrome Web Store и т.д.).
  • Пример: (аналогично default_icon в action)
  • Важность: Визуальное представление вашего расширения. Качественные иконки делают расширение более профессиональным и привлекательным.

Пример полного manifest.json для простого блокнота:

{
  "manifest_version": 3,
  "name": "Мой Блокнот",
  "version": "1.0",
  "description": "Простое расширение для создания быстрых заметок прямо в браузере.",
  "action": {
    "default_popup": "popup.html",
    "default_icon": {
      "16": "images/icon16.png",
      "32": "images/icon32.png",
      "48": "images/icon48.png",
      "128": "images/icon128.png"
    },
    "default_title": "Открыть блокнот"
  },
  "icons": {
    "16": "images/icon16.png",
    "48": "images/icon48.png",
    "128": "images/icon128.png"
  }
}

Практическое задание:

1. Измените manifest.json для расширения "Привет, мир!" из Модуля 2.
2. Добавьте default_title в action.
3. Измените name и description на более подходящие для "Привет, мир!".
4. Обновите расширение в Chrome (chrome://extensions/ -> "Обновить" на карточке расширения).
5. Проверьте, что заголовок и название расширения изменились.