Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Compose iOS accessibility support #75

Merged
merged 13 commits into from
Feb 28, 2024
Merged

Conversation

zamulla
Copy link
Collaborator

@zamulla zamulla commented Feb 16, 2024

@zamulla zamulla marked this pull request as ready for review February 22, 2024 07:49
Copy link
Collaborator

@danil-pavlov danil-pavlov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of ideas regarding the structure:

  1. Consistent headers, noun-phrases "Accessibility tree synchronization/ Accessibility APIs" or verbs "Customize accessibility tree synchronization/ Adjust accessibility behavior with APIs"
  2. Instead of the Accessibility APIs reference section, make two use cases: Customize accessibility tree synchronization (includes AccessibilitySyncOptions description) and Set up logging (includes AccessibilityDebugLogger description)

topics/compose/compose-ios-accessibility.md Outdated Show resolved Hide resolved
topics/compose/compose-ios-accessibility.md Outdated Show resolved Hide resolved
topics/compose/compose-ios-accessibility.md Outdated Show resolved Hide resolved
to native accessibility properties such as `accessibilityIdentifier`. This makes semantic data from Compose Multiplatform available
to Accessibility Services and XCTest framework.

Notable limitations of the current accessibility support:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think here you can move the repetitive part to the list's intro:

The Compose accessibility API doesn't currently cover(support):

  • Live regions, announcements about..
  • UIKit elements inside Compose Multiplatform UI.

topics/compose/compose-ios-accessibility.md Outdated Show resolved Hide resolved
By default, the iOS accessibility tree is synchronized with the UI only when Accessibility Services are running;
by default, no accessibility logs are written.
You can customize this behavior, for example, when you want to debug events and interactions:
activate the option to always synchronize the accessibility tree, so that the tree is rewritten every time the UI updates.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence is quite long, maybe split it after the colon?

You can customize this behavior, for example, when you want to debug events and interactions:
activate the option to always synchronize the accessibility tree, so that the tree is rewritten every time the UI updates.

> Always synchronizing the tree can be quite useful for debugging and testing, but be aware that there is a significant
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A part of the second sentence repeats the section's intro, I think we can safely shorten this tip to:

Constant synchronizing (or Constant synchronization of) the tree can be quite useful for debugging and testing but can degrade your app's performance.

Also, it look likes rather important, maybe turn it into a note?

topics/compose/compose-ios-accessibility.md Outdated Show resolved Hide resolved
topics/compose/compose-ios-accessibility.md Outdated Show resolved Hide resolved
topics/compose/compose-ios-accessibility.md Outdated Show resolved Hide resolved
mpd.tree Outdated Show resolved Hide resolved
topics/compose/compose-ios-accessibility.md Outdated Show resolved Hide resolved
topics/compose/compose-ios-accessibility.md Outdated Show resolved Hide resolved
topics/compose/compose-ios-accessibility.md Outdated Show resolved Hide resolved
Co-authored-by: Danil Pavlov <[email protected]>
@zamulla zamulla merged commit e7f21fa into master Feb 28, 2024
@zamulla zamulla deleted the compose-ios-accessibility branch February 28, 2024 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants