Opened 6 years ago
Last modified 19 months ago
#41876 new defect (bug)
Add inline help to Custom HTML widget
Reported by: |
|
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:
Attachments (1)
Change History (26)
This ticket was mentioned in Slack in #core-customize by westonruter. View the logs.
6 years ago
#4
@
6 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.
This ticket was mentioned in Slack in #accessibility by afercia. View the logs.
6 years ago
This ticket was mentioned in Slack in #design by karmatosed. View the logs.
6 years ago
This ticket was mentioned in Slack in #core by jeffpaul. View the logs.
6 years ago
This ticket was mentioned in Slack in #accessibility by afercia. View the logs.
6 years ago
#10
@
6 years ago
- Type changed from enhancement to defect (bug)
Changing to a defect
since it's needed for accessibility.
#11
@
6 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.
6 years ago
This ticket was mentioned in Slack in #core by westonruter. View the logs.
6 years ago
This ticket was mentioned in Slack in #design by karmatosed. View the logs.
5 years ago
This ticket was mentioned in Slack in #accessibility by rianrietveld. View the logs.
5 years ago
#18
@
5 years 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
@
5 years 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?
#21
@
4 years 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
This ticket was mentioned in Slack in #design by karmatosed. View the logs.
4 years ago
#23
@
4 years ago
Just going through this as part of design triage. @melchoyce do you have a preference for direction here? I ask as you were working on this.
#24
@
4 years ago
I'd love to see a patch writing up the header version, just to figure out if it'll work or feel janky (since the rest of the header open/closes the accordion).
As suggested by @afercia, this can be generalized so that when you construct
WP_Widget
there can be an optionalhelp
parameter forcontrol_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.