WordPress.org

Make WordPress Core

Opened 2 years ago

Last modified 8 months ago

#41876 new defect (bug)

Add inline help to Custom HTML widget

Reported by: westonruter Owned by:
Milestone: Future Release Priority: normal
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 2 years ago.

Download all attachments as: .zip

Change History (22)

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


2 years ago

#2 @westonruter
2 years 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 years ago

Custom widgets :)

#4 @westonruter
2 years 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 years ago

  • Keywords ui-feedback added

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


2 years ago

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


2 years ago

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


2 years ago

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


2 years ago

#10 @melchoyce
2 years ago

  • Type changed from enhancement to defect (bug)

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

#11 @melchoyce
2 years 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.


2 years ago

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


2 years ago

#14 @westonruter
2 years ago

  • Milestone changed from 4.9 to 4.9.1

#15 @johnbillion
22 months ago

  • Milestone changed from 4.9.1 to 5.0

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


15 months ago

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


12 months ago

#18 @jameskockelbergh
12 months ago

My opinion is that the help icon contained within the widget header is the best proposal.

Linking to the help under the widget title pushes the widget functionality to far down.

#19 @boemedia
11 months ago

Is there a convention for the help icon in other places in WordPress? If not, I guess I prefer the help icon in the widget header, as it makes it visible too when the widget is collapsed. If this option is implemented, maybe add this to 10ups SketchPress document for future reference?

#20 @pento
11 months ago

  • Milestone changed from 5.0 to 5.1

#21 @afercia
8 months ago

  • Milestone changed from 5.1 to Future Release
  • Priority changed from high to normal

The 5.1 release beta 1 is today and this ticket still needs a direction and patch. Punting to Future Release. Pinging the Widgets component maintainers: @westonruter @welcher

Last edited 8 months ago by afercia (previous) (diff)
Note: See TracTickets for help on using tickets.