imomaliev/tmux-keyboard-layout

Tmux plugin to show current keyboard layout

Tmux Keyboard Layout plugin

Plugin that shows current keyboard layout.

Usage

set -g status-right '#{keyboard_layout}'

Installation with Tmux Plugin Manager (recommended)

Add plugin to the list of TPM plugins:

set -g @plugin 'imomaliev/tmux-keyboard-layout'

Press prefix + I to install it.

Manual Installation

Clone the repo:

$ git clone https://github.com/imomaliev/tmux-keyboard-layout.git ~/clone/path

Add this line to your .tmux.conf:

run-shell ~/clone/path/keyboard-layout.tmux

Reload TMUX environment with:

$ tmux source-file ~/.tmux.conf

Configurations

Change option scope (default g - global)

Follows same rules as set-option

Special case: To set scope to session use '-', because by default session scope used when no param is provided.

set -g @keyboard_layout:option_scope '-'

Change output length (default 16)

Make output length equal to 2

set -g @keyboard_layout:length 2

License

MIT

tmux-keyboard-layout's Issues

KeyboardLayout Name doesn't exist except 'ABC'

When Keyboard Layout is not English, there is no "KeyboardLayout Name" in ~/Library/Preferences/com.apple.HIToolbox.plist AppleSelectedInputSource

My Environment

• cpu: Apple Silicon M2
• os: macOS Monterey 12.6
• tmux: 3.3.a

In My Shell

• When Keyboard Layout is English

$ defaults read ~/Library/Preferences/com.apple.HIToolbox.plist AppleSelectedInputSources
(
        {
        "Bundle ID" = "com.apple.PressAndHold";
        InputSourceKind = "Non Keyboard Input Method";
    },
        {
        InputSourceKind = "Keyboard Layout";
        "KeyboardLayout ID" = 252;
        "KeyboardLayout Name" = ABC;
    }
)

• When Keyboard Layout is Korean

$ defaults read ~/Library/Preferences/com.apple.HIToolbox.plist AppleSelectedInputSources
(
        {
        "Bundle ID" = "com.apple.PressAndHold";
        InputSourceKind = "Non Keyboard Input Method";
    },
        {
        "Bundle ID" = "com.apple.inputmethod.Korean";
        "Input Mode" = "com.apple.inputmethod.Korean.2SetKorean";
        InputSourceKind = "Input Mode";
    }
)

• When Keyboard Layout is Japanese

$ defaults read ~/Library/Preferences/com.apple.HIToolbox.plist AppleSelectedInputSources
(
        {
        "Bundle ID" = "com.apple.PressAndHold";
        InputSourceKind = "Non Keyboard Input Method";
    },
        {
        "Bundle ID" = "com.apple.inputmethod.Kotoeri.RomajiTyping";
        "Input Mode" = "com.apple.inputmethod.Japanese";
        InputSourceKind = "Input Mode";
    }
)

Add support for Linux

From what I can tell, this plugin only works for MacOS - would there be any appetite for me to add support for Linux?

For example, using setxkbmap and awk I can get my keyboard layout:

> setxkbmap -query | awk '/layout/ {print $2}'
gb

We could add an if statement to get_keyboard_layout.sh to check the OS of the user and return the correct keyboard layout based on the user's OS