Tray

아이콘과 컨텍스트 메뉴를 시스템 알림 영역에 추가합니다.

프로세스: 메인

const {app, Menu, Tray} = require('electron')

let tray = null
app.on('ready', () => {
  tray = new Tray('/path/to/my/icon') // 현재 애플리케이션 디렉터리를 기준으로 하려면 `__dirname + '/images/tray.png'` 형식으로 입력해야 합니다.
  const contextMenu = Menu.buildFromTemplate([
    {label: 'Item1', type: 'radio'},
    {label: 'Item2', type: 'radio'},
    {label: 'Item3', type: 'radio', checked: true},
    {label: 'Item4', type: 'radio'}
  ])
  tray.setToolTip('이것은 나의 애플리케이션 입니다!')
  tray.setContextMenu(contextMenu)
})

플랫폼별 한계:

• Linux에서는 앱 알림 표시기(app indicator)가 지원되면 해당 기능을 사용합니다. 만약 지원하지 않으면 GtkStatusIcon을 대신 사용합니다.
• Linux 배포판이 앱 알림 표시기만 지원하고 있다면 libappindicator1를 설치하여 트레이 아이콘이 작동하도록 만들 수 있습니다.
• 앱 알림 표시기는 컨텍스트 메뉴를 가지고 있을 때만 보입니다.
• Linux에서 앱 표시기가 사용될 경우, click 이벤트는 무시됩니다.
• Windows에선 가장 좋은 시각적 효과를 얻기 위해 ICO 아이콘을 사용하는 것을 권장합니다.
• Linux에서 각각 개별 MenuItem의 변경을 적용하려면 setContextMenu를 다시 호출해야 합니다. 예를 들면:

contextMenu.items[2].checked = false
appIcon.setContextMenu(contextMenu)

이러한 이유로 Tray API가 모든 플랫폼에서 똑같이 작동하게 하고 싶다면 click 이벤트에 의존해선 안되며 언제나 컨텍스트 메뉴를 포함해야 합니다.

Class: Tray

Tray는 EventEmitter를 상속 받았습니다.

new Tray(image)

• image NativeImage

전달된 image를 이용하여 트레이 아이콘을 만듭니다.

Instance Events

Tray 모듈은 다음과 같은 이벤트를 가지고 있습니다:

Event: 'click'

• event Event

  • altKey Boolean
  • shiftKey Boolean
  • ctrlKey Boolean
  • metaKey Boolean

• bounds Rectangle - 트레이 아이콘의 범위

트레이 아이콘이 클릭될 때 발생하는 이벤트입니다.

Event: 'right-click' macOS Windows

• event Event

  • altKey Boolean
  • shiftKey Boolean
  • ctrlKey Boolean
  • metaKey Boolean

• bounds Rectangle - 트레이 아이콘의 범위

트레이 아이콘을 오른쪽 클릭될 때 호출 됩니다.

Event: 'double-click' macOS Windows

• event Event

  • altKey Boolean
  • shiftKey Boolean
  • ctrlKey Boolean
  • metaKey Boolean

• bounds Rectangle - 트레이 아이콘의 범위

트레이 아이콘이 더블 클릭될 때 발생하는 이벤트입니다.

Event: 'balloon-show' Windows

풍선 팝업이 보여질 때 발생하는 이벤트입니다.

Event: 'balloon-click' Windows

풍선 팝업이 클릭될 때 발생하는 이벤트입니다.

Event: 'balloon-closed' Windows

풍선 팝업이 시간이 지나 사라지거나 유저가 클릭하여 닫을 때 발생하는 이벤트입니다.

Event: 'drop' macOS

드래그 가능한 아이템이 트레이 아이콘에 드롭되면 발생하는 이벤트입니다.

Event: 'drop-files' macOS

• event Event
• files String[] - 드롭된 파일의 경로

트레이 아이콘에 파일이 드롭되면 발생하는 이벤트입니다.

Event: 'drop-text' macOS

• event Event
• text String - 드롭된 텍스트의 문자열

드래그된 텍스트가 트레이 아이콘에 드롭되면 발생하는 이벤트입니다.

Event: 'drag-enter' macOS

트레이 아이콘에 드래그 작업이 시작될 때 발생하는 이벤트입니다.

Event: 'drag-leave' macOS

트레이 아이콘에 드래그 작업이 종료될 때 발생하는 이벤트입니다.

Event: 'drag-end' macOS

트레이 아이콘에 드래그 작업이 종료되거나 다른 위치에서 종료될 때 발생하는 이벤트입니다.

Instance Methods

Tray 클래스는 다음과 같은 메서드를 가지고 있습니다:

tray.destroy()

트레이 아이콘을 즉시 삭제시킵니다.

tray.setImage(image)

• image NativeImage

image를 사용하여 트레이 아이콘의 이미지를 설정합니다.

tray.setPressedImage(image) macOS

• image NativeImage

image를 사용하여 트레이 아이콘이 눌렸을 때의 이미지를 설정합니다.

tray.setToolTip(toolTip)

• toolTip String

트레이 아이콘의 툴팁 텍스트를 설정합니다.

tray.setTitle(title) macOS

• title String

상태바에서 트레이 아이콘 옆에 표시되는 제목 텍스트를 설정합니다.

tray.setHighlightMode(mode) macOS

• mode String - 다음 값 중 하나가 될 수 있는 하이라이트 모드:
  • selection - 트레이 아이콘이 클릭되었을 때와 콘텍스트 메뉴가 열렸을 때 하이라이트를 적용합니다. 이 값이 기본값입니다.
  • always - 언제나 트레이 아이콘에 하이라이트를 적용합니다.
  • never - 트레이 아이콘에 하이라이트를 아예 적용하지 않습니다.

트레이 아이콘의 배경이 하이라이팅될 때를 지정합니다. (파란색)

참고: BrowserWindow와 함께 highlightMode를 윈도우 가시성에 따라 'never'와 'always' 사이에서 키거나 끌 수 있습니다.

const {BrowserWindow, Tray} = require('electron')

const win = new BrowserWindow({width: 800, height: 600})
const tray = new Tray('/path/to/my/icon')

tray.on('click', () => {
  win.isVisible() ? win.hide() : win.show()
})
win.on('show', () => {
  tray.setHighlightMode('always')
})
win.on('hide', () => {
  tray.setHighlightMode('never')
})

tray.displayBalloon(options) Windows

• options Object
  • icon NativeImage
  • title String
  • content String

트레이에 풍선 팝업을 생성합니다.

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

• menu Menu (optional)
• position Object (optional) - 팝업 메뉴의 위치
  • x Integer
  • y Integer

트레이 아이콘의 컨텍스트 메뉴를 팝업시킵니다. menu가 전달되면, menu가 트레이 아이콘의 컨텍스트 메뉴 대신 표시됩니다.

position은 Windows에서만 사용할 수 있으며 기본값은 (0, 0)입니다.

tray.setContextMenu(menu)

• menu Menu

트레이에 컨텍스트 메뉴를 설정합니다.

tray.getBounds() macOS Windows

Returns Rectangle

이 트레이 아이콘의 Object 형식의 bounds.

tray.isDestroyed()

Returns Boolean - 트레이 아이콘이 소멸되었는지 여부.