Skip to content

Commit

Permalink
Update a11y.mdx
Browse files Browse the repository at this point in the history
  • Loading branch information
damassi committed Aug 26, 2021
1 parent 0a508d2 commit 918542d
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions packages/palette-docs/content/docs/guides/a11y.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,13 @@ When adding click handlers to UI that aren't explicitly Palette `Button`s or anc

When using inserting images ensure they have an `alt` attribute. The `alt` attribute should typically:

* Be accurate and equivalent in presenting the same content and function of the image.
* Be succinct. This means the correct content (if there is content) and function (if there is a function) of the image should be presented as succinctly as is appropriate. Typically no more than a few words are necessary, though rarely a short sentence or two may be appropriate.
* NOT be redundant or provide the same information as text within the context of the image.
* NOT use the phrases "image of ..." or "graphic of ..." to describe the image. It is usually apparent to the user that it is an image. And if the image is conveying content, it is typically not necessary that the user know that it is an image that is conveying the content, as opposed to text. If the fact that an image is a photograph or illustration, etc. is important content, it may be useful to include this in alternative text.
\- Be accurate and equivalent in presenting the same content and function of the image.

\- Be succinct. This means the correct content (if there is content) and function (if there is a function) of the image should be presented as succinctly as is appropriate. Typically no more than a few words are necessary, though rarely a short sentence or two may be appropriate.

\- NOT be redundant or provide the same information as text within the context of the image.

\- NOT use the phrases "image of ..." or "graphic of ..." to describe the image. It is usually apparent to the user that it is an image. And if the image is conveying content, it is typically not necessary that the user know that it is an image that is conveying the content, as opposed to text. If the fact that an image is a photograph or illustration, etc. is important content, it may be useful to include this in alternative text.

(Via [WebAIM guide](https://webaim.org/techniques/alttext/).)

Expand Down

0 comments on commit 918542d

Please sign in to comment.