Skip to main content

Intro

The core package @react-native-ama/core offers essential hooks and components needed to create an app with accessibility in mind.

Installation​

Install the @react-native-ama/core package with your favourite package manager:

npm install  @react-native-ama/core

Config File​

If you install the react-native-ama package, the ama.rules.json file should be generated automatically. In case it doesn't generate automatically:

echo "{}" >> ama.rules.json
cd node_modules/react-native-ama
ln -s ../../ama.rules.json .

For more detailed information about the config file, please refer to this documentation.

Usage​

You must include the AMAProvider in your app, as some components and hooks require it.

import { AMAProvider } from 'react-native-ama';

const App = () => {
  return (
    <AMAProvider>
      <YourApp />
    </AMAProvider>
  );
};