Swift Package Index

Sauce

https://github.com/Clipy/Sauce.git

Mapping various keyboard layout sources and key codes in macOS. (e.g.: QWERTY, Dvorak)


Compatibility

  • v2.1.0 and master
    5.3
    5.2
    5.1
    5.0
    4.2
  • v2.1.0 and master
    iOS
    macOS(Intel)
    macOS(ARM)
    Linux
    tvOS
    watchOS

Sauce

CI Release version License: MIT Carthage compatible Version Platform SPM supported

Mapping various keyboard layout sources and key codes in macOS. (e.g.: QWERTY, Dvorak)

Motivation

Only the ANSI-standard US keyboard is defined for the key code defined in Carbon.framework. Therefore, we can obtain only the key code of the QWERTY keyboard layout. (e.g.: kVK_ANSI_V)
In layout other than QWERTY, (e.g. Dvorak) the virtual key code is different.

Keyboard Layout Key Key Code
QWERTY v 9
Dvorak v 47

This library is created with the purpose of mapping the key code of the input sources and making it possible to obtain the correct key code in various keyboard layouts.

Usage

CocoaPods

pod 'Sauce'

Carthage

github "Clipy/Sauce"

Example

Key codes

Get the key code of the current input source.

let keyCode = Sauce.shared.keyCode(by: .v)

Key

Get the Key of the current input source.

let key = Sauce.shared.key(by: keyCode)

Character

Get the character of the current input source.

let character = Sauce.shared.character(by: keyCode, carbonModifiers: shiftKey)
let character = Sauce.shared.character(by: keyCode, cocoaModifiers: [.shift])

Notification

NSNotification.Name.SauceEnabledKeyboardInputSourcesChanged

SauceEnabledKeyboardInputSourcesChanged is the same as kTISNotifyEnabledKeyboardInputSourcesChanged in Carbon.framework

NSNotification.Name.SauceSelectedKeyboardInputSourceChanged

SauceSelectedKeyboardInputSourceChanged is different from kTISNotifySelectedKeyboardInputSourceChanged and is notified only when the input source id has changed.
Since it is filtered and notified, please do not use it for the same purpose as normal kTISNotifySelectedKeyboardInputSourceChanged.

Contributing

  1. Fork it ( https://github.com/Clipy/Sauce/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request