Skip to content

Latest commit

 

History

History
93 lines (65 loc) · 3.25 KB

README.md

File metadata and controls

93 lines (65 loc) · 3.25 KB
Raw

MenuBuilder

A function builder for NSMenus, similar in spirit to SwiftUI’s ViewBuilder.

Usage example (see demo or read the documentation for more details):

let menu = NSMenu {
  MenuItem("Click me")
    .onSelect { print("clicked!") } 
  MenuItem("Item with a view")
    .view {
      MyMenuItemView() // any SwiftUI view
    }
  SeparatorItem()
  MenuItem("About") {
    // rendered as disabled items in a submenu
    MenuItem("Version 1.2.3")
    MenuItem("Copyright 2021")
  }
  MenuItem("Quit")
    .shortcut("q")
    .onSelect { NSApp.terminate(nil) }
}

// later, to replace the menu items with different/updated ones:
menu.replaceItems {
  MenuItem("Replaced item").onSelect { print("Hello!") }
}

Note that there is no way to preserve the existing menu items, although it should be possible to implement that — feel free to open an issue or PR adding update support if you want it!

Changelog

v3.0.0

  • (Potentially BREAKING) When your app has a deployment target of macOS 12 or newer, passing a string literal to MenuItem("Title Here") will now create a String.LocalizationValue, which will make it easier to localize your app if you use MenuBuilder.
    • If your app is not localized (or your deployment target is macOS 11 or older), you shouldn’t notice any changes.
    • If your app is localized, review your UI that uses MenuBuilder and make sure that you’re not getting any unexpected translations. You can migrate to MenuItem(verbatim: "Title Here") if you want to opt out of the new behavior.
    • Thanks to @ShikiSuen for getting this started!

v2.1.0

Check out the new API docs! https://menubuilder.jedfox.com

New Features:

  • Add action and tag modifiers (Thanks @patr0nus!)
  • Update the SwiftUI custom view wrapper to use Auto Layout (Thanks @rurza!)
  • Add support for menu item titles using AttributedString on macOS 12+
  • Add a convenience initializer to NSMenu that takes a title and an @MenuBuilder closure
  • Deprecate the MenuItem(_:children:) initializer in favor of MenuItem(title).submenu { ... children ... }
  • Add an onSelect(target:action:) convenience method to set the target and action at the same time.

Bugfixes:

  • Update the SwiftUI custom view wrapper’s selection indicator to match the menu styling of macOS Big Sur and later (Thanks @rurza!)
  • Make the parameter to toolTip optional (Thanks @mlch911!)
  • update() is now called on an NSMenu when you use the replaceItems API

v2.0.0

  • (BREAKING) Migrate to @resultBuilder (Xcode 12.5+ is now required)
  • Apply modifiers to shortcuts
  • Add a MenuItem.set(WriteableKeyPath, to: Value) method to make it easier to customize the menu item
  • Add a MenuItem.apply { menuItem in } method to allow arbitrary customization of the menu item
  • Add IndentGroup to make it easier to indent several adjacent menu items
  • Add CustomMenuItem which allows you to include custom subclasses of NSMenuItem in a MenuBuilder

v1.3.0

Fixes & cleanup

v1.2.0

Add loop support

v1.1.0

Add conditional support

v1.0.1

Add license, clean up code

v1.0.0

Initial version!

Contributing

Open the MenuBuilder.xcworkspace to view the package and demo at the same time. PRs and issues are appreciated!