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

Promote good accessibility practices in example code #1624

Closed
chipit24 opened this issue May 13, 2018 · 2 comments
Closed

Promote good accessibility practices in example code #1624

chipit24 opened this issue May 13, 2018 · 2 comments

Comments

@chipit24
Copy link
Contributor

chipit24 commented May 13, 2018

I came across the following code block in the Vue docs, from https://vuejs.org/v2/guide/list.html#v-for-on-a-lt-template-gt:

<ul>
  <template v-for="item in items">
    <li>{{ item.msg }}</li>
    <li class="divider"></li>
  </template>
</ul>

To help promote good accessibility practices, I think these examples could be updated to include any relevant aria attributes, roles, etc.:

<ul>
  <template v-for="item in items">
    <li>{{ item.msg }}</li>
    <li class="divider" role="presentation"></li>
  </template>
</ul>

See https://www.w3.org/TR/wai-aria-1.1/#presentation.

Once the accessibility guide (#1002) is finished, references to such attributes can link to explanations in the guide.

This is one example, but I'm sure there are others, and I would like to get your thoughts on this :) I could go through the rest of the docs and get a PR put together.

@sdras
Copy link
Member

sdras commented May 13, 2018

This would be fantastic! Even if you wanted to do it a little at a time, I think we would all be super appreciative.

There is also an older PR in to create an accessibility section. The PR has become a bit cumbersome for the original author given his schedule and he's looking for someone to help pick it up again. That's another way to contribute if it interests you. Thanks!

@chipit24 chipit24 changed the title Promote good accessibility practises in example code Promote good accessibility practices in example code May 13, 2018
@chipit24
Copy link
Contributor Author

I put up a PR that I will add to throughout the next 1-2 weeks as I work through the documentation.

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

No branches or pull requests

2 participants