Framework

MenuBuilder

Swift Function Builder for creating NSMenuItems

Overview

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

Usage example (see “MenuBuilder Demo” 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!") }
}

DocC does not currently support documentation for extensions of system APIs, so here is the interface of MenuBuilder’s extension to NSMenu:

extension NSMenu {
    /// Create a new menu with the given items.
    init(@MenuBuilder _ items: () -> [NSMenuItem])


    /// Remove all items in the menu and replace them
    /// with the provided list of menu items.
    func replaceItems(@MenuBuilder with items: () -> [NSMenuItem])
}