Skip to content

Update todo-list-example for a11y #1630

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

Merged
merged 2 commits into from
May 17, 2018
Merged

Update todo-list-example for a11y #1630

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
656030b
Update todo-list-example for a11y
chipit24 May 14, 2018
f51b019
Implement review suggestions
chipit24 May 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions src/v2/guide/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,11 +489,14 @@ Here's a complete example of a simple todo list:

``` html
<div id="todo-list-example">
<input
v-model="newTodoText"
v-on:keyup.enter="addNewTodo"
placeholder="Add a todo"
>
<form v-on:submit.prevent="addNewTodo">
<input
aria-label="Write a new todo item"
Copy link
Member

Choose a reason for hiding this comment

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

After speaking with an accessibility expert, my understanding is that if we're going to include a placeholder, it would be obscured by this aria-label. It would probably be better to use a label element: <label for="new-todo">Add a todo</label> and add an id on the input, that way the placeholder will still be accessible.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree with using a label. I also think a label element would be more familiar (and therefor less distracting) for readers than an aria-label attribute.

For the sake of my own understanding, would you know how the placeholder is obscured by aria-label?

placeholder="E.g. Feed the cat"
v-model="newTodoText"
Copy link
Member

Choose a reason for hiding this comment

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

I believe that we should keep the v-model as the first attribute, as that's what we're teaching here and it reduces the need for scanning on the part of the reader trying to learn.

>
<button>Add</button>
</form>
<ul>
<li
is="todo-item"
Expand All @@ -513,7 +516,7 @@ Vue.component('todo-item', {
template: '\
<li>\
{{ title }}\
<button v-on:click="$emit(\'remove\')">X</button>\
<button v-on:click="$emit(\'remove\')">Remove</button>\
</li>\
',
props: ['title']
Expand Down Expand Up @@ -553,11 +556,14 @@ new Vue({

{% raw %}
<div id="todo-list-example" class="demo">
<input
v-model="newTodoText"
v-on:keyup.enter="addNewTodo"
placeholder="Add a todo"
>
<form v-on:submit.prevent="addNewTodo">
<input
aria-label="Write a new todo item"
placeholder="E.g. Feed the cat"
v-model="newTodoText"
>
<button>Add</button>
</form>
<ul>
<li
is="todo-item"
Expand All @@ -573,7 +579,7 @@ Vue.component('todo-item', {
template: '\
<li>\
{{ title }}\
<button v-on:click="$emit(\'remove\')">X</button>\
<button v-on:click="$emit(\'remove\')">Remove</button>\
</li>\
',
props: ['title']
Expand Down