iOS: expose AutomationId to the accessibility tree for UI automation#21836
iOS: expose AutomationId to the accessibility tree for UI automation#21836maxbrousseau wants to merge 1 commit into
Conversation
Bridges Avalonia's AutomationPeer tree into the UIKit accessibility container API so UI-automation tools (XCUITest / Appium) can locate and drive Avalonia controls on iOS, matching desktop UIA behaviour. (The Android equivalent, ViewIdResourceName = AutomationId, is already present in main.) Adds AvaloniaView.Accessibility.cs: each content peer is exposed as a UIAccessibilityElement with accessibilityIdentifier = AutomationId, plus name / value / basic traits and Invoke/Toggle activation. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
You can test this PR using the following package version. |
|
Please read the following Contributor License Agreement (CLA). If you agree with the CLA, please reply with the following: Contributor License AgreementContribution License AgreementThis Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), 1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, “Project” means any of the projects owned or managed by AvaloniaUI OÜ and offered under a license “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any “Submission” means the Code and any other copyrightable material Submitted by You, including any 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any 3. Originality of Work. You represent that each of Your Submissions is entirely Your 4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else 5. Licenses. a. Copyright License. You grant AvaloniaUI OÜ, and those who receive the Submission directly b. Patent License. You grant AvaloniaUI OÜ, and those who receive the Submission directly or c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. 6. Representations and Warranties. You represent that You are legally entitled to grant the above 7. Notice to AvaloniaUI OÜ. You agree to notify AvaloniaUI OÜ in writing of any facts or 8. Information about Submissions. You agree that contributions to Projects and information about 9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the Republic of Estonia, and 10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and AvaloniaUI OÜ dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1. |
|
@maxbrousseau I think I'd prefer to get #18016 finished and merged as a complete solution? Have you tried that PR? |
What this does
Makes a control's
AutomationProperties.AutomationIdvisible to the iOS accessibility tree, so UI-automation tools (XCUITest / Appium) can locate and drive Avalonia controls by a stable id instead of by localized visible text — matching how UIA already works on desktop.Adds
AvaloniaView.Accessibility.cs, which bridges Avalonia'sAutomationPeertree into the UIKit accessibility container API on theAvaloniaView. Each content peer is exposed as aUIAccessibilityElementwith:accessibilityIdentifier = AutomationIdaccessibilityLabel= peer name,accessibilityValue= value (viaIValueProvider)Why
Today on iOS there's no reliable, language-independent way for automated UI tests to find Avalonia controls — you're limited to matching visible text, which breaks across localization and for icon-only controls. Exposing
AutomationIdfixes that and brings iOS in line with Android/desktop.How I tested
Manually, with Appium's XCUITest driver against a real iOS device:
AutomationIdare found via accessibility id.not tapped->tapped 1).no such elementand don't appear in the accessibility tree — confirming the ids come specifically from this change.main.Honest caveats — I'd appreciate your review
I'm not an Avalonia internals expert; I'm sharing what got iOS AutomationId working for us, in the hope it helps land the real feature. Areas I'm unsure about and would like eyes on:
ChildrenChanged; may need throttling / incremental updates for large or dynamic trees.PropertyChanged/ChildrenChangedhandlers on peers are not unsubscribed; please check for leaks.UIViewpoint space.Happy to iterate, split this up, or hand it off — whatever's most useful. Opening as a draft to start the conversation.