From 93a8e7523816a2fc9132b4ce18f330f21021973b Mon Sep 17 00:00:00 2001 From: Ivan Mir Date: Mon, 28 Aug 2017 20:33:16 -0300 Subject: [PATCH] Add clarifications to the documentation --- docs/api/app.md | 4 ++-- docs/tutorial/accessibility.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index 0dd898c6b9..83aa234aa8 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -892,10 +892,10 @@ details. ### `app.setAccessibilitySupportEnabled(enabled)` _macOS_ _Windows_ -* `enabled` Boolean - Enable or disable accessibility tree rendering +* `enabled` Boolean - Enable or disable [accessibility tree](https://developers.google.com/web/fundamentals/accessibility/semantics-builtin/the-accessibility-tree) rendering Manually enables Chrome's accessibility support, allowing to expose accessibility switch to users in application settings. https://www.chromium.org/developers/design-documents/accessibility for more -details. +details. Disabled by default. **Note:** Rendering accessibility tree can significantly affect the performance of your app. It should not be enabled by default. diff --git a/docs/tutorial/accessibility.md b/docs/tutorial/accessibility.md index 194fdfd117..d2b6099bba 100644 --- a/docs/tutorial/accessibility.md +++ b/docs/tutorial/accessibility.md @@ -38,13 +38,13 @@ Electron applications keep accessibility disabled by default for performance rea ### Inside Application -By using [`app.setAccessibilitySupportEnabled(enabled)`](https://electron.atom.io/docs/api/app.md#appsetaccessibilitysupportenabledenabled-macos-windows), you can expose accessibility switch to users in the application preferences. +By using [`app.setAccessibilitySupportEnabled(enabled)`](https://electron.atom.io/docs/api/app.md#appsetaccessibilitysupportenabledenabled-macos-windows), 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 Electron application will enable accessibility automatically when it detects assistive technology (Windows) or VoiceOver (macOS). See Chrome's [accessibility documentation](https://www.chromium.org/developers/design-documents/accessibility#TOC-How-Chrome-detects-the-presence-of-Assistive-Technology) for more details. -On macOS 3rd party assistive technology can switch accessibility inside Electron applications by setting the attribute `AXManualAccessibility` programmatically: +On macOS, thrid-party assistive technology can switch accessibility inside Electron applications by setting the attribute `AXManualAccessibility` programmatically: ```objc CFStringRef kAXManualAccessibility = CFSTR("AXManualAccessibility");