Class HSMenuBarItem

constructor

• new HSMenuBarItem(): HSMenuBarItem

  Returns HSMenuBarItem

title

destroy

• destroy(): void

  Permanently remove this item from the menu bar and release all resources. After calling destroy(), the item is no longer usable. This is called automatically on hs.reload(). Use hide() instead if you only want to temporarily remove the item without freeing it.

  Returns void

hide

• hide(): void

  Remove this item from the menu bar. The item is retained and can be shown again with show().

  Returns void

isVisible

• isVisible(): boolean

  Check if this item is currently visible in the menu bar.

  Returns boolean

  true if the item is visible in the menu bar

setClickCallback

• setClickCallback(fn: (() => void) | null): void

  Set a callback invoked when the item is clicked (only fires when no menu is set)

  Parameters

  • fn: (() => void) | null

    A function to call on click, or null to remove the callback

  Returns void

setIcon

• setIcon(image: HSImage | null): void

  Set the icon displayed in the menu bar

  Parameters

  • image: HSImage | null

    An HSImage object, or null to remove the icon

  Returns void

setMenu

• setMenu(
      menuOrFn: Record<string, any>[] | (() => Record<string, any>[]) | null,
  ): void

  Set the menu for this item. Pass an array of menu item objects for a static menu, or a function that returns an array for a dynamic menu populated each time it opens.

  Parameters

  • menuOrFn: Record<string, any>[] | (() => Record<string, any>[]) | null

    Array of menu item objects, a function returning such an array, or null to remove the menu

  Returns void

setTooltip

• setTooltip(tooltip: string | null): void

  Set the tooltip shown when hovering over the menu bar item

  Parameters

  • tooltip: string | null

    Tooltip text, or null to remove the tooltip

  Returns void

show

• show(): void

  Show this item in the menu bar.

  Returns void