[PR #22920] [CLOSED] fix: restore $ skill highlight and TipTap mention nodes on page reload #26928

New Issue

GiteaMirror · 2026-04-20T06:46:34-05:00

GiteaMirror commented

2026-04-20 06:46:34 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/22920
Author: @silentoplayz
Created: 3/21/2026
Status: ❌ Closed

Base: dev ← Head: fix/skill-highlight-persistence

📝 Commits (1)

de8b0ec fix: restore $ skill highlight and TipTap mention nodes on page reload

📊 Changes

5 files changed (+57 additions, -6 deletions)

View changed files

📝 src/lib/components/chat/Chat.svelte (+7 -2)
📝 src/lib/components/chat/MessageInput.svelte (+30 -4)
📝 src/lib/components/chat/MessageInput/CommandSuggestionList.svelte (+2 -0)
📝 src/lib/components/chat/MessageInput/Commands/Skills.svelte (+17 -0)
📝 src/lib/components/common/RichTextInput/suggestions.ts (+1 -0)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.

This is to ensure large feature PRs are discussed with the community first, before starting work on the feature. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.

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

Target branch: Verify that the pull request targets the dev branch. PRs targeting main will be immediately closed.
Description: Provide a concise description of the changes made in this pull request down below.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Add docs in Open WebUI Docs Repository. Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps.
Dependencies: Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash.
Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to make screenshots of the feature/fix and include them 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?
Design & Architecture: Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes.
Git Hygiene: Keep PRs atomic (one logical change). Clean up commits and rebase on dev to ensure no unrelated commits (e.g. from main) are included. Push updates to the existing PR branch instead of closing and reopening.
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

Fixes two related bugs in the chat input's $ skill selection:

Mention node loss on reload: TipTap uses special mention nodes to render @model and $skill selections. Previously, only the plain-text markdown prompt was saved to the sessionStorage draft. On page reload, setText() would recreate the content from plain text, causing mention nodes to be lost (rendered as raw text like <$visualize|Visualize> instead of proper highlight). The fix saves inputContent.json to the draft and uses setContent(json) on restore to properly reconstruct mention nodes.
Skill dropdown highlight not restored: The blue highlight of the selected skill in the dropdown was not restored on page reload because selectedSkillId was never persisted. The fix adds selectedSkillId to the draft save/restore chain and updates Skills.svelte to pre-highlight the restored skill when the dropdown first loads. selectedSkillId is only cleared when the user actively searches (query changes after skills are already loaded), preserving the highlight during the initial API fetch window.

Fixed

Chat input: TipTap mention nodes ($skill, @model) are now preserved on page reload by saving the full TipTap JSON content to the sessionStorage draft and using setContent(json) on restore.
Chat input: $ skill dropdown highlight is now restored on page reload via selectedSkillId persistence through the draft → CommandSuggestionList → Skills prop chain.

Additional Information

Fix spans 5 files (Chat.svelte, MessageInput.svelte, CommandSuggestionList.svelte, Skills.svelte, suggestions.ts), 57 lines total.
Related: Separate PR #XXXX for the @ model selection persistence fix.
Related bug report: Chat input state persistence issue

Screenshots or Videos

Before the fix: After selecting a skill via $ and refreshing the page, the skill appears as raw text like <$open-webui-pr-copilot|Open WebUI PR Copilot v2> instead of a proper mention node, and no dropdown highlight is shown.

After the fix: The skill mention node is properly restored as a highlighted mention, and the dropdown shows the correct skill pre-selected (blue highlight).

Manual Verification Performed

Open the chat input in Open WebUI.
Type $ to trigger the skill suggestion dropdown.
Select a skill from the dropdown (e.g., $visualize).
Confirm the skill is highlighted in blue in the input area.
Press F5 or refresh the page.
Verify the skill appears as a proper mention highlight (not raw text like <$skill|Skill Name>).
Verify the skill is shown as selected/highlighted in the dropdown when it reappears.
Verify no console errors appear during the restore process.
Test that other chat input state (text, files, tools, @ model selection) is unaffected by this change.

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.

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.

_{🔄 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/22920 **Author:** [@silentoplayz](https://github.com/silentoplayz) **Created:** 3/21/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `fix/skill-highlight-persistence` --- ### 📝 Commits (1) - [`de8b0ec`](https://github.com/open-webui/open-webui/commit/de8b0ecd24c6a2ba2900b4f38889c81e0b5fab96) fix: restore $ skill highlight and TipTap mention nodes on page reload ### 📊 Changes **5 files changed** (+57 additions, -6 deletions) <details> <summary>View changed files</summary> 📝 `src/lib/components/chat/Chat.svelte` (+7 -2) 📝 `src/lib/components/chat/MessageInput.svelte` (+30 -4) 📝 `src/lib/components/chat/MessageInput/CommandSuggestionList.svelte` (+2 -0) 📝 `src/lib/components/chat/MessageInput/Commands/Skills.svelte` (+17 -0) 📝 `src/lib/components/common/RichTextInput/suggestions.ts` (+1 -0) </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) to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request. This is to ensure large feature PRs are discussed with the community first, before starting work on the feature. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR. **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Verify that the pull request targets the `dev` branch. **PRs targeting `main` will be immediately closed.** - [x] **Description:** Provide a concise description of the changes made in this pull request down below. - [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:** Add docs in [Open WebUI Docs Repository](https://github.com/open-webui/docs). Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps. - [x] **Dependencies:** Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash. - [x] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to **make screenshots of the feature/fix and include them 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] **Design & Architecture:** Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes. - [x] **Git Hygiene:** Keep PRs atomic (one logical change). Clean up commits and rebase on `dev` to ensure no unrelated commits (e.g. from `main`) are included. Push updates to the existing PR branch instead of closing and reopening. - [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 Fixes two related bugs in the chat input's `$` skill selection: 1. **Mention node loss on reload**: TipTap uses special mention nodes to render `@model` and `$skill` selections. Previously, only the plain-text markdown `prompt` was saved to the sessionStorage draft. On page reload, `setText()` would recreate the content from plain text, causing mention nodes to be lost (rendered as raw text like `<$visualize|Visualize>` instead of proper highlight). The fix saves `inputContent.json` to the draft and uses `setContent(json)` on restore to properly reconstruct mention nodes. 2. **Skill dropdown highlight not restored**: The blue highlight of the selected skill in the dropdown was not restored on page reload because `selectedSkillId` was never persisted. The fix adds `selectedSkillId` to the draft save/restore chain and updates `Skills.svelte` to pre-highlight the restored skill when the dropdown first loads. `selectedSkillId` is only cleared when the user actively searches (query changes after skills are already loaded), preserving the highlight during the initial API fetch window. ### Fixed - **Chat input**: TipTap mention nodes (`$skill`, `@model`) are now preserved on page reload by saving the full TipTap JSON content to the sessionStorage draft and using `setContent(json)` on restore. - **Chat input**: `$` skill dropdown highlight is now restored on page reload via `selectedSkillId` persistence through the draft → `CommandSuggestionList` → `Skills` prop chain. --- ### Additional Information - Fix spans 5 files (`Chat.svelte`, `MessageInput.svelte`, `CommandSuggestionList.svelte`, `Skills.svelte`, `suggestions.ts`), 57 lines total. - Related: Separate PR `#XXXX` for the `@` model selection persistence fix. - Related bug report: [Chat input state persistence issue](https://github.com/open-webui/open-webui/issues/22913) ### Screenshots or Videos **Before the fix:** After selecting a skill via `$` and refreshing the page, the skill appears as raw text like `<$open-webui-pr-copilot|Open WebUI PR Copilot v2>` instead of a proper mention node, and no dropdown highlight is shown. <img width="2560" height="203" alt="image" src="https://github.com/user-attachments/assets/6e75ea91-cb78-4f26-a400-ec2c9e5e0f11" /> **After the fix:** The skill mention node is properly restored as a highlighted mention, and the dropdown shows the correct skill pre-selected (blue highlight). <img width="2560" height="203" alt="image" src="https://github.com/user-attachments/assets/352867a6-3c34-41d0-8712-25fdd3c274b1" /> ## Manual Verification Performed 1. Open the chat input in Open WebUI. 2. Type `$` to trigger the skill suggestion dropdown. 3. Select a skill from the dropdown (e.g., `$visualize`). 4. Confirm the skill is highlighted in blue in the input area. 5. Press F5 or refresh the page. 6. Verify the skill appears as a proper mention highlight (not raw text like `<$skill|Skill Name>`). 7. Verify the skill is shown as selected/highlighted in the dropdown when it reappears. 8. Verify no console errors appear during the restore process. 9. Test that other chat input state (text, files, tools, `@` model selection) is unaffected by this change. ### Contributor License Agreement  - [x] 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. > [!NOTE] > Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in. --- <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 2026-04-20 06:46:34 -05:00

GiteaMirror closed this issue

2026-04-20 06:46:35 -05: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#26928