Convert NSEventModifierFlags to a symbolic representation

[kopyl]

Do you know how I can safely convert a modifier from KeyboardShortcuts.Name.openTabsList.shortcut.modifiers to say "⇥"?

[kopyl]

I mean how safe would this be?

func modifierFlagsToSymbols(_ flags: NSEvent.ModifierFlags) -> String {
    var symbols = ""
    
    if flags.contains(.control) {
        symbols += "⌃"
    }
    if flags.contains(.option) {
        symbols += "⌥"
    }
    if flags.contains(.shift) {
        symbols += "⇧"
    }
    if flags.contains(.command) {
        symbols += "⌘"
    }
    if flags.contains(.function) {
        symbols += "fn"
    }
    
    return symbols
}

[kopyl]

Or something a bit cleaner

extension NSEvent.ModifierFlags {
    var symbolRepresentation: String {
        var symbols = ""

        if contains(.command) {
            symbols += "⌘"
        }
        if contains(.option) {
            symbols += "⌥"
        }
        if contains(.control) {
            symbols += "⌃"
        }
        if contains(.shift) {
            symbols += "⇧"
        }
        if contains(.capsLock) {
            symbols += "⇪"
        }

        return symbols
    }
}

To use it like
KeyboardShortcuts.Name.openTabsList.shortcut?.modifiers.symbolRepresentation

[sindresorhus]

That looks fine, but you need to ensure the order is correct (that it follows the order macOS would put the symbols). We could add something for this here, but I want to avoid extending built-in types as it could cause conflicts with user's own extensions.

[kopyl]

@sindresorhus thank you.

By the way, I just used you library in one of my apps

https://apps.apple.com/us/app/tab-finder/id6741719894

Initially I just used HotKey library, but then users started asking to implement custom shortcuts and I looked into your library.

Initially I tried yours before using HotKey, but it was unable to add to my packages for some reason (it fixed now).

[kopyl]

@sindresorhus you could add the list of apps which use this package to the README.

[sindresorhus]

No, it requires too much maintenance.

[sindresorhus]

This is already supported with NSEvent.ModifierFlags.ks_symbolicRepresentation (for modifiers) and KeyboardShortcuts.Shortcut.description (for full shortcut text like ⇧⌘T / ⇥). We should probably close this issue as done.

Example:
shortcut.modifiers.ks_symbolicRepresentation
shortcut.description