Skip to main content

A11yInfoProvider

Library
UDS Base
Repository
github.com/telus/universal-design-system
Package
npmjs.com/package/@telus-uds/components-base
Package version
1.6.1
<A11yInfoProvider>{/* content requiring A11yInfo */}</A11yInfoProvider>

Introduction

import { A11yInfoProvider } from '@telus-uds/components-base'

Guidance

info

A11yInfoProvider is automatically included in BaseProvider. You don't need to include A11yInfoProvider in your app separately if you are already using BaseProvider.

A11yInfoProvider provides a react, cross platform API onto user device accessibility data. These data can be accessed with the useA11yInfo hook.

import { useA11yInfo } from '@telus-uds/components-base'
// ...
const { screenReaderEnabled, reduceMotionEnabled } = useA11yInfo()

Props

NameTypeDefaultDescription
children*node
```