-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Improve Accessibility Guidance for describe()
Usage
#8101
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
base: dev-2.0
Are you sure you want to change the base?
Changes from 9 commits
06019f3
8f24e3e
0aaf553
486e2db
944779c
6633de2
eb58aba
78ce6ac
2759e37
3da06c0
f911702
a0fae01
b218819
cebc00c
e2bd6b1
8549b93
cf75292
51534d6
74601d0
7cc2d8b
1ef5b37
84ee41e
493ceed
30d45e8
95a02d7
e8ae5d1
218313c
e10f7d0
6a2e30b
3dea4a1
0f90b46
2b0ead8
dd4afcb
86a3f24
d1b961c
0c0e5c8
cb89f1e
907cb87
d3e7e7a
8e60de2
3b9f224
f0b012f
bcd8324
b01a556
ed84b40
2ba8f22
b082995
fd71a5d
a9fac53
26dd043
c15d11a
89f8bad
a8cd5db
73841a3
aef34ea
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -1222,6 +1222,32 @@ class Mover { | |||||
|
||||||
## Assets | ||||||
|
||||||
# Canvas Accessibility Descriptions: `describe()` | ||||||
NalinDalal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
||||||
To make p5.js sketches accessible, every example that draws to the canvas should include a call to [`describe()`](https://p5js.org/reference/#/p5/describe). This provides a concise, visual description for screen readers. | ||||||
|
To make p5.js sketches accessible, every example that draws to the canvas should include a call to [`describe()`](https://p5js.org/reference/#/p5/describe). This provides a concise, visual description for screen readers. | |
To make p5.js sketches accessible, every example that draws to the canvas should include a call to [`describe()`](https://p5js.org/reference/p5/describe). This provides a concise, visual description for screen readers. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line is not needed - the whole style guide tries to be as compact as possible
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the style of the rest of this document, each of the above "best practices" should be illustrated with a "Good" and "Bad" example. Instead of splitting these and using sa table here, integrate illustrative examples in the list above.
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor: consider simpler and more direct language. "New to writing accessible canvas descriptions? Please check the Web Accessibility Contributor Doc and Writing Accessible Canvas Descriptions tutorial next."
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should also not be repeated (this is not a universal suggestion - but the style guide tries to be very compact)
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -242,6 +242,8 @@ When creating screen reader-accessible outputs, naming the colors used in the ca | |
|
||
### describe() | ||
|
||
**See also:** [Documentation Style Guide: Canvas Accessibility Descriptions](./documentation_style_guide.md#canvas-accessibility-descriptions-describe) for best practices, Do/Don’t examples, and summary guidance on writing effective `describe()` calls. | ||
|
||
|
||
The `describe()` function creates a sketch author-defined screen reader accessible description for the canvas. The first parameter should be a string with a description of the canvas. The second parameter is optional. If specified, it determines how the description is displayed. If a user passes `LABEL` as a second parameter, an additional `<div>` element is created next to the `<canvas>` element. The new `<div>` element contains a visible version of the same screen reader-accessible description embedded in the `<canvas>` element. | ||
|
||
`describe()` is supported by several methods in [src/accessibility/describe.js](https://github.com/processing/p5.js/blob/main/src/accessibility/describe.js): | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link won't work now because you removed this section on your latest commit?