Electron tray mac os

Документация Electron

Docs / API / Tray v15.0.0

Class: Tray

Добавить иконки и контекстные меню в системную область уведомлений.

Ограничения платформ:

• В Linux индикатор приложения будет использован, если он поддерживается, иначе будет использован GtkStatusIcon .
• В дистрибутивах Linux, которые поддерживают только индикаторы приложений, вы должны установите libappindicator1 , чтобы значок в трее заработал.
• Индикатор приложения будет отображаться только при наличии контекстного меню.
• Когда индикатор приложения используется в Linux, событие click игнорируется.
• On Linux in order for changes made to individual MenuItem s to take effect, you have to call setContextMenu again. Например:

• В Windows рекомендуется использовать значки ICO для получения лучших визуальных эффектов.

Если вы хотите сохранить одинаковое поведение на всех платформах, вам не следует полагаться на событие click и всегда прикреплять контекстное меню к значку в трее.

new Tray(image, [guid])

• image (NativeImage | String)
• guid String (optional) Windows — Assigns a GUID to the tray icon. If the executable is signed and the signature contains an organization in the subject line then the GUID is permanently associated with that signature. OS level settings like the position of the tray icon in the system tray will persist even if the path to the executable changes. If the executable is not code-signed then the GUID is permanently associated with the path to the executable. Changing the path to the executable will break the creation of the tray icon and a new GUID must be used. However, it is highly recommended to use the GUID parameter only in conjunction with code-signed executable. If an App defines multiple tray icons then each icon must use a separate GUID.

Создаёт новую иконку в трее, связанную с image .

События экземпляра

Модуль Tray генерирует следующие события:

Событие: ‘click’

• event KeyboardEvent
• bounds Rectangle — границы иконки в трее.
• position Point — позиция события.

Вызывается при двойном клике на иконке в трее.

Событие: ‘right-click’ macOS Windows

Возникает при правом клике на иконке в трее.

Событие: ‘double-click’ macOS Windows

Вызывается при двойном нажатии на иконку в трее.

Событие: ‘balloon-show’ Windows

Возникает при всплывающем сообщении в трее.

Событие: ‘balloon-click’ Windows

Вызывается при клике на всплывающем сообщении в трее.

Событие: ‘balloon-closed’ Windows

Возникает, когда всплывающее сообщение в трее закрыто из-за тайм-аута или вручную пользователем.

Событие: ‘drop’ macOS

Возникает при перетаскивании элементов на значок в трее.

Событие: ‘drop-files’ macOS

• Событие типа event
• files String[] — пути брошенных файлов.

Возникает при перетаскивании файлов на значок в трее.

Событие: ‘drop-text’ macOS

• Событие типа event
• text String — брошенная текстовая строка.

Возникает при перетаскивании строки на значок в трее.

Событие: ‘drag-enter’ macOS

Возникает, когда операция перетаскивания происходит на иконке в трее.

Событие: ‘drag-leave’ macOS

Возникает, когда операция перетаскивания завершилась на иконке в трее.

Событие: ‘drag-end’ macOS

Возникает, когда операция перетаскивания заканчивается в трее или заканчивается в другом месте.

Event: ‘mouse-up’ macOS

Emitted when the mouse is released from clicking the tray icon.

Note: This will not be emitted if you have set a context menu for your Tray using tray.setContextMenu , as a result of macOS-level constraints.

Event: ‘mouse-down’ macOS

Emitted when the mouse clicks the tray icon.

Событие: ‘mouse-enter’ macOS

Возникает при входе курсора мыши на иконку в трее.

Событие: ‘mouse-leave’ macOS

Возникает при выходе курсора мыши с иконки в трее.

Событие: ‘mouse-move’ macOS Windows

Возникает при перемещении мыши на значке в трее.

Методы экземпляра

Класс Tray имеет следующие методы:

tray.destroy()

Немедленно уничтожить иконку в трее.

tray.setImage(image)

Устанавливает image ассоциированный с значком в трее.

tray.setPressedImage(image) macOS

Устанавливает image , связанное с этим значком в трее, при нажатии в macOS.

tray.setToolTip(toolTip)

Устанавливает текст отображаемый при наведении на значок в трее.

tray.setTitle(title[, options]) macOS

• title String
• options Object (опционально)
  • fontType String (опционально) — Вариант семейства шрифтов для отображения, может быть моноширинным или цифро-моноширинным . monospaced is available in macOS 10.15+ and monospacedDigit is available in macOS 10.11+. По умолчанию используют системный шрифт по умолчанию.

Устанавливает заголовок, отображаемый рядом со значком в строке состояния (поддержка ANSI цветов).

tray.getTitle() macOS

Возвращает String — заголовок, отображаемый рядом со значком в области уведомлений в строке состояния

tray.setIgnoreDoubleClickEvents(ignore) macOS

Sets the option to ignore double click events. Ignoring these events allows you to detect every individual click of the tray icon.

Значение по умолчанию установлено в значение false.

tray.getIgnoreDoubleClickEvents() macOS

Возвращает Boolean — будет ли игнорироваться события двойного щелчка.

tray.displayBalloon(options) Windows

• options Object
  • icon (NativeImage | String) (optional) — Icon to use when iconType is custom .
  • iconType String (optional) — Can be none , info , warning , error or custom . По умолчанию — custom .
  • title String
  • content String
  • largeIcon Boolean (optional) — The large version of the icon should be used. По умолчанию — true . Maps to NIIF_LARGE_ICON .
  • noSound Boolean (опционально) — Не проигрывать соответствующий звук. По умолчанию — false . Maps to NIIF_NOSOUND .
  • respectQuietTime Boolean (optional) — Do not display the balloon notification if the current user is in «quiet time». По умолчанию — false . Maps to NIIF_RESPECT_QUIET_TIME .

Отображает всплывающее сообщение в трее.

tray.removeBalloon() Windows

Удаляет всплывающее уведомление в трее.

tray.focus() Windows

Возвращает фокус в область уведомления панели задач. Notification area icons should use this message when they have completed their UI operation. For example, if the icon displays a shortcut menu, but the user presses ESC to cancel it, use tray.focus() to return focus to the notification area.

tray.popUpContextMenu([menu, position]) macOS Windows

• menu Menu (опционально)
• position Point (optional) — позиция всплывающего сообщения.

Pops up the context menu of the tray icon. When menu is passed, the menu will be shown instead of the tray icon’s context menu.

position доступна только для Windows, и это (0, 0) по умолчанию.

tray.closeContextMenu() macOS Windows

Closes an open context menu, as set by tray.setContextMenu() .

tray.setContextMenu(menu)

Устанавливает контекстное меню для этого значка.

tray.getBounds() macOS Windows

bounds значка в трее как Object .

tray.isDestroyed()

Возвращает Boolean — уничтожен ли значок в трее.

Источник

Процедура нотаризации Electron приложения для macOS 10.14.5

С выходом macOS 10.14.5, Apple добавила обязательную процедуру нотаризации (Notarization process) приложений перед их распространением. Что это и какие сложности возникли с этим обновлением при разработке на Electron.js я и хотел бы рассказать.

Введение

Спустя 2 года после бума Electron.js, все горячие холивары о том насколько он плох и зачем нужен — затихли. Давайте не будем разжигать их заново в комментариях. Спасибо.

На нашем проекте используется electron-builder для сборки приложения, но и для electron-packager эта процедура будет примерно аналогична.

Сам проект представляет из себя лаунчер для облачного гейминга, через который запускается нативный клиент для доступа к удаленному компьютеру.

Подписание приложения c electron-builder не выглядит сложным, но для полноты картины, я в кратце расскажу и об этой процедуре. Если у вас нет проблем с подписанием приложения, можете пропустить эту главу.

Подписание приложения

Для подписания приложения нам необходимо экспортировать сертификаты из личного кабинета разработчика Apple. Нам потребуются:

• Developer ID Application
• Developer ID Installer
• *3rd Party Mac Developer Application и 3rd Party Mac Developer Installer (Если планируется публиковать приложение в AppStore)

Сертификат Developer ID Installer выпускается под определенное приложение, для этого необходим bundleID. У electron-builder он задается параметром «appId» в package.json

Сертификаты необходимо собрать в единый файл. Для этого добавляем их в keychain (2 клика по сертификату).
Затем переходим в keychain, выбираем нужные сертификаты и в контекстном меню нажимаем «export items». После экcпорта мы получаем один файл с расширением .p12.

После полученного файла сертификата, добавляем следующие записи в переменные окружения

• CSC_LINK (путь до файла сертификата .p12)
• CSC_KEY_PASSWORD (пароль доступа к сертификату)

Если не добавлять эти переменные, то сборщик будет автоматически искать подходящие ключи в хранилище keychain. Добавление этих записей, позволяет точно определить сертификаты, которые вы хотите использовать для подписи.

После этих операций, вы можете запускать процесс сборки и всё должно пройти гладко.

Гладко это работало до выхода macOS 10.14.5.

Что изменилось с выходом macOS 10.14.5

Небольшое отступление. Выполняя ночью последние работы над новым патчем, решил оставить сборку продакшн версии на утро. Заметив, что пришло обновление на macOS запустил его и пошел спать.

На следующее утро с удивлением увидел, что сборка падает от незнакомой ошибки в момент подписания приложения — «Unnotarized Developer ID».

Не откладывай на завтра то, что можно сделать сегодня. Бенджамин Франклин

Суть проблемы

Начиная с macOS 10.14.5, Apple ввела обязательную процедуру нотаризации. Первая статья Apple об этом была в 2018 году, но именно с этим обновлением эта процедура стала обязательной. Как она выглядит.

Вы собираете приложение -> отправляете его на сервер Apple -> Apple заверяет его -> Возвращает статус успешного заверения -> Выполняется команда установки штампа заверения.

Для разработчиков на Xcode необходимо просто поставить галочку о нотаризации

Так же процесс нотаризации собранного приложения можно выполнить командой в терминале.

• primary-bundle-id — bundleID приложения
• username — логин пользователя на developer.apple.com
• password — «app-specific password». Его можно создать в личном кабинете appleid.apple.com под учеткой разработчика.

Если не выполнить процедуру нотаризации, то при попытке пользователя установить приложение, вылетает окошко с ошибкой. За проверку на безопасность приложения отвечает gatekeeper. Именно он и ломал сборку приложения на electron-builder.

Как выглядел процесс сборки electron-builder

После сборки приложения в .app файл, с помощью утилиты electron-osx-sign происходило подписание приложения. После подписания сертификатом запускался процесс проверки приложения gatekepper’ом. Но с выходом обновления gatekeeper стал проверять и корректную нотаризацию приложения, это и не давало успешно завершить процедуру подписания приложения.

Патч для возможности нотаризации

Github пользователь Kallin довольно оперативно предложил коммит решения, с добавлением двух новых параметров в настройки. Первый это «gatekeeperAssess» — отключает валидацию сборки после подписания и второй «sign» — который отключает подписание сертификатом установочного файла(dmg). Данный коммит вошел в релиз electron-builder 20.43.0.

Для самого процесса нотаризации у electron-userland есть модуль electron-notarize, который выполняет эту задачу, нужно лишь написать небольшой скрипт и запустить его, используя хук afterSign.

Процесс подписания и нотаризации приложения

Первоначально нужно проверить, что у вас установлен electron-builder версии >=20.43.0 и установить пакет electron-notarize.

В переменные окружения добавим 2 записи:

• appleId — логин developer.apple.com
• appleASP — «app-specific password», который можно создать в личном кабинете appleid.apple.com.

Теперь создадим скрипт нотаризации, который будет выполняться после подписания приложения.

Сохраняем его в удобном для вас месте.

Так же для корректной нотаризации нам потребуется определить права доступа
к ресурсам системы для нашего приложения. Для этого создадим файл build/entitlements.mac.inherit.plist

Содержимое файла в моем случае. Для вас может быть другая конфигурация. Описание всех полей.
Обязательным для Electron.js является — com.apple.security.cs.allow-unsigned-executable-memory.

Теперь обновим настройки в package.json

В разделе для macOS:

• gatekeeperAssess (отключает валидацию приложения на стороне electron-osx-sign)
• hardenedRuntime (позволяет создать перечень разрешений безопасности и доступа к ресурсам системы)
• entitlements (путь к файлу резрешений доступа для нашего приложения)

В общем разделе настроек electron-builder:

• afterSign (путь до скрипта нотаризации, который будет зупущен после подписания приложения)

Запускаем процесс сборки. Может показаться, что он немного подвис, но передача файла на сервер Apple и ожидание ответа занимает какое-то время (от 3 до 10 минут)

Состояние нотаризации можно посмотреть в терминале, выполнив команду:

$ xcrun altool —notarization-history 0 -u $appleId -p $appleASP

Ответ будет представлен таблицей. Поле статус может иметь значение ‘process’, ‘approved’, ‘invalid’

При статусе ‘invalid’ по номеру запроса можно посмотреть, что именно пошло не так.

$ xcrun altool —notarization-info «RequestUUID» -u $appleId

Вот и весь процесс подписания и нотаризации. Надеюсь, моя статья окажется вам полезна. Спасибо.

Небольшое дополнение

При передаче приложения для тестирования, обнаружился интересный глюк. Приложение полученное через Телеграм, просто отказывалось запускаться. При просмотре логов обнаружилось, что приложение помещено в карантин Телеграмом. По какой причине и как это произошло, я не смог найти ответ. При отправке файла через Яндекс.Диск( или любой другой способ, чтобы скачать через браузер) такой проблемы не возникает.

Источник