-
Notifications
You must be signed in to change notification settings - Fork 0
FAQ
Common questions and answers about the Accessibility Widget.
A: Yes! The Accessibility Widget is completely free to use and modify for any purpose. There are no licensing fees, usage restrictions, or hidden costs.
A: No, you can use the CDN version which doesn't require hosting the files yourself. However, you can also download and host the files if you prefer.
A: Yes! The plugin works with WordPress. See the WordPress Integration guide for detailed instructions.
A: Yes! You can customize colors, position, styling, and more. See the Customization Guide for details.
A: Yes! The plugin is fully responsive and works on all mobile devices including iOS and Android.
A: No, the plugin is lightweight (< 50KB total) and has minimal performance impact. It's optimized for speed and efficiency.
A: Yes, the plugin helps websites comply with WCAG 2.1 guidelines and accessibility best practices.
A: Yes, you can use it on as many websites as you want. There are no restrictions.
A: No, it's completely client-side and requires no server configuration. It works on any web server.
A: Yes! The code is open source and you're free to modify it to suit your needs.
A: You need three files:
-
accessibility-plugin.js(main plugin) -
accessibility-plugin.css(styles) -
accessibility-config.js(optional configuration)
You also need Boxicons CSS (loaded from CDN).
A: The CSS and JS files are required. The config file is optional - if you don't include it, the plugin uses default settings.
A: Load in this order:
- Boxicons CSS
- Plugin CSS
- Config JS (optional)
- Plugin JS (must be last)
A: The plugin is designed to work with Boxicons. Using a different icon library would require modifying the code.
A: TTS works best in Chrome, Edge, and Safari. Firefox has limited TTS support. The plugin will gracefully handle browsers that don't support TTS.
A: The plugin can read up to 5000 characters at once. For longer content, users can select specific text to read.
A: Color blindness filters use SVG filters which may have a slight performance impact on very large pages with many images. For most websites, the impact is negligible.
A: Settings are saved in browser localStorage and persist across page reloads and browser sessions. They are per-domain, so each website has its own settings.
A: Yes, there's a reset button in the accessibility panel that restores all settings to defaults.
A: The plugin works on all modern browsers:
- Chrome 90+
- Firefox 88+
- Safari 14+
- Edge 90+
- Mobile browsers (iOS Safari, Chrome Mobile)
A: Yes! The plugin is framework-agnostic and works with any JavaScript framework or vanilla HTML.
A: Yes, though you may need to add type definitions. The plugin is plain JavaScript but works fine with TypeScript projects.
A: The plugin is designed to avoid conflicts. It uses namespaced code and scoped CSS. However, if you encounter conflicts, check the Troubleshooting guide.
A: Yes, you can customize which features are available via the configuration file or by modifying the code.
A: Yes, you can set the position to 'bottom-left' or 'bottom-right' in the config file, or use CSS to position it anywhere.
A: Yes, set the buttonText option in the config file to any text you want.
A: Yes, you can customize colors via CSS. See the Customization Guide for examples.
A: Yes, but it requires modifying the JavaScript code. See the Development Setup guide.
A: Open an issue on GitHub with:
- Description of the bug
- Steps to reproduce
- Browser and version
- Screenshots if applicable
A: Open a feature request on GitHub describing the feature you'd like.
A:
- Check the Troubleshooting guide
- Search existing GitHub issues
- Email: support@airforcerp.com
A: Currently, support is provided through GitHub issues and email. A community forum may be added in the future.
A: The plugin is free to use and modify for any purpose. There's no specific license - you can use it commercially, modify it, distribute it, etc.
A: Attribution is not required but appreciated! If you'd like to credit AirforceRP, that's great.
A: Yes, you can include it in commercial products without restrictions.
- Check the Troubleshooting guide
- Browse other Wiki pages
- Open an issue on GitHub
- Email: accessibility@airforcerp.com
- Installation Guide - Step-by-step installation instructions
- Quick Start Guide - Get up and running in 5 minutes
- Configuration Guide - Customize the plugin to your needs
- Features Overview - Complete list of all features
- JavaScript API - Programmatic control documentation
- Browser Compatibility - Supported browsers and features
- WordPress Integration - How to integrate with WordPress
- Customization Guide - Styling and theming
- Advanced Usage - Tips and tricks for power users
- Contributing - How to contribute to the project
- Development Setup - Set up your development environment
- Architecture - Understanding the codebase
- Troubleshooting - Common issues and solutions
- FAQ - Frequently asked questions
- Known Issues - Current limitations and workarounds