Skip to content

Add support for accessibilityDescription prop. #14585

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

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

satkh
Copy link

@satkh satkh commented Apr 20, 2025

Description

Add support for accessibilityDescription prop. This property should populate the UIA Help Text property. (UIA_FullDescriptionPropertyId)

Type of Change

  • New feature (non-breaking change which adds functionality)

Why

Resolves #14578

What

  1. Added support for "UIA_FullDescriptionPropertyId" in CompositionDynamicAutomationProvider
  2. Added changes to propagate "AccessibilityHint" from Upstream (JS) to native props.

Screenshots

Testing

Verified on Accessibility Insights for Windows
image

image

Changelog

Should this change be included in the release notes: yes

Add a brief summary of the change to use in the release notes for the next release.

Microsoft Reviewers: Open in CodeFlow

@satkh satkh requested a review from chiaramooney April 20, 2025 10:43
@@ -117,6 +117,22 @@ export default class Bootstrap extends React.Component<
<Text style={styles.text}>TEST setAccessibilityFocus</Text>
</TouchableHighlight>
<TextInput ref={this.myElement} />

<TouchableHighlight
Copy link
Contributor

Choose a reason for hiding this comment

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

We typically leave these sample pages as they are. If you want to add an example of the prop, add an example to a JS/TS file in the rntester app (i.e. the files that have the *Example syntax). I would add an example to AccessibilityExampleWindows.tsx

@chiaramooney
Copy link
Contributor

This is not the right implementation. What we want to do here is create a new prop called accessibilityDescription that should only be available on Windows. This prop should accept a string.

The value of this prop should be used to add data to the UIA property UIA_FullDescriptionPropertyId.

It looks like what you've done here is add the value of the accessibilityHint prop to the UIA property UIA_FullDescriptionPropertyId. We should not be using the accessibilityHint property at all here.

Also we shouldn't need to make any edits to AbiViewProps for this change. We don't need a default value. If the value is unspecified, we should simply pass the empty string to UIA_FullDescriptionPropertyId.

@TatianaKapos
Copy link
Contributor

@satkh PRs should be coming from our own forked repository instead of a branch off main! More instructions are on our contributing.md page in this repo

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.

Add support for accessibilityDescription prop
3 participants