This is an alternative site for discovering Elm packages. You may be looking for the official Elm package site instead.
1.0.0 2.0.0
Drop-in replacement for tesk9/accessible-html using Html.Styled
version 1.0.0
license BSD3
native-modules False
elm-version 0.18.0 <= v <= 0.18.0
Tag 1.0.1
Committed At 2018-05-02 15:01:40 UTC
rtfeldman/elm-css 13.0.0 <= v < 15.0.0 14.0.0
elm-lang/html 2.0.0 <= v < 3.0.0 2.0.0
elm-lang/core 5.1.1 <= v < 6.0.0 5.1.1

README

accessible-html-with-css

tesk9/accessible-html-css makes writing accessible websites easier. It is a drop-in replacement for tesk9/accessible-html which exposes Html.Styled values instead of Html values.

Using this Library

Use the Accessibility module to encourage accessible practices:

import Accessibility as Html exposing (..)

There are also attribute helpers that enable you to do some pretty advanced cool stuff! Many of these helpers are not necessary when writing semantically correct HTML5 code, but you will still need some of them when rolling your own dynamic widgets. The import expressions below point out some of the helpers that you are more likely to need:

import Accessibility.Aria exposing (controls, labelledBy, describedBy)
import Accessibility.Key exposing (onKeyDown, left, right, enter, escape)
import Accessibility.Landmark exposing (search)
import Accessibility.Live exposing (atomic, busy, liveAssertive, livePolite)
import Accessibility.Role exposing (presentation)
import Accessibility.Style exposing (invisible)

Resources

A great place to start is reading about the principles of accessibility. By starting out with the design goals of Perceivable, Operable, Understandable, and Robust, you'll be able to find the information you need when reading the WAI-ARIA spec.

If you know you want to make a specific kind of widget, the Web Accessibility Initiative has specific authoring best practices and recommendations for you, along with really great examples.

For examples of how to use this library, check out accessible-html-examples and its source code.

Modules

Accessibility

This section extends the html library to include tab* elements, radio, inputText, checkbox, and more. It also shadows the elm-lang/html library to encourage limiting interactive behavior to html5 interactable elements.

Accessibility.Aria

This section includes roles for working with sets, grids, controls, and more. You're most likely to want the helpers for connecting elements to each other, by specifying that one controls another, or that a figure has details somewhere else.

Accessibility.Key

When making widgets, you will need to add keyboard shortcuts to make keyboard navigation possible.

For instance, space and on enter should activate a button,space should change a checkbox's state, escape should close a modal, and up, down, left, and right should navigate focus in a menu.

Accessibility.Landmark

You're likely to only want search from this section unless you're not using HTML5 elements.

Accessibility.Live

Describe which sections of the page are changing over time, and how aggressively assistive technologies should notify the user about those changes.

Accessibility.Role

Much of the time, sticking with HTML5 is better than using these properties. However, the WAI-ARIA spec moves at a different pace than the HTML spec--and user agent technologies are another factor entirely! You are likely to find yourself using a combination of these Accessibility.Role attributes.

Accessibility.Style

This section contains helpers for changing the look of your site without making it unusable.

For instance, if you prefer to use placeholders to convey what sort of values belong in an input, you can use the invisible helper to remove the label for screenviewers without removing it for screenreaders.

Accessibility.Widget

Look here for managing widget state: is a given widget expanded or disabled or pressed?

If you're rolling your own widget, you need to take a peek at this section.