electron/docs/api/touch-bar-popover.md
Samuel Attard 22fb4f85e5
docs: document what experimental means explicitly (#22893)
* docs: document what experimental means explicitly

* Apply suggestions from code review

Co-Authored-By: Jeremy Apthorp <jeremya@chromium.org>

* Update experimental.md

Co-authored-by: Jeremy Apthorp <jeremya@chromium.org>
2020-04-02 09:32:18 -07:00

1,011 B

Class: TouchBarPopover

Create a popover in the touch bar for native macOS applications

Process: Main

new TouchBarPopover(options)

  • options Object
    • label String (optional) - Popover button text.
    • icon NativeImage (optional) - Popover button icon.
    • items TouchBar - Items to display in the popover.
    • showCloseButton Boolean (optional) - true to display a close button on the left of the popover, false to not show it. Default is true.

Instance Properties

The following properties are available on instances of TouchBarPopover:

touchBarPopover.label

A String representing the popover's current button text. Changing this value immediately updates the popover in the touch bar.

touchBarPopover.icon

A NativeImage representing the popover's current button icon. Changing this value immediately updates the popover in the touch bar.