Skip to content

Commit 045cf17

Browse files
committed
Add Shortcut#nsMenuItemKeyEquivalent property
Closes #201
1 parent 2d6b49e commit 045cf17

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

Sources/KeyboardShortcuts/NSMenuItem++.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ extension NSMenuItem {
9696
return
9797
}
9898

99-
keyEquivalent = shortcut.keyEquivalent ?? ""
99+
keyEquivalent = shortcut.nsMenuItemKeyEquivalent ?? ""
100100
keyEquivalentModifierMask = shortcut.modifiers
101101

102102
if #available(macOS 12, *) {

Sources/KeyboardShortcuts/Shortcut.swift

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ extension KeyboardShortcuts.Shortcut {
152152
}
153153

154154
if
155-
self.keyEquivalent == keyEquivalent, // Note `nil != ""`
155+
self.nsMenuItemKeyEquivalent == keyEquivalent, // Note `nil != ""`
156156
self.modifiers == keyEquivalentModifierMask
157157
{
158158
return item
@@ -691,17 +691,19 @@ extension KeyboardShortcuts.Shortcut {
691691
if string.count == 1 {
692692
return string.first
693693
}
694+
694695
return nil
695696
}
696697

697-
// This can be exposed if anyone needs it, but I prefer to keep the API surface small for now.
698698
/**
699+
Key equivalent string in `NSMenuItem` format.
700+
699701
This can be used to show the keyboard shortcut in a `NSMenuItem` by assigning it to `NSMenuItem#keyEquivalent`.
700702

701-
- Note: Don't forget to also pass `.modifiers` to `NSMenuItem#keyEquivalentModifierMask`.
703+
- Note: Don't forget to also pass ``Shortcut/modifiers`` to `NSMenuItem#keyEquivalentModifierMask`.
702704
*/
703705
@MainActor
704-
var keyEquivalent: String? {
706+
public var nsMenuItemKeyEquivalent: String? {
705707
if
706708
let key,
707709
let specialKey = keyToSpecialKeyMapping[key]

0 commit comments

Comments
 (0)