React NativeAccessibilityInfo #
Sometimes it's useful to know whether or not the device has a screen reader that is currently active. The
AccessibilityInfo API is designed for this purpose. You can use it to query the current state of the
screen reader as well as to register to be notified when the state of the screen reader changes.
Here's a small example illustrating how to use AccessibilityInfo:
class ScreenReaderStatusExample extends React.Component {
state = {
screenReaderEnabled: false,
}
componentDidMount() {
AccessibilityInfo.addEventListener(
'change',
this._handleScreenReaderToggled
);
AccessibilityInfo.fetch().done((isEnabled) => {
this.setState({
screenReaderEnabled: isEnabled
});
});
}
componentWillUnmount() {
AccessibilityInfo.removeEventListener(
'change',
this._handleScreenReaderToggled
);
}
_handleScreenReaderToggled = (isEnabled) => {
this.setState({
screenReaderEnabled: isEnabled,
});
}
render() {
return (
<View>
<Text>
The screen reader is {this.state.screenReaderEnabled ? 'enabled' : 'disabled'}.
</Text>
</View>
);
}
}
Methods #
static fetch(0) #
Query whether a screen reader is currently enabled. Returns a promise which
resolves to a boolean. The result is true when a screen reader is enabled
and false otherwise.
static addEventListener(eventName, handler) #
Add an event handler. Supported events:
change: Fires when the state of the screen reader changes. The argument to the event handler is a boolean. The boolean istruewhen a screen reader is enabled andfalseotherwise.
static removeEventListener(eventName, handler) #
Remove an event handler.
You can edit the content above on GitHub and send us a pull request!