onedionys-web-accessibility-helpers/README.md

One Dionys (Web Accessibility Helpers) - Functions and components that assist in making web applications more accessible to all users, including users with disabilities.

<h1 align="center">Welcome to One Dionys - Web Accessibility Helpers! 👋 </h1>

<p align="center">Functions and components that assist in making web applications more accessible to all users, including users with disabilities. 💖 </p>

<p align="center">
<img src="https://img.shields.io/github/contributors/onedionys/onedionys-web-accessibility-helpers?style=flat-square">
<img src="https://img.shields.io/github/issues/onedionys/onedionys-web-accessibility-helpers?style=flat-square">
<img src="https://img.shields.io/github/stars/onedionys/onedionys-web-accessibility-helpers?style=flat-square"> 
<img src="https://img.shields.io/github/forks/onedionys/onedionys-web-accessibility-helpers?style=flat-square">
<img src="https://img.shields.io/github/last-commit/onedionys/onedionys-web-accessibility-helpers.svg?style=flat-square">
<img src="https://img.shields.io/github/languages/code-size/onedionys/onedionys-web-accessibility-helpers?style=flat-square">
<img src="https://img.shields.io/github/license/onedionys/onedionys-web-accessibility-helpers?style=flat-square">
</p>

## 💾 Requirements

* `Web Browser` - Can be used as an emulator to build applications. Example [Chrome, Firefox, Safari & Opera].
* `Internet` - Because many use CDN and to make it easier to find solutions to all problems.

## 🎯 How To Use

#### Example Syntax

```javascript
// Import the helper function
const { hideElements } = require('./src/accessibility-helpers');

// Hide elements with class 'hidden-element'
hideElements('.hidden-element');
```

#### Explanation

* This package provides helper functions to enhance web accessibility by adding ARIA attributes to elements. Currently, it includes the hideElements function, which adds the aria-hidden attribute to specified elements to hide them from assistive technologies while still keeping them visible on the page.

#### Return Value

* `hideElements`: This function does not return any value. It simply adds the aria-hidden attribute to the specified elements.

## 📆 Release Date

* v1.0.0 : 17 March 2024
* v1.0.1 : 18 March 2024
* v5.0.0 : 31 March 2024

## 🧑 Author

* Facebook : <a href="https://www.facebook.com/theonedionys"> Oned Ionys</a>
* Instagram : <a href="https://www.instagram.com/onedionys/"> @onedionys</a>
* Twitter : <a href="https://twitter.com/onedionys"> @onedionys</a>
* LinkedIn :  <a href="https://www.linkedin.com/in/onedionys/"> @onedionys</a>

## 📝 License

* Copyright © 2024 One Dionys
* **One Dionys - Web Accessibility Helpers is an open source project licensed under the MIT license**

## ☕️ Suppport & Donation

Love One Dionys - Web Accessibility Helpers? Support this project by donating or sharing with others in need.

<a href="https://www.buymeacoffee.com/onedionys"><img src="https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black"/> </a>

**Made with ❤️ One Dionys**