Joomla! Issue Tracker - CMS

Download
Launch
Feeling Lucky

[#48510] - [6.3] Inline help: optionally remember the toggle state per page

NPM Resource Changed PR-6.3-dev Pending

User tests: Successful: Unsuccessful:

avatar mvanvu
mvanvu
26 Sep 2026

Summary of Changes

The inline help toggle forgets its state on every page load, so anyone who keeps the descriptions open has to press the button again after each save or reload.

This adds an opt-in storage attribute to the form's inline help config:

<config>
    <inlinehelp button="show" storage="local"/>
</config>

When it is set, the toggle state is kept in localStorage, keyed by the toggle class and the page URL (path + query string), so each form remembers its own state. Only the visible state is stored; hiding the help removes the key.

  • FormView::addToolbar() reads storage from the form XML and passes it to the button.
  • InlinehelpButton gets a storage option, rendered as data-storage.
  • inlinehelp.es6.js restores and saves the state only when the button carries data-storage="local". Storage access is wrapped in try/catch, so blocked storage (private mode, disabled site data) falls back to the current behaviour.

Forms without the attribute are unchanged.

Testing Instructions

  1. Apply the PR and run npm run build:js.
  2. In administrator/components/com_content/forms/article.xml, change <inlinehelp button="show"/> to <inlinehelp button="show" storage="local"/>.
  3. Content → Articles → New. Press Toggle Inline Help, then reload the page.
  4. Press Toggle Inline Help again to hide the help, then reload.
  5. Open a form that does not use the attribute (e.g. System → Guided Tours → New), toggle the help on and reload.

Actual result BEFORE applying this Pull Request

The inline help is hidden again after every reload, on every form.

Expected result AFTER applying this Pull Request

  • Step 3: the help is still visible after the reload.
  • Step 4: the help is hidden after the reload and the joomla.inlinehelp.* key is gone from localStorage.
  • Step 5: the help is hidden after the reload and nothing is written to localStorage — unchanged behaviour.

Link to documentations

Please select:

  • Documentation link for guide.joomla.org:
  • No documentation changes for guide.joomla.org needed
  • Pull Request link for manual.joomla.org:
  • No documentation changes for manual.joomla.org needed
avatar mvanvu mvanvu - open - 26 Sep 2026
avatar mvanvu mvanvu - change - 26 Sep 2026
Status New ⇒ Pending
avatar joomla-cms-bot joomla-cms-bot - change - 26 Sep 2026
Category ⇒ Libraries JavaScript NPM Change
avatar brianteeman
brianteeman - comment - 26 Sep 2026

Nice idea

avatar mvanvu mvanvu - change - 26 Sep 2026
Labels Added: NPM Resource Changed PR-6.3-dev
avatar exlemor exlemor - test_item - 29 Oct 2026 - Tested successfully
avatar exlemor
exlemor - comment - 29 Oct 2026

I have tested this item ✅ successfully on bbfa22e

Hello @mvanvu, thank you for your contribution and this PR fix (as pointed out by Brian, really nice idea and removes an annoyance).

I have tested this successfully - I just have 1 small question, I have tried multiple times the BEFORE and AFTER scenario and I noticed a performance difference between BEFORE and AFTER which perhaps is not widespread and therefore a non-issue but in my testing was significant enough to see a degradation (I have a video if need be).

Joomla 6.3 Nightly Build from today, just Joomla Patch Tester and RegularLabs Cache plugin installed, Joomla SEF/URL rewriting on.

I cleared cache before each run as a baseline.

Without the PR, the Toggle Inline Help gets visually created next to the Cancel button and almost instantly moves to the right.
Without the PR, the same THING happens but there is a noticeable delay that does not exist when the PR fix is NOT applied.

I have done each run 5 times to make sure it was not a temp WiFi glitch.

Is that expected? is that due to the code change or is it indeed a temp wifi, local network, hosting situation or something else that is unimportant.

Here is the VIDEO without the PR applied:

Here is the VIDEO with the PR applied:

(I realize the video is short but I hope it can illustrate the delay/speed difference)

This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/48510.
avatar exlemor
exlemor - comment - 29 Oct 2026

I have tested this item ✅ successfully on bbfa22e

Hello @mvanvu, thank you for your contribution and this PR fix (as pointed out by Brian, really nice idea and removes an annoyance).

I have tested this successfully - I just have 1 small question, I have tried multiple times the BEFORE and AFTER scenario and I noticed a performance difference between BEFORE and AFTER which perhaps is not widespread and therefore a non-issue but in my testing was significant enough to see a degradation (I have a video if need be).

Joomla 6.3 Nightly Build from today, just Joomla Patch Tester and RegularLabs Cache plugin installed, Joomla SEF/URL rewriting on.

I cleared cache before each run as a baseline.

Without the PR, the Toggle Inline Help gets visually created next to the Cancel button and almost instantly moves to the right.
Without the PR, the same THING happens but there is a noticeable delay that does not exist when the PR fix is NOT applied.

I have done each run 5 times to make sure it was not a temp WiFi glitch.

Is that expected? is that due to the code change or is it indeed a temp wifi, local network, hosting situation or something else that is unimportant.

Here is the VIDEO without the PR applied:

Here is the VIDEO with the PR applied:

(I realize the video is short but I hope it can illustrate the delay/speed difference)

This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/48510.
avatar exlemor
exlemor - comment - 29 Oct 2026

I have tested this item ✅ successfully on bbfa22e

Hello @mvanvu, thank you for your contribution and this PR fix (as pointed out by Brian, really nice idea and removes an annoyance).

I have tested this successfully - I just have 1 small question, I have tried multiple times the BEFORE and AFTER scenario and I noticed a performance difference between BEFORE and AFTER which perhaps is not widespread and therefore a non-issue but in my testing was significant enough to see a degradation (I have a video if need be).

Joomla 6.3 Nightly Build from today, just Joomla Patch Tester and RegularLabs Cache plugin installed, Joomla SEF/URL rewriting on.

I cleared cache before each run as a baseline.

Without the PR, the Toggle Inline Help gets visually created next to the Cancel button and almost instantly moves to the right.
Without the PR, the same THING happens but there is a noticeable delay that does not exist when the PR fix is NOT applied.

I have done each run 5 times to make sure it was not a temp WiFi glitch.

Is that expected? is that due to the code change or is it indeed a temp wifi, local network, hosting situation or something else that is unimportant.

Here is the VIDEO without the PR applied:
https://github.com/user-attachments/assets/3ea0f63a-3529-40dd-988d-28c66499d2b3

Here is the VIDEO with the PR applied:
https://github.com/user-attachments/assets/dbe047c2-1f56-49f4-a5b3-0f6c5d693b2c

(I realize the video is short but I hope it can illustrate the delay/speed difference)

This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/48510.
avatar exlemor
exlemor - comment - 29 Oct 2026

I have tested this item ✅ successfully on bbfa22e

Hello @mvanvu, thank you for your contribution and this PR fix (as pointed out by Brian, really nice idea and removes an annoyance).

I have tested this successfully - I just have 1 small question, I have tried multiple times the BEFORE and AFTER scenario and I noticed a performance difference between BEFORE and AFTER which perhaps is not widespread and therefore a non-issue but in my testing was significant enough to see a degradation (I made 2 videos attached below to help show the difference).

Joomla 6.3 Nightly Build from today, just Joomla Patch Tester and RegularLabs Cache plugin installed, Joomla SEF/URL rewriting on.

I cleared cache before each run as a baseline.

Without the PR, the Toggle Inline Help gets visually created next to the Cancel button and almost instantly moves to the right.
Without the PR, the same THING happens but there is a noticeable delay that does not exist when the PR fix is NOT applied.

I have done each run 5 times to make sure it was not a temp WiFi glitch.

Is that expected? is that due to the code change or is it indeed a temp wifi, local network, hosting situation or something else that is unimportant.

Here is the VIDEO without the PR applied:
https://github.com/user-attachments/assets/3ea0f63a-3529-40dd-988d-28c66499d2b3

Here is the VIDEO with the PR applied:
https://github.com/user-attachments/assets/dbe047c2-1f56-49f4-a5b3-0f6c5d693b2c

(I realize the video is short but I hope it can illustrate the delay/speed difference)

This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/48510.
avatar exlemor
exlemor - comment - 29 Oct 2026

I have tested this item ✅ successfully on bbfa22e

Hello @mvanvu, thank you for your contribution and this PR fix (as pointed out by Brian, really nice idea and removes an annoyance).

I have tested this successfully - I just have 1 small question, I have tried multiple times the BEFORE and AFTER scenario and I noticed a performance difference between BEFORE and AFTER which perhaps is not widespread and therefore a non-issue but in my testing was significant enough to see a degradation (I made 2 videos attached below to help show the difference).

Joomla 6.3 Nightly Build from today, just Joomla Patch Tester and RegularLabs Cache plugin installed, Joomla SEF/URL rewriting on.

I cleared cache before each run as a baseline.

Without the PR, the Toggle Inline Help gets visually created next to the Cancel button and almost instantly moves to the right.
Without the PR, the same THING happens but there is a noticeable delay that does not exist when the PR fix is NOT applied.

I have done each run 5 times to make sure it was not a temp WiFi glitch.

Is that expected? is that due to the code change, the nature of the LocalStorage update or is it indeed a temp wifi, local network, hosting situation or something else that is unimportant.

Here is the VIDEO without the PR applied:
https://github.com/user-attachments/assets/3ea0f63a-3529-40dd-988d-28c66499d2b3

Here is the VIDEO with the PR applied:
https://github.com/user-attachments/assets/dbe047c2-1f56-49f4-a5b3-0f6c5d693b2c

(I realize the video is short but I hope it can illustrate the delay/speed difference)

This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/48510.
avatar brianteeman
brianteeman - comment - 29 Oct 2026

There needs to be an indicator that the show help is on or off

Add a Comment

Login with GitHub to post a comment