README in 粵語(Cantonese) | 普通話(Mandarin)
Cantonese Keyboard for iOS & macOS adopts the LSHK Jyutping scheme and supports common habitual spellings.
Feature highlights:
- Full support for Jyutping input.
- Abbreviated input with Jyutping initials.
- Accurate input with Jyutping tones.
- Traditional / Simplified characters.
- Reverse Lookup with Cangjie, Quick(Sucheng), Stroke or Mandarin Pinyin.
- Jyutping hints for candidates.
- Emoji suggestions.
- Easy ways to Copy, Cut, Paste and moving cursor backward/forward.
- Audio and Haptic feedbacks.
Jyutping for Android: yuetyam/jyutping-android
Compatibility: iOS / iPadOS 16.0+
Due to limitations imposed by the Mac App Store on third-party input methods , it's impossible to distribute this input method through the Mac App Store. Please visit our website to download it or install it via Homebrew .
Compatibility: macOS 13 Ventura or higher.
Options: Press Control + Shift + ` (below the esc key) will display an options window.
FAQ: FAQ
Build requirements
- macOS 15.0+
- Xcode 16.0+
Clone with --depth
to reduce code size:
git clone --depth 1 https://github.com/yuetyam/jyutping.git
Prepare databases:
# cd path/to/jyutping
cd ./Modules/Preparing/
swift run -c release
Then use Xcode to open Jyutping.xcodeproj
.
This project contains three tergets, Jyutping
(Main App), Keyboard
(iOS) and InputMethod
(macOS).
Note: Do not Run InputMethod
, it can only be Build or Archive
If you want to use your Mac to test the input method, you need to place the Archive & Export Jyutping.app to /Library/Input\ Methods/
.
When replacing the old Jyutping.app, Finder may prompt a message indicating that it's running. You can terminate it using this command:
osascript -e 'tell application id "org.jyutping.inputmethod.Jyutping" to quit'
- Rime-Cantonese (Cantonese Lexicon)
- OpenCC (Traditional-Simplified Character Conversion)
- JetBrains (Licenses for Open Source Development)