Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
Target branch: Please verify that the pull request targets the dev branch.
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: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
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?
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
Tabbing between buttons in modal, console shows which element is in focus:
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/13695
**Author:** [@sinejespersen](https://github.com/sinejespersen)
**Created:** 5/8/2025
**Status:** ✅ Merged
**Merged:** 5/8/2025
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `8908-focus-trap-modal`
---
### 📝 Commits (5)
- [`f569836`](https://github.com/open-webui/open-webui/commit/f56983632f11cfd29ab4966020e6b5d4c8e719fa) add npm package svelte-focus-trap
- [`54b30e0`](https://github.com/open-webui/open-webui/commit/54b30e0b7fb1ede93420c65a39332f5c9684d8f9) use svelte-focus-trap in modal
- [`bd2021e`](https://github.com/open-webui/open-webui/commit/bd2021e8e127f7f35afbf2c10b7afeb7787861b7) add aria modal true and role dialog to modal
- [`305435b`](https://github.com/open-webui/open-webui/commit/305435b4ef30317a920e6556afa176f1a80e4bbb) use npm package focus-trap instead of npm package focus-trap-svelte
- [`3886dee`](https://github.com/open-webui/open-webui/commit/3886dee1cee43014c7624ca04ee29be635694955) add whitespace and semi colon
### 📊 Changes
**3 files changed** (+19 additions, -4 deletions)
<details>
<summary>View changed files</summary>
📝 `package-lock.json` (+5 -3)
📝 `package.json` (+1 -0)
📝 `src/lib/components/common/Modal.svelte` (+13 -1)
</details>
### 📄 Description
# Pull Request Checklist
### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request.
**Before submitting, make sure you've checked the following:**
- [x] **Target branch:** Please verify that the pull request targets the `dev` branch.
- [x] **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](https://keepachangelog.com/) is added at the bottom of the PR description.
- [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [ ] **Testing:** Have you written and run sufficient tests to validate the changes?
- [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] **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
As per https://github.com/open-webui/open-webui/discussions/8908
Focus in modals has to do with the two following success criterions: [SC 2.1.1: Keyboard (Level A)](https://www.w3.org/WAI/WCAG21/Understanding/keyboard.html) and [SC 2.1.1 Keyboard (Level A)](https://www.w3.org/WAI/WCAG21/Understanding/focus-order.html).
If focus leaves the modal and reaches elements in the background, the user might get lost or confused, violating logical focus order.
### Added
- Focus trap to `Modal.svelte`, which traps the keyboard inside the modal while the modal is open.
- added `aria-modal="true"` to dialog: Indicates that interaction with the rest of the page is disabled while the modal is open.
- added `role="dialog"` to dialog: Helps screen readers understand that this is a distinct interface element requiring user interaction.
### Changed
N/A or see above
### Deprecated
N/A
### Removed
N/A
### Fixed
N/A
### Security
N/A
### Breaking Changes
N/A
---
### Additional Information
The npm package can be found here: [focus-trap](https://github.com/focus-trap/focus-trap)
### Screenshots or Videos
Tabbing between buttons in modal, console shows which element is in focus:
### Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](/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>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/13695
Author: @sinejespersen
Created: 5/8/2025
Status: ✅ Merged
Merged: 5/8/2025
Merged by: @tjbck
Base:
dev← Head:8908-focus-trap-modal📝 Commits (5)
f569836add npm package svelte-focus-trap54b30e0use svelte-focus-trap in modalbd2021eadd aria modal true and role dialog to modal305435buse npm package focus-trap instead of npm package focus-trap-svelte3886deeadd whitespace and semi colon📊 Changes
3 files changed (+19 additions, -4 deletions)
View changed files
📝
package-lock.json(+5 -3)📝
package.json(+1 -0)📝
src/lib/components/common/Modal.svelte(+13 -1)📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
As per https://github.com/open-webui/open-webui/discussions/8908
Focus in modals has to do with the two following success criterions: SC 2.1.1: Keyboard (Level A) and SC 2.1.1 Keyboard (Level A).
If focus leaves the modal and reaches elements in the background, the user might get lost or confused, violating logical focus order.
Added
Modal.svelte, which traps the keyboard inside the modal while the modal is open.aria-modal="true"to dialog: Indicates that interaction with the rest of the page is disabled while the modal is open.role="dialog"to dialog: Helps screen readers understand that this is a distinct interface element requiring user interaction.Changed
N/A or see above
Deprecated
N/A
Removed
N/A
Fixed
N/A
Security
N/A
Breaking Changes
N/A
Additional Information
The npm package can be found here: focus-trap
Screenshots or Videos
Tabbing between buttons in modal, console shows which element is in focus:
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.