fix: AXManualAccessibility showing failure (#38102)

fix: AXManualAccessibility showing failure
This commit is contained in:
Shelley Vohr 2023-04-26 19:41:56 +02:00 committed by GitHub
parent a0a44f07dd
commit f35b9b3f06
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 4 deletions

View file

@ -28,6 +28,8 @@ On macOS, third-party assistive technology can toggle accessibility features ins
Electron applications by setting the `AXManualAccessibility` attribute Electron applications by setting the `AXManualAccessibility` attribute
programmatically: programmatically:
Using Objective-C:
```objc ```objc
CFStringRef kAXManualAccessibility = CFSTR("AXManualAccessibility"); CFStringRef kAXManualAccessibility = CFSTR("AXManualAccessibility");
@ -43,5 +45,16 @@ CFStringRef kAXManualAccessibility = CFSTR("AXManualAccessibility");
} }
``` ```
Using Swift:
```swift
import Cocoa
let name = CommandLine.arguments.count >= 2 ? CommandLine.arguments[1] : "Electron"
let pid = NSWorkspace.shared.runningApplications.first(where: {$0.localizedName == name})!.processIdentifier
let axApp = AXUIElementCreateApplication(pid)
let result = AXUIElementSetAttributeValue(axApp, "AXManualAccessibility" as CFString, true as CFTypeRef)
print("Setting 'AXManualAccessibility' \(error.rawValue == 0 ? "succeeded" : "failed")")
```
[a11y-docs]: https://www.chromium.org/developers/design-documents/accessibility#TOC-How-Chrome-detects-the-presence-of-Assistive-Technology [a11y-docs]: https://www.chromium.org/developers/design-documents/accessibility#TOC-How-Chrome-detects-the-presence-of-Assistive-Technology
[setAccessibilitySupportEnabled]: ../api/app.md#appsetaccessibilitysupportenabledenabled-macos-windows [setAccessibilitySupportEnabled]: ../api/app.md#appsetaccessibilitysupportenabledenabled-macos-windows

View file

@ -175,11 +175,13 @@ inline void dispatch_sync_main(dispatch_block_t block) {
electron::Browser::Get()->OpenURL(base::SysNSStringToUTF8(url)); electron::Browser::Get()->OpenURL(base::SysNSStringToUTF8(url));
} }
// AXEnhancedUserInterface is an undocumented attribute that screen reader
// related functionality sets when running, and AXManualAccessibility is an
// attribute Electron specifically allows third-party apps to use to enable
// a11y features in Electron.
- (void)accessibilitySetValue:(id)value forAttribute:(NSString*)attribute { - (void)accessibilitySetValue:(id)value forAttribute:(NSString*)attribute {
// Undocumented attribute that screen reader related functionality bool is_manual_ax = [attribute isEqualToString:@"AXManualAccessibility"];
// sets when running. if ([attribute isEqualToString:@"AXEnhancedUserInterface"] || is_manual_ax) {
if ([attribute isEqualToString:@"AXEnhancedUserInterface"] ||
[attribute isEqualToString:@"AXManualAccessibility"]) {
auto* ax_state = content::BrowserAccessibilityState::GetInstance(); auto* ax_state = content::BrowserAccessibilityState::GetInstance();
if ([value boolValue]) { if ([value boolValue]) {
ax_state->OnScreenReaderDetected(); ax_state->OnScreenReaderDetected();
@ -188,6 +190,12 @@ inline void dispatch_sync_main(dispatch_block_t block) {
} }
electron::Browser::Get()->OnAccessibilitySupportChanged(); electron::Browser::Get()->OnAccessibilitySupportChanged();
// Don't call the superclass function for AXManualAccessibility,
// as it will log an AXError and make it appear as though the attribute
// failed to take effect.
if (is_manual_ax)
return;
} }
return [super accessibilitySetValue:value forAttribute:attribute]; return [super accessibilitySetValue:value forAttribute:attribute];