Page MenuHomePhabricator

Implement Suggestion Mode Toggle (v0.1)
Closed, ResolvedPublic3 Estimated Story Points

Description

This task represents the work of implementing v0.1 of the Suggestion Mode toggle.

For more details about the broader arc and scope of this feature, please review T415589.

Story

As an experienced volunteer who has enabled the Suggestion Mode beta feature, is using desktop VE, and who most often arrives into editing with a clear change in mind, I'd value there being a way to turn suggestion mode OFF on a per session basis WITHOUT needing to go into Special:Preferences so that I can remain in flow and preserve the option of seeing suggestions in future edit sessions.

Requirements

Meta

  • Platform(s): desktop
  • Configuration
    • By default, the Suggestion Mode toggle this ticket introduces will be in an ON state whenever people arrive into a VE edit session

User experience

  • Introduce a button within the desktop VE toolbar that, when tapped, toggles Suggestion Mode, and the button, into an ON/OFF state
    • See "Mockups" for details about how this button will look.
  • When toggled ON, all Suggestions will appear
  • When toggled OFF, the following will not be visible
    • Suggestions
    • The suggestion gutter/rail that is used to "house" suggestions

Instrumentation

  • Log an event whenever someone engages with the toggle button this ticket introduces.
    • Put another away: we want to be able to know: "What proportion of edit sessions involve people toggling Suggestion Mode OFF and ON?"
    • Implemented as follows (more in T420245#11715957):
      • Using the tool will log the normal tool-used action for feature:editCheckSuggestions
      • Using the tool will also log feature:editCheckSuggestions, action:toggle-{on|off}

Mockups

image.png (1×2 px, 1 MB)

image.png (96×108 px, 1 KB)
image.png (96×108 px, 1 KB)
ToggleButton OFFToggleButton ON

When suggestions are OFF, we will use the cdxIconLightbulb icon. When suggestions are ON, we will use the lightbulb icon with an active indicator, representing that suggestions are turned on. The active version keeps the same lightbulb shape and size but including small spark elements around the lightbulb that expand outward in a subtle animation to indicate it is turned on.

Captura de pantalla 2026-03-17 a las 12.27.55.png (660×1 px, 39 KB)

Acceptance criteria

  • Requirements are implemented
  • Requirements are verified, including client- and server-side QA of instrumentation (cc @MNeisler)
  • @Quiddity to inform volunteers who raised this as an issue that they can expect the feature live on all Wikipedias by EOD Thursday, 19 Mar 2026

Related

Event Timeline

ppelberg set the point value for this task to 3.Mar 16 2026, 5:18 PM
ppelberg updated the task description. (Show Details)
ppelberg updated the task description. (Show Details)
ppelberg added a subscriber: MNeisler.

Change #1253651 had a related patch set uploaded (by DLynch; author: DLynch):

[mediawiki/extensions/VisualEditor@master] Editcheck: add toggle button to desktop toolbar for suggestion mode

https://gerrit.wikimedia.org/r/1253651

Test wiki created on Patch demo by DLynch (WMF) using patch(es) linked to this task:
https://72a53fca72.catalyst.wmcloud.org/w/

Instrumentation:

  • Using the tool will log the normal tool-used action for feature:editCheckSuggestions
  • Using the tool will also log feature:editCheckSuggestions, action:toggle-{on|off}
ppelberg updated the task description. (Show Details)
ppelberg added a subscriber: Quiddity.

Change #1253651 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Editcheck: add toggle button to desktop toolbar for suggestion mode

https://gerrit.wikimedia.org/r/1253651

Keep in mind that when suggestions are ON, we will use the lightbulb icon with an active indicator, representing that suggestions are turned on. The active version keeps the same lightbulb shape and size but including small spark elements around the lightbulb that expand outward in a subtle animation to indicate it is turned on.

image.png (96×108 px, 1 KB)
image.png (96×108 px, 1 KB)
ToggleButton OFFToggleButton ON

Captura de pantalla 2026-03-17 a las 12.27.55.png (660×1 px, 39 KB)

Yeah, that’ll be done in T420268. We need to do more work to make that custom icon available for use on a tool, and this first version was wanted quickly.

@ppelberg Looks like this was made high priority recently, is it blocking additional work or is there a deadline coming up?

Not Peter but I can give a rationale until he responds. Suggestion mode is our current work / hypothesis. It makes sense to get it verified. This was on the train March 17.

Test wiki on Patch demo by DLynch (WMF) using patch(es) linked to this task was deleted:

https://72a53fca72.catalyst.wmcloud.org/w/