WordPress.org

Make WordPress Core

Opened 2 months ago

Last modified 6 weeks ago

#41876 new defect (bug)

Add inline help to Custom HTML widget

Reported by: westonruter Owned by:
Milestone: 4.9.1 Priority: high
Severity: normal Version:
Component: Widgets Keywords: needs-patch ui-feedback
Focuses: accessibility Cc:

Description

There is no inline help in the Custom HTML widget for how to interact with the code editor. While the widget will add this to the help text on the widgets admin screen, this is not easily discoverable. Additionally, this help tab text is not displayed in the Customizer at all. Just like the Additional CSS section description in the Customizer, there could be a (?) icon in the widget, and once expanded it could reveal the same help text to guide usage of the widget. I suggest the icon could be placed in the top-right corner of the widget with the help text then appearing at the top when expanded, similar to the Customizer section description.

See also:

Builds off of [41376] for #12423.

Attachments (1)

HTML Widget with help.png (331.6 KB) - added by melchoyce 7 weeks ago.

Download all attachments as: .zip

Change History (15)

This ticket was mentioned in Slack in #core-customize by westonruter. View the logs.


2 months ago

#2 @westonruter
2 months ago

As suggested by @afercia, this can be generalized so that when you construct WP_Widget there can be an optional help parameter for control_options which, when supplied, would automatically be inserted into the widget control. In that way it wouldn't be something ad hoc for the Custom HTML widget alone but could be re-used by other widgets. I am not aware of other widgets that need help text, however.

#3 @afercia
2 months ago

Custom widgets :)

#4 @westonruter
2 months ago

  • Priority changed from normal to high

Bumping priority to high for visibility and alignment with 4.9 goals, and given proximity to beta 1 deadline.

#5 @melchoyce
2 months ago

  • Keywords ui-feedback added

This ticket was mentioned in Slack in #accessibility by afercia. View the logs.


2 months ago

This ticket was mentioned in Slack in #design by karmatosed. View the logs.


2 months ago

This ticket was mentioned in Slack in #core by jeffpaul. View the logs.


7 weeks ago

This ticket was mentioned in Slack in #accessibility by afercia. View the logs.


7 weeks ago

#10 @melchoyce
7 weeks ago

  • Type changed from enhancement to defect (bug)

Changing to a defect since it's needed for accessibility.

#11 @melchoyce
7 weeks ago

Tried out a couple different positioning options in Widget with help.png.

(Note: I tried out a footer option, but I assuming that won't be viable because you'd get stuck in the editor before making it down there. Let me know if this assumption is correct.)

This ticket was mentioned in Slack in #accessibility by afercia. View the logs.


6 weeks ago

This ticket was mentioned in Slack in #core by westonruter. View the logs.


6 weeks ago

#14 @westonruter
6 weeks ago

  • Milestone changed from 4.9 to 4.9.1
Note: See TracTickets for help on using tickets.