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

Consider to improve the Post Format suggestion design and accessibility #9363

Closed
afercia opened this issue Aug 26, 2018 · 6 comments
Closed
Labels
[Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Type] Enhancement A suggestion for improvement.

Comments

@afercia
Copy link
Contributor

afercia commented Aug 26, 2018

When Gutenberg detects a post content could benefit from applying a specific post format, a suggestion appears in the Sidebar:

screen shot 2018-08-26 at 19 26 11

Depending on the content, it can be any of the post formats, e.g. a Gallery:

screen shot 2018-08-26 at 19 56 52

Clicking the suggested format, sets the format in the post.

I think there are a couple things that could be improved:

  • the placement of the suggestion could maybe be improved and be aligned to the left
  • the button text could be improved for better understanding and accessibility: UI controls should make sense even when read out of context; instead, the button says just "Video" (or "Gallery", etc.), the current rendered markup is:
<div class="editor-post-format__suggestion">
	Suggestion:
	<button type="button" class="components-button is-link">Video</button>
</div>

Instead, the post format suggestion displayed in the publishing flow is clearer and makes sense even when read out of context:

screen shot 2018-08-26 at 19 57 19

screen shot 2018-08-26 at 19 57 38

I'd suggest to refactor the text used in the Sidebar to use something along the lines of the one used in the Publishing flow.

@afercia afercia added [Type] Enhancement A suggestion for improvement. [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). Needs Design Feedback Needs general design feedback. labels Aug 26, 2018
@afercia afercia changed the title Consider to improve the Pos Format suggestion design and accessibility Consider to improve the Post Format suggestion design and accessibility Aug 27, 2018
@afercia
Copy link
Contributor Author

afercia commented Aug 27, 2018

A very quick first attempt, before (left) and after(right):

screen shot 2018-08-27 at 18 38 47

@karmatosed
Copy link
Member

What is the a11y reason for the left? I ask as it's making it less readable so trying to find the balance.

@afercia
Copy link
Contributor Author

afercia commented Oct 9, 2018

What is the a11y reason for the left?

I'm not sure I fully understand. Do you mean left alignment? To me, it's more readable left aligned. Besides subjective opinions that might differ, this text now is longer (and potentially even longer when translated) and doesn't look so nice when right-aligned.

@tofumatt
Copy link
Member

I'm definitely for the more elaborate text. As it is it's both not accessible nor very useful to sighted users.

I honestly think it looks a bit meh left-aligned or right-aligned, but in shorter locales it should look a bit better right-aligned (and more connected with the dropdown, which adds context).


That said, I think the pre-publish panel suggestion is a better place for this and I'd be for removing this all-together from the document sidebar. It's a really crowded area, the space is cramped, and it's hard to make the text usable even for sighted users. I actually think adding some aria labels that added context for screenreader users would be easier than making this better for sighted users.

Now that the pre-publish panel offers it (in a much better way, with more context and better accessibility), let's just remove it.

@karmatosed
Copy link
Member

@afercia thanks for the explanation. I wanted to make sure it was a visual not hierarchy for screen readers or other assisted devices.

As people expect to see post formats in the actual sidebar right now, it's not a mental model I think we should break today. Some themes hook into it for display.

Let's get this in but not aligned left. I think right for now. Do we need to say all of that text, fine if we do but wanted to check.

@karmatosed karmatosed removed the Needs Design Feedback Needs general design feedback. label Oct 11, 2018
@tofumatt
Copy link
Member

All of that text needs to be there. It's inaccessible if not, but it's also just poor usability. It should read:

Suggestion: Apply the "$FORMAT" format.

I can't think of a less-verbose way of phrasing it that doesn't lose context, but if anyone can, go for it ^_^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

No branches or pull requests

3 participants