Browse Source

Document accessibility support API

Kevin Sawicki 8 years ago
parent
commit
46a1e0382d
1 changed files with 21 additions and 0 deletions
  1. 21 0
      docs/api/app.md

+ 21 - 0
docs/api/app.md

@@ -259,6 +259,19 @@ app.on('login', (event, webContents, request, authInfo, callback) => {
 
 Emitted when the gpu process crashes.
 
+### Event: 'accessibility-support-changed' _macOS_ _Windows_
+
+Returns:
+
+* `event` Event
+* `accessibilitySupportEnabled` Boolean - `true` when Chrome's accessibility
+  support is enabled, `false` otherwise.
+
+Emitted when Chrome's accessibility support changes. This event fires when
+assistive technologies, such as screen readers, are enabled or disabled.
+See https://www.chromium.org/developers/design-documents/accessibility for more
+details.
+
 ## Methods
 
 The `app` object has the following methods:
@@ -625,6 +638,14 @@ Return an Object with the login item settings of the app.
 
 Set the app's login item settings.
 
+### `app.isAccessibilitySupportEnabled()` _macOS_ _Windows_
+
+Returns a `Boolean`, `true` if Chrome's accessibility support is enabled,
+`false` otherwise. This API will return `true` if the use of assistive
+technologies, such as screen readers, has been detected. See
+https://www.chromium.org/developers/design-documents/accessibility for more
+details.
+
 ### `app.commandLine.appendSwitch(switch[, value])`
 
 Append a switch (with optional `value`) to Chromium's command line.