Skip to content

BottyIvan/accessibility-plugin-xyz

Repository files navigation

Accessibility Plugin

This project is an accessibility plugin that enhances the usability of your website by providing features such as font size adjustment and display mode.

Features

  • Font Size Adjustment: Allows users to change the text size on the site.
  • Display Mode: Allows choosing between a fixed bottom display or an inline display.
  • Text Highlighting: Highlights interactive elements when the user hovers over them.
  • Form Guide: Provides guidance messages when users interact with form fields.

Installation

Install dependencies:

npm install
npm i accessibility-plugin-xyz

Usage

Development Environment

Clone the repository and navigate to the project directory:

git clone https://github.com/BottyIvan/accessibility-plugin-xyz.git
cd accessibility-plugin-xyz

To start the development environment, run:

npm run dev

Production Build

To create a production build, run:

npm run build

Preview Build

To preview the production build, run:

npm run preview

Configuration

You can configure the plugin by modifying the vite.config.ts file and the files in the src folder.

Contributions

Contributions are welcome! Feel free to open issues and pull requests.

License

This project is licensed under the ISC license.