Skip to content

[UI > Commands > Hot keys] Hotkey example uses lowercase key, which breaks on non-Latin keyboard layouts #226

@enchained

Description

@enchained

https://docs.obsidian.md/Plugins/User+interface/Commands#Hot%20keys

The hotkey example uses key: 'a' (lowercase). Plugin hotkeys registered with lowercase key values may not work when the user's keyboard layout is non-Latin (Cyrillic, Arabic, etc.). Obsidian's built-in hotkeys use uppercase values (see .obsidian/hotkeys.json after mapping custom ones in settings) and work in all layouts.

This is a known bug affecting multiple plugins (like Excalidraw, Templater, Auto Link Title). Plugin developers probably follow this example, also it is generally common to use lowercase mappings in JS, so the bug keeps spreading.

Unless the bug is fixed (and it is currently marked as wontfix on the forum), it would be nice to warn developers about this behavior.

Example warning to add:

Always use uppercase letters for the key value (e.g., 'A', not 'a'). Lowercase key values can cause hotkeys to fail when the user's keyboard layout is non-Latin.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions