Documentation

Getting started

ClearPath adds an accessibility widget to your site with one line of code. Most people go from sign up to a live widget in about 5 minutes, no developer required for the basic setup.

The widget ships with 25 accessibility tools, 14 languages, and 8 disability profiles out of the box. Once it is on your page, visitors can adjust contrast, resize text, pause animations, and switch on reading aids without you writing any custom code.

• Create an account and add your first site to get an account ID that looks like cp_xxx.
• Copy your install snippet from the dashboard.
• Paste it into your site and publish.

Installing the widget

Add the script tag below just before the closing body tag on every page where you want the widget to appear. Replace cp_xxx with your own account ID from the dashboard. The defer attribute keeps the script from blocking your page load.

That is the whole install. There is nothing to build, no package to add, and no framework requirement. If your site shares one template across all pages, you only paste it once.

• <script src="https://get-clearpath.com/widget/clearpath.min.js" data-account="cp_xxx" data-api="https://get-clearpath.com" defer></script>
• data-account is your account ID. It tells the widget which configuration to load.
• data-api points at the ClearPath API and should stay as shown unless support tells you otherwise.

Platform plugins and guides

If you would rather not touch code at all, we publish plugins and step by step guides for WordPress, Shopify, Wix, Webflow, and 20 or more other platforms. Each guide shows exactly where the snippet goes for that platform, with screenshots.

The plugins do the same thing the manual snippet does: they load the widget with your account ID. Pick whichever route fits how you already manage your site.

• WordPress: install the ClearPath plugin, paste your account ID, and save.
• Shopify: add the snippet to theme.liquid or use the app.
• Wix and Webflow: paste the snippet into the custom code or embed area.
• Everything else: follow the generic script tag guide.

Configuring the widget from the dashboard

You control how the widget looks and behaves from the dashboard, not from code. Changes you save there are picked up by the widget the next time a visitor loads a page, so you do not need to touch the snippet again after install.

From the dashboard you can set the button position and color, choose which of the 14 languages to default to, decide which tools and profiles are shown, and match the widget to your brand.

• Position: place the trigger button in any corner.
• Appearance: set the button color, size, and icon.
• Language: pick a default and let visitors switch.
• Tools and profiles: turn individual features on or off.

The accessibility statement

ClearPath can generate an accessibility statement for your site based on a live scan of your pages, written in your site's language. It documents what the widget provides and describes your accessibility efforts.

A statement is expected by many accessibility policies and is a normal part of working toward WCAG 2.2, ADA, and EN 301 549 goals. Publish the generated page and link to it from your footer. Keep in mind the statement describes your efforts, it does not by itself fix underlying code issues.

Usage analytics

The dashboard shows real, per site usage analytics rather than generic estimates. As visitors load the widget, open it, and use individual tools, ClearPath records those events and reports them back to you.

This tells you whether people are actually finding and using the accessibility features on your site, and which tools matter most to your audience. Use it to decide which profiles to feature and to show stakeholders that the investment is being used.

• Loads: how often the widget appeared.
• Opens: how often visitors opened the panel.
• Tool usage: which specific tools get used most.

Troubleshooting

If the widget does not appear, the most common cause is domain binding. For security, the widget only loads on the domain you registered in the dashboard and its subdomains. If you moved to a new domain or are testing on a staging URL that is not registered, add it to your site settings first.

A few other things to check when the button is missing or looks wrong.

• Confirm the account ID in data-account matches the one in your dashboard.
• Make sure the snippet is on the page and not blocked by a caching layer.
• Check that the current domain or subdomain is registered for the account.
• Clear your cache or try a private window, since old page copies can hide a fresh install.
• If a content blocker is active, allow scripts from get-clearpath.com.