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.

Sign up for GitHub

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

Jump to bottom

Add heading to the block inserter tips (#22863) #22898

Merged
merged 2 commits into from
Jun 5, 2020
Merged

Add heading to the block inserter tips (#22863) #22898

merged 2 commits into from
Jun 5, 2020

Conversation

gaambo
Copy link
Contributor

@gaambo gaambo commented Jun 4, 2020 •
edited by ZebulanStanphill
Loading

closes #22683 #22863

Description

Adds a heading for the tips in the block inserter as discussed in #22683

How has this been tested?

  • Open the block inserter
  • Heading is not visible (only for alternate devices like screenreader)

Screenshots

grafik

Types of changes

  • Bug fix only
  • Adds a new element with the class block-editor-inserter__tips-title allthough no need for styling because it's wrapped in a VisuallyHidden component.
  • Adds a Text of Tips for using the block editor: which needs translation

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

youknowriad
youknowriad reviewed Jun 4, 2020
View reviewed changes
packages/block-editor/src/components/inserter/menu.js Outdated
@@ -92,6 +92,11 @@ function InserterMenu( {
</div>
{ showInserterHelpPanel && (
<div className="block-editor-inserter__tips">
<VisuallyHidden>
<h2 className="block-editor-inserter__tips-title">
{ __( 'Tips for using the block editor:' ) }
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the PR 👍 I think we should probably remove the ":" and we may want to reword that a little bit. I'll add a "copy review" label.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks - should I wait for the copy review before updating the PR without the : or should I change it right now?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, let's wait a bit and do a single update.

Copy link
Member

@ZebulanStanphill ZebulanStanphill Jun 4, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Since only one tip is shown at a time, I think it should say "Tip for using the block editor".

Copy link

Choose a reason for hiding this comment

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

For the copy, can we just say "Block editor tip!"

Copy link
Member

Choose a reason for hiding this comment

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

@michelleweber Remember, this is screen-reader-only text. I think adding an exclamation point might make the screen reader say it with a different inflection, which may not be desirable. (Then again, I've never used a screen reader, so I have no idea.)

Copy link

Choose a reason for hiding this comment

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

Ah, gotcha. In that case, I say stick with "A tip for using the block editor:"

(With whatever final punctuation makes the most sense for a screen reader.)

@youknowriad youknowriad added [Type] Enhancement A suggestion for improvement. Good First Review A PR that's suitable for someone looking to contribute for the first time by reviewing code Needs Accessibility Feedback Need input from accessibility Needs Copy Review Needs review of user-facing copy (language, phrasing) labels Jun 4, 2020
@ZebulanStanphill ZebulanStanphill added the [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). label Jun 4, 2020
@gaambo
Copy link
Contributor Author

gaambo commented Jun 5, 2020

Thanks for the feedback. Just pushed a commit with a new message as suggested in the comments and rendering the visuallyhidden component as h2.

youknowriad
youknowriad approved these changes Jun 5, 2020
View reviewed changes
Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for the work here.

@youknowriad youknowriad merged commit 23ef20f into WordPress:master Jun 5, 2020
@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Jun 5, 2020
@github-actions
Copy link

github-actions bot commented Jun 5, 2020

Congratulations on your first merged pull request, @gaambo! We'd like to credit you for your contribution in the post announcing the next WordPress release, but we can't find a WordPress.org profile associated with your GitHub account. When you have a moment, visit the following URL and click "link your GitHub account" under "GitHub Username" to link your accounts:

https://profiles.wordpress.org/me/profile/edit/

And if you don't have a WordPress.org account, you can create one on this page:

https://login.wordpress.org/register

Kudos!

@github-actions github-actions bot added this to the Gutenberg 8.3 milestone Jun 5, 2020
@gaambo gaambo deleted the update/block-inserter branch June 5, 2020 11:52
@ZebulanStanphill
Copy link
Member

Haha, the issues linked in the description was the wrong one. It was #22683 rather than the correct #22863 (named in the title). Coincidentally, the first issue is one of mine and is unrelated. I'll reopen my issue and close the correct one. 😆

@ZebulanStanphill ZebulanStanphill mentioned this pull request Jun 5, 2020
Closed
@youknowriad
Copy link
Contributor

@ZebulanStanphill my mistake sorry :)

@oandregal oandregal changed the title Adds a heading to the block inserters tips (#22863) Add heading to the block inserter tips (#22863) Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michelleweber michelleweber michelleweber left review comments

@ZebulanStanphill ZebulanStanphill ZebulanStanphill left review comments

@youknowriad youknowriad youknowriad approved these changes

@ellatrix ellatrix Awaiting requested review from ellatrix

Assignees
No one assigned
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). Good First Review A PR that's suitable for someone looking to contribute for the first time by reviewing code Needs Accessibility Feedback Need input from accessibility Needs Copy Review Needs review of user-facing copy (language, phrasing) [Type] Enhancement A suggestion for improvement.
Projects
None yet
Milestone
Gutenberg 8.3
Development

Successfully merging this pull request may close these issues.
5 participants
@gaambo @ZebulanStanphill @youknowriad @afercia @michelleweber