[PR #14055] [CLOSED] feat: About and Releases in Help menu #10170

New Issue

GiteaMirror · 2025-11-11T18:57:53-06:00

GiteaMirror commented

2025-11-11 18:57:53 -06:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/14055
Author: @silentoplayz
Created: 5/19/2025
Status: ❌ Closed

Base: dev ← Head: update-help-menu

📝 Commits (1)

790f8b5 feat: About and Releases in Help menu

📊 Changes

3 files changed (+51 additions, -8 deletions)

View changed files

📝 src/lib/components/chat/SettingsModal.svelte (+11 -1)
📝 src/lib/components/layout/Help/HelpMenu.svelte (+39 -7)
📝 src/lib/stores/index.ts (+1 -0)

📄 Description

Pull Request Checklist

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

Changelog Entry

Description

This pull request introduces the ability to directly open the "About" tab within the Settings Modal by clicking a new "About" link in the Help Menu. It also refactors the Help Menu by adding a "Releases" link and improving existing items. The active tab state for the Settings Modal is now managed globally using a new Svelte store.

Added

Global State for Active Settings Tab: Introduced a new Svelte writable store activeSettingsTabKey in src/lib/stores/index.ts to manage and reflect the currently active tab in the Settings Modal.
In HelpMenu.svelte:
- New "About" menu item in the Help menu:
  - Displays an "Info" icon.
  - When clicked, it sets activeSettingsTabKey to 'about', opens the Settings Modal to the About section, and then closes the Help Menu.
- New "Releases" menu item in the Help menu:
  - Displays a "Map" icon
  - When clicked, it opens the Open WebUI GitHub releases page in a new tab and then closes the Help Menu.
- Imported Info and Map icons for the new menu items.

Changed

SettingsModal.svelte:
- Imports, subscribes to and updates the activeSettingsTabKey store.
- When the modal becomes visible (e.g., $show is true), if $activeSettingsTabKey is set to a valid tab ID, the modal will display that specific tab.
- When a tab is clicked within the modal, the activeSettingsTabKey store is updated to reflect the newly selected tab's ID.
- The activeSettingsTabKey store is explicitly set to null during the initialization script of the SettingsModal component.
HelpMenu.svelte:
- Imports showSettings and activeSettingsTabKey stores to interact with the Settings Modal.
- The existing "Documentation" menu item:
  - Now calls onClose() (to close the Help Menu dropdown) after opening the documentation link.
  - Its id attribute has been updated from chat-share-button to menu-item-documentation for clarity.
- The existing "Keyboard Shortcuts" menu item:
  - Now calls onClose() (to close the Help Menu dropdown) after triggering the shortcuts display.
  - Its id attribute has been updated (likely from a duplicated chat-share-button) to menu-item-keyboard-shortcuts.
  - Text updated from $i18n.t('Keyboard shortcuts') to $i18n.t('Keyboard Shortcuts') (capitalization).

Additional Information

This change introduces a more user-friendly way to access application information and release notes.
The global activeSettingsTabKey store provides a more robust way to control the Settings Modal's displayed tab from external components.

Screenshots or Videos

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/14055 **Author:** [@silentoplayz](https://github.com/silentoplayz) **Created:** 5/19/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `update-help-menu` --- ### 📝 Commits (1) - [`790f8b5`](https://github.com/open-webui/open-webui/commit/790f8b57a796818da1c878e29e038d91cab9b45e) feat: About and Releases in Help menu ### 📊 Changes **3 files changed** (+51 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `src/lib/components/chat/SettingsModal.svelte` (+11 -1) 📝 `src/lib/components/layout/Help/HelpMenu.svelte` (+39 -7) 📝 `src/lib/stores/index.ts` (+1 -0) </details> ### 📄 Description # Pull Request Checklist **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. - [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:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [x] **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 - This pull request introduces the ability to directly open the "About" tab within the Settings Modal by clicking a new "About" link in the Help Menu. It also refactors the Help Menu by adding a "Releases" link and improving existing items. The active tab state for the Settings Modal is now managed globally using a new Svelte store. ### Added - **Global State for Active Settings Tab**: Introduced a new Svelte writable store `activeSettingsTabKey` in `src/lib/stores/index.ts` to manage and reflect the currently active tab in the Settings Modal. - **In `HelpMenu.svelte`**: - New "About" menu item in the Help menu: - Displays an "Info" icon. - When clicked, it sets `activeSettingsTabKey` to `'about'`, opens the Settings Modal to the `About` section, and then closes the Help Menu. - New "Releases" menu item in the Help menu: - Displays a "Map" icon - When clicked, it opens the Open WebUI GitHub releases page in a new tab and then closes the Help Menu. - Imported `Info` and `Map` icons for the new menu items. ### Changed - **`SettingsModal.svelte`**: - Imports, subscribes to and updates the `activeSettingsTabKey` store. - When the modal becomes visible (e.g., `$show` is true), if `$activeSettingsTabKey` is set to a valid tab ID, the modal will display that specific tab. - When a tab is clicked within the modal, the `activeSettingsTabKey` store is updated to reflect the newly selected tab's ID. - The `activeSettingsTabKey` store is explicitly set to `null` during the initialization script of the `SettingsModal` component. - **`HelpMenu.svelte`**: - Imports `showSettings` and `activeSettingsTabKey` stores to interact with the Settings Modal. - The existing "Documentation" menu item: - Now calls `onClose()` (to close the Help Menu dropdown) after opening the documentation link. - Its `id` attribute has been updated from `chat-share-button` to `menu-item-documentation` for clarity. - The existing "Keyboard Shortcuts" menu item: - Now calls `onClose()` (to close the Help Menu dropdown) after triggering the shortcuts display. - Its `id` attribute has been updated (likely from a duplicated `chat-share-button`) to `menu-item-keyboard-shortcuts`. - Text updated from `$i18n.t('Keyboard shortcuts')` to `$i18n.t('Keyboard Shortcuts')` (capitalization). --- ### Additional Information - This change introduces a more user-friendly way to access application information and release notes. - The global `activeSettingsTabKey` store provides a more robust way to control the Settings Modal's displayed tab from external components. ### Screenshots or Videos ![image](https://github.com/user-attachments/assets/abccac9c-742b-4055-bb62-4e14224c019c) ### 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>

GiteaMirror added the pull-request label 2025-11-11 18:57:53 -06:00

GiteaMirror closed this issue

2025-11-11 18:57:54 -06:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#10170