Docs

Appearance

Installation ​

Get BrowseAid Widget up and running on your website in minutes with our simple integration options.

Quick Installation ​

The fastest way to add BrowseAid Widget to your website:

Add this single script tag to your HTML <head> section:

html
<script src="https://storage.browseaid.com/latest/assets/index.js" type="module"></script>

That's it! The widget will automatically initialize with default settings.

Verification ​

After installation, verify the widget is working:

  1. Visual Check: Look for the accessibility icon (usually in the bottom corner)
  2. Console Check: Open browser dev tools and check for any errors
  3. Functionality Test: Click the widget icon to open the accessibility panel

Troubleshooting ​

Widget Not Appearing ​

  1. Check Console Errors: Look for JavaScript errors in browser dev tools
  2. Verify Script Path: Ensure the script URL is correct and accessible
  3. Check Network Tab: Verify the script is loading (status 200)

Script Loading Issues ​

html
<!-- Add error handling -->
<script
  src="https://storage.browseaid.com/latest/assets/index.js"
  type="module"
  onerror="console.error('Failed to load BrowseAid Widget')"
></script>

Content Security Policy (CSP) ​

If you're using CSP, add these directives:

script-src 'self' https://storage.browseaid.com;
style-src 'self' 'unsafe-inline';

Performance Considerations ​

Async Loading ​

For better page performance, load the widget asynchronously:

html
<script async src="https://storage.browseaid.com/latest/assets/index.js" type="module"></script>

Defer Loading ​

Or defer loading until the page is parsed:

html
<script defer src="https://storage.browseaid.com/latest/assets/index.js" type="module"></script>

Next Steps ​

Now that you have the widget installed:

  1. ⚙️ Learn about Configuration Options
  2. 🛠️ Explore the Tools Documentation to understand all features

BrowseAid Documentation

Copyright © 2025 BrowseAid