menubar

​
Create and manage menubar icons
API Overview
Constants - Useful values which cannot be changed
​priorities​
Constructors - API calls which return an object, typically one that offers API methods
​new​
​newWithPriority​
Methods - API calls which can only be made on an object returned by a constructor
​delete​
​frame​
​icon​
​isInMenuBar​
​popupMenu​
​priority​
​removeFromMenuBar​
​returnToMenuBar​
​setClickCallback​
​setIcon​
​setMenu​
​setTitle​
​setTooltip​
​stateImageSize​
​title​
API Documentation
Constants
​priorities​
Signature
hs.menubar.priorities[]
Type
Constant
Description
Pre-defined list of priority levels which can be used for positioning menubar items.
Constructors
​new​
Signature
hs.menubar.new([inMenuBar]) -> menubaritem or nil
Type
Constructor
Description
Creates a new menu bar item object and optionally add it to the system menubar
Parameters
inMenuBar -- an optional parameter which defaults to true. If it is true, the menubaritem is added to the system menubar, otherwise the menubaritem is hidden.
Returns
menubar item object to use with other API methods, or nil if it could not be created
Notes
You should call hs.menubar:setTitle() or hs.menubar:setIcon() after creating the object, otherwise it will be invisible
​newWithPriority​
Signature
hs.menubar.newWithPriority(priority) -> menubaritem or nil
Type
Constructor
Description
Creates a new menu bar item object with the specified priority
Parameters
priority - an integer specifying the menubar item's priority. A menubar item's position is determined by its priority value.
Returns
menubar item object to use with other API methods, or nil if it could not be created
Notes
Default priority levels can be found in the hs.menubar.priorities table.
Methods
​delete​
Signature
hs.menubar:delete()
Type
Method
Description
Removes the menubar item from the menubar and destroys it
Parameters
None
Returns
None
​frame​
Signature
hs.menubar:frame() -> hs.geometry rect
Type
Method
Description
Returns the menubar item frame
Parameters
None
Returns
an hs.geometry rect describing the menubar item's frame or nil if the menubar item is not currently in the menubar.
Notes
This will return a frame even if no icon or title is set
​icon​
Signature
hs.menubar:icon() -> hs.image object
Type
Method
Description
Returns the current icon of the menubar item object.
Parameters
None
Returns
the menubar item icon as an hs.image object, or nil, if there isn't one.
​isInMenuBar​
Signature
hs.menubar:isInMenuBar() -> boolean
Type
Method
Description
Returns a boolean indicating whether or not the specified menu is currently in the OS X menubar.
Parameters
None
Returns
a boolean indicating whether or not the specified menu is currently in the OS X menubar
​popupMenu​
Signature
hs.menubar:popupMenu(point[, darkMode]) -> menubaritem
Type
Method
Description
Display a menubaritem as a pop up menu at the specified screen point.
Parameters
point - the location of the upper left corner of the pop-up menu to be displayed.
darkMode - (optional) true to force the menubar dark (defaults to your macOS General Appearance settings)
Returns
The menubaritem
Notes
Items which trigger hs.menubar:setClickCallback() will invoke the callback function, but we cannot control the positioning of any visual elements the function may create -- calling this method on such an object is the equivalent of invoking its callback function directly.
This method is blocking. Hammerspoon will be unable to respond to any other activity while the pop-up menu is being displayed.
darkMode uses an undocumented macOS API call, so may break in a future release.
​priority​
| Signature | hs.menubar:priority([priority]) -> menubaritem | current-value | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Get or set a menubar item's priority | | Parameters |
priority - an optional integer specifying the menubar item's priority. A menubar item's position is determined by its priority value.
| | Returns |
if a priority is provided, then the menubaritem object is returned; otherwise the current priority value is returned.
| | Notes |
Default priority levels can be found in the hs.menubar.priorities table.
|
​removeFromMenuBar​
Signature
hs.menubar:removeFromMenuBar() -> menubaritem
Type
Method
Description
Removes a menu from the system menu bar. The item can still be used as a pop-up menu, unless you also delete it.
Parameters
None
Returns
the menubaritem
​returnToMenuBar​
Signature
hs.menubar:returnToMenuBar() -> menubaritem
Type
Method
Description
Returns a previously removed menu back to the system menu bar.
Parameters
None
Returns
the menubaritem
​setClickCallback​
Signature
hs.menubar:setClickCallback([fn]) -> menubaritem
Type
Method
Description
Registers a function to be called when the menubar item is clicked
Parameters
fn - An optional function to be called when the menubar item is clicked. If this argument is not provided, any existing function will be removed. The function can optionally accept a single argument, which will be a table containing boolean values indicating which keyboard modifiers were held down when the menubar item was clicked; The possible keys are:
cmd
alt
shift
ctrl
fn
Returns
the menubaritem
Notes
If a menu has been attached to the menubar item, this callback will never be called
Has no affect on the display of a pop-up menu, but changes will be be in effect if hs.menubar:returnToMenuBar() is called on the menubaritem.
​setIcon​
Signature
hs.menubar:setIcon(imageData[, template]) -> menubaritem or nil
Type
Method
Description
Sets the image of a menubar item object. The image will be displayed in the system menubar
Parameters
imageData - This can one of the following:
An hs.image object
A string containing a path to an image file
A string beginning with ASCII: which signifies that the rest of the string is interpreted as a special form of ASCII diagram, which will be rendered to an image and used as the icon. See the notes below for information about the special format of ASCII diagram.
nil, indicating that the current image is to be removed
template - An optional boolean value which defaults to true. If it's true, the provided image will be treated as a "template" image, which allows it to automatically support OS X 10.10's Dark Mode. If it's false, the image will be used as is, supporting colour.
Returns
the menubaritem if the image was loaded and set, nil if it could not be found or loaded
Notes
API Change
This method used to return true on success -- this has been changed to return the menubaritem on success to facilitate method chaining. Since Lua treats any value which is not nil or false as "true", this should only affect code where the return value was actually being compared to true, e.g. if result == true then... rather than the (unaffected) if result then....
​setMenu​
Signature
hs.menubar:setMenu(menuTable) -> menubaritem
Type
Method
Description
Attaches a dropdown menu to the menubar item
Parameters
menuTable:
If this argument is nil:
Removes any previously registered menu
If this argument is a table:
Sets the menu for this menubar item to the supplied table. The format of the table is documented below
If this argument is a function:
The function will be called each time the user clicks on the menubar item and the function should return a table that specifies the menu to be displayed. The table should be of the same format as described below. The function can optionally accept a single argument, which will be a table containing boolean values indicating which keyboard modifiers were held down when the menubar item was clicked; The possible keys are:
cmd
alt
shift
ctrl
fn
Returns
the menubaritem
Notes
If you are using the callback function, you should take care not to take too long to generate the menu, as you will block the process and the OS may decide to remove the menubar item
​setTitle​
Signature
hs.menubar:setTitle(title) -> menubaritem
Type
Method
Description
Sets the title of a menubar item object. The title will be displayed in the system menubar
Parameters
title - A string or hs.styledtext object to use as the title, or nil to remove the title
Returns
the menubar item
Notes
If you set an icon as well as a title, they will both be displayed next to each other
Has no affect on the display of a pop-up menu, but changes will be be in effect if hs.menubar:returnToMenuBar() is called on the menubaritem.
​setTooltip​
Signature
hs.menubar:setTooltip(tooltip) -> menubaritem
Type
Method
Description
Sets the tooltip text on a menubar item
Parameters
tooltip - A string to use as the tooltip
Returns
the menubaritem
Notes
Has no affect on the display of a pop-up menu, but changes will be be in effect if hs.menubar:returnToMenuBar() is called on the menubaritem.
​stateImageSize​
| Signature | hs.menubar:stateImageSize([size]) -> hs.image object | current value | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Get or set the size for state images when the menu is displayed. | | Parameters |
size - an optional table specifying the size for state images displayed when using the checked or state key in a menu table definition. Defaults to a size determined by the system menu font point size. If you specify an explicit nil, the size is reset to this default.
| | Returns |
if a parameter is provided, returns the menubar item; otherwise returns the current value.
| | Notes |
An image is used rather than a checkmark or dash only when you set them with the onStateImage, offStateImage, or mixedStateImage keys. If you are not using these keys, then this method will have no visible effect on the menu's rendering. See hs.menubar:setMenu for more information.
If you are setting the menu contents with a static table, you should invoke this method before invoking hs.menubar:setMenu, as changes will only go into effect when the table is next converted to a menu structure.
|
​title​
| Signature | hs.menubar:title([styled]) -> string | styledtextObject | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Returns the current title of the menubar item object. | | Parameters |
styled - an optional boolean, defaulting to false, indicating that a styledtextObject representing the text of the menu title should be returned
| | Returns |
the menubar item title, or an empty string, if there isn't one. If styled is not set or is false, then a string is returned; otherwise a styledtextObject will be returned.
|