Skip to content

Commit f7d9d68

Browse files
authored
docs: clarify a11y docs (electron#24973)
* docs: remove misleading sentence in a11y docs * Update accessibility.md * link
1 parent 2c5c51a commit f7d9d68

2 files changed

Lines changed: 21 additions & 18 deletions

File tree

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ an issue:
5656
* [Accessibility](tutorial/accessibility.md)
5757
* [Spectron](tutorial/accessibility.md#spectron)
5858
* [Devtron](tutorial/accessibility.md#devtron)
59-
* [Enabling Accessibility](tutorial/accessibility.md#enabling-accessibility)
59+
* [Manually Enabling Accessibility Features](tutorial/accessibility.md#manually-enabling-accessibility-features)
6060
* [Testing and Debugging](tutorial/application-debugging.md)
6161
* [Debugging the Main Process](tutorial/debugging-main-process.md)
6262
* [Debugging the Main Process with Visual Studio Code](tutorial/debugging-main-process-vscode.md)

docs/tutorial/accessibility.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Accessibility
22

3-
Making accessible applications is important and we're happy to introduce new
3+
Making accessible applications is important and we're happy to provide
44
functionality to [Devtron][devtron] and [Spectron][spectron] that gives
55
developers the opportunity to make their apps better for everyone.
66

@@ -11,7 +11,7 @@ websites because they're both ultimately HTML. With Electron apps, however,
1111
you can't use the online resources for accessibility audits because your app
1212
doesn't have a URL to point the auditor to.
1313

14-
These new features bring those auditing tools to your Electron app. You can
14+
These features bring those auditing tools to your Electron app. You can
1515
choose to add audits to your tests with Spectron or use them within DevTools
1616
with Devtron. Read on for a summary of the tools.
1717

@@ -32,7 +32,7 @@ You can read more about this feature in [Spectron's documentation][spectron-a11y
3232

3333
## Devtron
3434

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

3838
![devtron screenshot][devtron-screenshot]
@@ -44,26 +44,29 @@ audit rules this library uses on that [repository's wiki][a11y-devtools-wiki].
4444
If you know of other great accessibility tools for Electron, add them to the
4545
accessibility documentation with a pull request.
4646

47-
## Enabling Accessibility
47+
## Manually enabling accessibility features
4848

49-
Electron applications keep accessibility disabled by default for performance
50-
reasons but there are multiple ways to enable it.
49+
Electron applications will automatically enable accessibility features in the
50+
presence of assistive technology (e.g. [JAWS](https://www.freedomscientific.com/products/software/jaws/)
51+
on Windows or [VoiceOver](https://help.apple.com/voiceover/mac/10.15/) on macOS).
52+
See Chrome's [accessibility documentation][a11y-docs] for more details.
5153

52-
### Inside Application
54+
You can also manually toggle these features either within your Electron application
55+
or by setting flags in third-party native software.
5356

54-
By using [`app.setAccessibilitySupportEnabled(enabled)`][setAccessibilitySupportEnabled],
55-
you can expose accessibility switch to users in the application preferences.
56-
User's system assistive utilities have priority over this setting and will
57-
override it.
57+
### Using Electron's API
5858

59-
### Assistive Technology
59+
By using the [`app.setAccessibilitySupportEnabled(enabled)`][setAccessibilitySupportEnabled]
60+
API, you can manually expose Chrome's accessibility tree to users in the application preferences.
61+
Note that the user's system assistive utilities have priority over this setting and
62+
will override it.
6063

61-
Electron application will enable accessibility automatically when it detects
62-
assistive technology (Windows) or VoiceOver (macOS). See Chrome's
63-
[accessibility documentation][a11y-docs] for more details.
64+
### Within third-party software
6465

65-
On macOS, third-party assistive technology can switch accessibility inside
66-
Electron applications by setting the attribute `AXManualAccessibility`
66+
#### macOS
67+
68+
On macOS, third-party assistive technology can toggle accessibility features inside
69+
Electron applications by setting the `AXManualAccessibility` attribute
6770
programmatically:
6871

6972
```objc

0 commit comments

Comments
 (0)