mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

docs: clarify a11y docs (#24973)

Browse source 
* docs: remove misleading sentence in a11y docs

* Update accessibility.md

* link
This commit is contained in:
Erick Zhao 2020-09-08 04:37:00 -07:00 • committed by GitHub
parent 2c5c51afb9
commit f7d9d68e14
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/README.md
View file

@ -56,7 +56,7 @@ an issue:
* [Accessibility](tutorial/accessibility.md) * [Accessibility](tutorial/accessibility.md)
* [Spectron](tutorial/accessibility.md#spectron) * [Spectron](tutorial/accessibility.md#spectron)
* [Devtron](tutorial/accessibility.md#devtron) * [Devtron](tutorial/accessibility.md#devtron)
* [Enabling Accessibility](tutorial/accessibility.md#enabling-accessibility) * [Manually Enabling Accessibility Features](tutorial/accessibility.md#manually-enabling-accessibility-features)
* [Testing and Debugging](tutorial/application-debugging.md) * [Testing and Debugging](tutorial/application-debugging.md)
* [Debugging the Main Process](tutorial/debugging-main-process.md) * [Debugging the Main Process](tutorial/debugging-main-process.md)
* [Debugging the Main Process with Visual Studio Code](tutorial/debugging-main-process-vscode.md) * [Debugging the Main Process with Visual Studio Code](tutorial/debugging-main-process-vscode.md)

37
docs/tutorial/accessibility.md
View file

@ -1,6 +1,6 @@
# Accessibility # Accessibility
Making accessible applications is important and we're happy to introduce new Making accessible applications is important and we're happy to provide
functionality to [Devtron][devtron] and [Spectron][spectron] that gives functionality to [Devtron][devtron] and [Spectron][spectron] that gives
developers the opportunity to make their apps better for everyone. developers the opportunity to make their apps better for everyone.
@ -11,7 +11,7 @@ websites because they're both ultimately HTML. With Electron apps, however,
you can't use the online resources for accessibility audits because your app you can't use the online resources for accessibility audits because your app
doesn't have a URL to point the auditor to. doesn't have a URL to point the auditor to.
These new features bring those auditing tools to your Electron app. You can These 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 choose to add audits to your tests with Spectron or use them within DevTools
with Devtron. Read on for a summary of the tools. with Devtron. Read on for a summary of the tools.
@ -32,7 +32,7 @@ You can read more about this feature in [Spectron's documentation][spectron-a11y
## Devtron ## Devtron
In Devtron, there is a new accessibility tab which will allow you to audit a In Devtron, there is an accessibility tab which will allow you to audit a
page in your app, sort and filter the results. page in your app, sort and filter the results.
![devtron screenshot][devtron-screenshot] ![devtron screenshot][devtron-screenshot]
@ -44,26 +44,29 @@ audit rules this library uses on that [repository's wiki][a11y-devtools-wiki].
If you know of other great accessibility tools for Electron, add them to the If you know of other great accessibility tools for Electron, add them to the
accessibility documentation with a pull request. accessibility documentation with a pull request.
## Enabling Accessibility ## Manually enabling accessibility features
Electron applications keep accessibility disabled by default for performance Electron applications will automatically enable accessibility features in the
reasons but there are multiple ways to enable it. presence of assistive technology (e.g. [JAWS](https://www.freedomscientific.com/products/software/jaws/)
on Windows or [VoiceOver](https://help.apple.com/voiceover/mac/10.15/) on macOS).
See Chrome's [accessibility documentation][a11y-docs] for more details.
### Inside Application You can also manually toggle these features either within your Electron application
or by setting flags in third-party native software.
By using [`app.setAccessibilitySupportEnabled(enabled)`][setAccessibilitySupportEnabled], ### Using Electron's API
you can expose accessibility switch to users in the application preferences.
User's system assistive utilities have priority over this setting and will
override it.
### Assistive Technology By using the [`app.setAccessibilitySupportEnabled(enabled)`][setAccessibilitySupportEnabled]
API, you can manually expose Chrome's accessibility tree to users in the application preferences.
Note that the user's system assistive utilities have priority over this setting and
will override it.
Electron application will enable accessibility automatically when it detects ### Within third-party software
assistive technology (Windows) or VoiceOver (macOS). See Chrome's
[accessibility documentation][a11y-docs] for more details.
On macOS, third-party assistive technology can switch accessibility inside #### macOS
Electron applications by setting the attribute `AXManualAccessibility`
On macOS, third-party assistive technology can toggle accessibility features inside
Electron applications by setting the `AXManualAccessibility` attribute
programmatically: programmatically:
```objc ```objc