[PR #18533] [MERGED] fix: display correct keys for international keyboards #11622

Closed
opened 2025-11-11 19:36:58 -06:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/18533
Author: @silentoplayz
Created: 10/23/2025
Status: Merged
Merged: 10/27/2025
Merged by: @tjbck

Base: devHead: fix-keyboard-shortcuts-display


📝 Commits (1)

  • 02a2683 fix: display correct keys for international keyboards

📊 Changes

1 file changed (+31 additions, -6 deletions)

View changed files

📝 src/lib/components/chat/ShortcutItem.svelte (+31 -6)

📄 Description

Pull Request Checklist

Before submitting, make sure you've checked the following:

  • Target branch: Verify that the pull request targets the dev branch. Not targeting the dev branch may lead to immediate closure of the PR.
  • Description: Provide a concise description of the changes made in this pull request.
  • Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
  • Documentation: If necessary, update relevant documentation Open WebUI Docs like environment variables, the tutorials, or other documentation sources.
  • Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
  • Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Take this as an opportunity to make screenshots of the feature/fix and include it in the PR description.
  • Agentic AI Code:: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review and manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
  • Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
  • Title Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
    • BREAKING CHANGE: Significant changes that may affect compatibility
    • build: Changes that affect the build system or external dependencies
    • ci: Changes to our continuous integration processes or workflows
    • chore: Refactor, cleanup, or other non-functional code changes
    • docs: Documentation update or addition
    • feat: Introduces a new feature or enhancement to the codebase
    • fix: Bug fix or error correction
    • i18n: Internationalization or localization changes
    • perf: Performance improvement
    • refactor: Code restructuring for better maintainability, readability, or scalability
    • style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
    • test: Adding missing tests or correcting existing tests
    • WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

Description

This pull request fixes a UI bug where the keyboard shortcuts displayed in the "Shortcuts" modal were incorrect for users with non-US keyboard layouts (e.g., Norwegian). The component now uses the navigator.keyboard.getLayoutMap() API to dynamically detect the user's keyboard layout and display the character that corresponds to the physical key, ensuring the visual guide matches the user's hardware.

Changed

  • Updated ShortcutItem.svelte to use navigator.keyboard.getLayoutMap() for dynamically displaying shortcut keys.
  • Implemented a fallback mechanism to ensure functionality for older browsers that do not support the Keyboard API.

Fixed

  • The Shortcuts modal now accurately displays the correct keys for international and non-QWERTY keyboard layouts. For example, the shortcut Ctrl + / (on a US keyboard) is now correctly displayed as Ctrl + - on a Norwegian keyboard.

Additional Information

  • This change uses a progressive enhancement strategy. Modern browsers that support the Keyboard.getLayoutMap() API will provide an improved, layout-aware experience, while older browsers will gracefully fall back to the previous behavior without any loss of functionality.
  • Related PR - https://github.com/open-webui/open-webui/pull/18473

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/open-webui/pull/18533 **Author:** [@silentoplayz](https://github.com/silentoplayz) **Created:** 10/23/2025 **Status:** ✅ Merged **Merged:** 10/27/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `fix-keyboard-shortcuts-display` --- ### 📝 Commits (1) - [`02a2683`](https://github.com/open-webui/open-webui/commit/02a2683eb0865a273af5d7539a8681433ee14ba9) fix: display correct keys for international keyboards ### 📊 Changes **1 file changed** (+31 additions, -6 deletions) <details> <summary>View changed files</summary> 📝 `src/lib/components/chat/ShortcutItem.svelte` (+31 -6) </details> ### 📄 Description # Pull Request Checklist **Before submitting, make sure you've checked the following:** - [X] **Target branch:** Verify that the pull request targets the `dev` branch. Not targeting the `dev` branch may lead to immediate closure of the PR. - [X] **Description:** Provide a concise description of the changes made in this pull request. - [X] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [X] **Documentation:** If necessary, update relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs) like environment variables, the tutorials, or other documentation sources. - [X] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [X] **Testing:** Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Take this as an opportunity to make screenshots of the feature/fix and include it in the PR description. - [X] **Agentic AI Code:**: Confirm this Pull Request is **not written by any AI Agent** or has at least gone through additional human review **and** manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR. - [X] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [X] **Title Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: - **BREAKING CHANGE**: Significant changes that may affect compatibility - **build**: Changes that affect the build system or external dependencies - **ci**: Changes to our continuous integration processes or workflows - **chore**: Refactor, cleanup, or other non-functional code changes - **docs**: Documentation update or addition - **feat**: Introduces a new feature or enhancement to the codebase - **fix**: Bug fix or error correction - **i18n**: Internationalization or localization changes - **perf**: Performance improvement - **refactor**: Code restructuring for better maintainability, readability, or scalability - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) - **test**: Adding missing tests or correcting existing tests - **WIP**: Work in progress, a temporary label for incomplete or ongoing work # Changelog Entry ### Description This pull request fixes a UI bug where the keyboard shortcuts displayed in the "Shortcuts" modal were incorrect for users with non-US keyboard layouts (e.g., Norwegian). The component now uses the `navigator.keyboard.getLayoutMap()` API to dynamically detect the user's keyboard layout and display the character that corresponds to the physical key, ensuring the visual guide matches the user's hardware. ### Changed - Updated `ShortcutItem.svelte` to use `navigator.keyboard.getLayoutMap()` for dynamically displaying shortcut keys. - Implemented a fallback mechanism to ensure functionality for older browsers that do not support the Keyboard API. ### Fixed - The Shortcuts modal now accurately displays the correct keys for international and non-QWERTY keyboard layouts. For example, the shortcut `Ctrl + /` (on a US keyboard) is now correctly displayed as `Ctrl + -` on a Norwegian keyboard. ### Additional Information - This change uses a progressive enhancement strategy. Modern browsers that support the `Keyboard.getLayoutMap()` API will provide an improved, layout-aware experience, while older browsers will gracefully fall back to the previous behavior without any loss of functionality. - Related PR - https://github.com/open-webui/open-webui/pull/18473 ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2025-11-11 19:36:58 -06:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#11622