UNPKG

access-simple

Version:

## Introduction `access-simple` is an open-source React library that provides an accessible menu component. This library is designed to enhance accessibility for end users with features like adjustable font sizes and contrast settings.

46 lines (31 loc) 1.96 kB
# access-simple ## Introduction `access-simple` is an open-source React library that provides an accessible menu component. This library is designed to enhance accessibility for end users with features like adjustable font sizes and contrast settings. ## Installation To install `access-simple`, run the following command: ```bash npm install access-simple ``` ## Usage To use access-simple in your project, import the AccessibleMenu component and the accompanying stylesheet in your app.js or main React file: ```javascript import { AccessibleMenu } from "access-simple"; import 'access-simple/dist/style.css'; ``` ## Features - **Font Adjustments**: Users can modify the size, spacing, and line height of the text, ensuring readability for various vision preferences. - **Color Adjustments**: Options to increase contrast and invert colors are available, making the content accessible for users with color vision deficiencies. - **Zoom & Enlarge**: The menu allows users to zoom in on content and enlarge interface elements, aiding those who need larger visuals for comfortable interaction. - **Animations**: Users have the ability to disable animations, assisting those with motion sensitivity or those who prefer a static interface. - **Multi-language Support**: The menu supports multiple languages including English, Portuguese, and Spanish, accommodating a wider range of users. - **Feedback Link**: Directly embedded in the menu for users to provide their valuable feedback easily and effectively. ##### Feel free to contribute more features :D ## Contributing We welcome contributions! If you would like to contribute, please follow these steps: - Fork the repository - Create a new branch for your feature - Submit a pull request ## Feedback Your feedback is valuable to us. Please fill out this form to provide feedback: [Feedback Form](https://forms.gle/SEQ6XKLiS2GAXBtq9) ## License MIT © [AndreRSFC](https://github.com/AndreRSFC)