Electron Documentation1.7.9

Docs / Tutorial / Accessibility

Accessibility

Making accessible applications is important and we’re happy to introduce new functionality to Devtron and Spectron that gives developers the opportunity to make their apps better for everyone.


Accessibility concerns in Electron applications are similar to those of websites because they’re both ultimately HTML. With Electron apps, however, you can’t use the online resources for accessibility audits because your app doesn’t have a URL to point the auditor to.

These new features bring those auditing tools to your Electron app. You can choose to add audits to your tests with Spectron or use them within DevTools with Devtron. Read on for a summary of the tools or checkout our accessibility documentation for more information.

Spectron

In the testing framework Spectron, you can now audit each window and <webview> tag in your application. For example:

app.client.auditAccessibility().then(function (audit) {
  if (audit.failed) {
    console.error(audit.message)
  }
})

You can read more about this feature in Spectron’s documentation.

Devtron

In Devtron, there is a new accessibility tab which will allow you to audit a page in your app, sort and filter the results.

devtron screenshot

Both of these tools are using the Accessibility Developer Tools library built by Google for Chrome. You can learn more about the accessibility audit rules this library uses on that repository’s wiki.

If you know of other great accessibility tools for Electron, add them to the accessibility documentation with a pull request.


See something that needs fixing? Propose a change on the source.
Need a different version of the docs? See the available versions or community translations.
Want to search all the documentation at once? See all of the docs on one page.