JSPM – @instructure/ui-a11y@6.16.1-rc.0+13a9dff0a

Package Exports

@instructure/ui-a11y
@instructure/ui-a11y/lib/AccessibleContent
@instructure/ui-a11y/lib/Dialog
@instructure/ui-a11y/lib/PresentationContent
@instructure/ui-a11y/lib/ScreenReaderContent
@instructure/ui-a11y/lib/findFocusable
@instructure/ui-a11y/lib/findFocusable.js
@instructure/ui-a11y/lib/findTabbable
@instructure/ui-a11y/lib/hasVisibleChildren

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@instructure/ui-a11y) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

category: packages

Installation

yarn add @instructure/ui-a11y

Usage

import React from 'react'
import { Dialog } from '@instructure/ui-a11y'

const MyAccessibleContent = () => {
  return (
    <AccessibleContent alt="Alternative text for a screenreader only">
        Presentational content goes here
    </AccessibleContent>
  )
}

Components

The ui-a11y package contains the following components:

AccessibleContent will be removed in version 7.0.0. Use the AccessibleContent from ui-a11y-content instead.
Dialog
PresentationContent will be removed in version 7.0.0. Use the PresentationContent from ui-a11y-content instead.
ScreenReaderContent will be removed in version 7.0.0. Use the ScreenReaderContent from ui-a11y-content instead.

Utilities

The ui-a11y package contains the following utilities:

findTabbable
findFocusable
FocusManager
scopeTab

Contribute

See the contributing guidelines for details.

License

MIT