Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added optional 'description' prop to inspector controls #1570

Closed

Conversation

paulwilde
Copy link
Contributor

This adds an optional prop to all inspector controls to add description text below. Useful for help text.

screen shot 2017-06-28 at 21 20 45

@swissspidy
Copy link
Member

cc @afercia for a11y feedback

@afercia
Copy link
Contributor

afercia commented Jun 28, 2017

For all the controls, except "radio", I'd consider to associate the description to the form element with an aria-describedby attribute. This way, the description would be read out automatically when the form element gets focused.

I'd consider to don't use italic text (I think I've mentioned this also in another issue for the few cases where it's used in Gutenberg) as it's not a consistent convention across WordPress and makes readability harder for some users.

The description paragraph is a flex-item, not sure if it needs display: block. When the description is very short, it doesn't go in a new line because of flexbox. We should make sure it wraps in a new line: should probably have a 100% min-width:

screen shot 2017-06-29 at 00 23 53

* Fixed an issue where the small description would wrap parallel to the toggle control.
@gziolo
Copy link
Member

gziolo commented Sep 22, 2017

@paulwilde, this PR needs rebase and some small tweaks. It looks like a nice improvement, so it would be nice to land it into master :)

@gziolo gziolo self-requested a review September 22, 2017 14:37
Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Marking that it requires a rebase to continue.

@gziolo
Copy link
Member

gziolo commented Jan 27, 2018

I'm closing this one because it seems to be abandoned. Feel free to update the code to work with the current codebase and reopen. Thanks for spending your time working on this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants