Skip to content

Changed docs for hintOverrides field of SemanticsProperties #162632

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.

Sign up for GitHub

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

Jump to bottom
Merged
auto-submit merged 4 commits into from
Feb 7, 2025
Merged

Changed docs for hintOverrides field of SemanticsProperties #162632

auto-submit merged 4 commits into from
Feb 7, 2025

Conversation

@Paulik8
Copy link
Contributor

@Paulik8 Paulik8 commented Feb 3, 2025

Fix #129356

List which issues are fixed by this PR. You must list at least one issue. An issue is not required if the PR fixes something trivial like a typo.

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@github-actions github-actions bot added framework flutter/packages/flutter repository. See also f: labels. a: accessibility Accessibility, e.g. VoiceOver or TalkBack. (aka a11y) labels Feb 3, 2025
@goderbauer goderbauer requested a review from chunhtai February 4, 2025 23:04
chunhtai
chunhtai reviewed Feb 5, 2025
View reviewed changes
packages/flutter/lib/src/semantics/semantics.dart Outdated
///
/// On iOS, these are always ignored and the default [hint] is used instead.
/// This property does not affect how the platform processes hints; it only sets
/// the custom text that will be read by assistive technology.
Copy link
Contributor

@chunhtai chunhtai Feb 5, 2025

Choose a reason for hiding this comment

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

This doc is still a bit unclear. we should give some example on how this is used.

On Android, these overrides replace the hints used when focusing nodes with tap or long press actions. For example, if a [SemanticsHintOverrides.onTapHint] is provided, instead of saying `double tap to activate`, it will say `double tap to <onTapHint>`.

we should also mention this is ignored in other platform

Copy link
Contributor Author

@Paulik8 Paulik8 Feb 5, 2025

Choose a reason for hiding this comment

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

Thank you very much for your feedback, I have fixed it!

@Paulik8 Paulik8 requested a review from chunhtai February 5, 2025 23:16
chunhtai
chunhtai approved these changes Feb 5, 2025
View reviewed changes
Copy link
Contributor

@chunhtai chunhtai left a comment

Choose a reason for hiding this comment

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

LGTM

@chunhtai chunhtai requested a review from hannah-hyj February 5, 2025 23:24
hannah-hyj
hannah-hyj approved these changes Feb 5, 2025
View reviewed changes
Copy link
Member

@hannah-hyj hannah-hyj left a comment

Choose a reason for hiding this comment

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

LGTM

hannah-hyj
hannah-hyj reviewed Feb 5, 2025
View reviewed changes
packages/flutter/lib/src/semantics/semantics.dart
/// On iOS, this property is ignored, and default platform behavior applies.
///
/// Example usage:
/// ```dart
Copy link
Member

@hannah-hyj hannah-hyj Feb 5, 2025

Choose a reason for hiding this comment

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

the indent issues here is causing the test to fail

packages/flutter/lib/src/semantics/semantics.dart:1565: Dart section inexplicably did not contain "/// " prefix.

Copy link
Contributor Author

@Paulik8 Paulik8 Feb 6, 2025

Choose a reason for hiding this comment

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

Thank you, fixed it

@hannah-hyj hannah-hyj added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 6, 2025
@auto-submit
Copy link
Contributor

auto-submit bot commented Feb 6, 2025

autosubmit label was removed for flutter/flutter/162632, because - The status or check suite Linux analyze has failed. Please fix the issues identified (or deflake) before re-applying this label.

@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Feb 6, 2025
@chunhtai
Copy link
Contributor

chunhtai commented Feb 6, 2025

analyzer error

packages/flutter/lib/src/semantics/semantics.dart:1541:7: Use 'const' with the constructor to improve performance (expression) (prefer_const_constructors)
packages/flutter/lib/src/semantics/semantics.dart:1542:20: Use 'const' with the constructor to improve performance (expression) (prefer_const_constructors)
packages/flutter/lib/src/semantics/semantics.dart:1543:25: Use 'const' with the constructor to improve performance (expression) (prefer_const_constructors)
packages/flutter/lib/src/semantics/semantics.dart:1547:15: Use 'const' with the constructor to improve performance (expression) (prefer_const_constructors)

@chunhtai chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 6, 2025
@auto-submit auto-submit bot added this pull request to the merge queue Feb 6, 2025
Merged via the queue into flutter:master with commit a6344bf Feb 7, 2025
76 checks passed
@flutter-dashboard flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Feb 7, 2025
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 7, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 7, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
b5d4efa 
…lutter/flutter#162632)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 7, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 7, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
006588b 
…lutter/flutter#162632)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 7, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 7, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
37c5922 
…lutter/flutter#162632)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 8, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
68152e9 
…lutter/flutter#162632)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 8, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
d26ebd5 
…lutter/flutter#162632)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 9, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 9, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
1d7de2a 
…lutter/flutter#162632)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 9, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 9, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
42f9fd5 
…lutter/flutter#162632)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 10, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 10, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
247fc6f 
…lutter/flutter#162632)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 10, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 10, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
28b56f5 
…lutter/flutter#162632)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 10, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 10, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
dd095f4 
…lutter/flutter#162632)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 10, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 10, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
3502e82 
…lutter/flutter#162632)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 10, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 10, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
b1af5cc 
…lutter/flutter#162632)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
8de2f57 
…lutter/flutter#162632)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
9032ef7 
…lutter/flutter#162632)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
d5f7671 
…lutter/flutter#162632)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
c33bef2 
…lutter/flutter#162632)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 11, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
d736ee5 
…lutter/flutter#162632)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
151f77e 
…lutter/flutter#162632)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
3889895 
…lutter/flutter#162632)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025
@engine-flutter-autoroll
a6344bf Changed docs for hintOverrides field of SemanticsProperties (f…
9ca7e20 
…lutter/flutter#162632)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hannah-hyj hannah-hyj hannah-hyj approved these changes

@chunhtai chunhtai chunhtai approved these changes

Assignees

No one assigned

Labels

a: accessibility Accessibility, e.g. VoiceOver or TalkBack. (aka a11y) framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

SemanticsProperties.hintOverries documentation is outdated

3 participants

@Paulik8 @chunhtai @hannah-hyj