Add an "opt-in" mode per page (e.g. for Themers)

Created on 25 April 2025, about 21 hours ago

Problem/Motivation

When Themers are working on a project with Editoria11y enabled, they (for good reasons) complain about the page's markup modified by Editoria11y.

Editoria11y modifies the markup on page load to add its tips and the widget.
While this is okay for the widget IMHO, as it's at a very specific point in the markup, it's a real issue for existing page content, when theming.

Disabling Editoria11y per role is not a good option for 2 reasons:

  1. Themers (if also developers / site owners / ... in one position, which isn't totally untypical) may have the administrator role and Administrators always have all permissions by design
  2. Also themers may want to use Editoria11y!

Steps to reproduce

Visit a page in a project with Editoria11y enabled and see markup modified by default

Proposed resolution

Add an "Opt-in" mode and setting, so that the Editoria11y scan and markup modification happens on user action, for example when clicking the Editoria11y widget.

If opt-in mode is enabled in settings, the widget should reflect, that it's in that mode and acts as a "button" to scan the page.

Bonus: This setting could be per-user, but I think project-wide is totally fine for 95% of all use-cases.

Remaining tasks

  1. Discuss
  2. Implement
  3. Test
  4. Release

User interface changes

See above

API changes

Data model changes

✨ Feature request
Status

Active

Version

2.2

Component

Feature and test requests

Created by

πŸ‡©πŸ‡ͺGermany Anybody Porta Westfalica

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @Anybody
  • πŸ‡©πŸ‡ͺGermany Anybody Porta Westfalica
  • πŸ‡©πŸ‡ͺGermany Anybody Porta Westfalica
  • πŸ‡©πŸ‡ͺGermany Anybody Porta Westfalica
  • πŸ‡©πŸ‡ͺGermany Anybody Porta Westfalica
  • πŸ‡©πŸ‡ͺGermany Anybody Porta Westfalica

    After thinking about this, I think a setting like this might be most helpful:

    Run Editoria11y check on:

    • Page load (default)
    • Widget click

    This setting allows running Editoria11y check on page load or when the user needs it, to prevent unwanted DOM manipulation.

    Or add a Editoria11y per-user (cookie / local storage) setting to enable / disable Editoria11y auto-check on page load

  • πŸ‡ΊπŸ‡ΈUnited States itmaybejj

    Hmm....unless there is a bug, if "Show tips automatically when issues are detected" is set to anything other than "Assertive" (the default), it will only auto-draw the tips if there are new errors on the page. Themers repeatedly refreshing a page should only have stuff tossed all over their work once if they close the toggle and refresh. Subsequent loads will read their local preference for "shut," see that the number of issues hasn't changed, and start minimized (e.g., as an on-demand check). Maybe try setting that to "On first detection" or "Polite" during development and see if that satisfies your themers? "On first detection" used to be the default, but too many editors were ignoring the toggle...

    I would consider a merge request to add a per-user preference for "Show tips automatically when issues are detected."

Production build 0.71.5 2024