Changed docs for hintOverrides field of SemanticsProperties (#162632)

Fix https://github.com/flutter/flutter/issues/129356

<!--
Thanks for filing a pull request!
Reviewers are typically assigned within a week of filing a request.
To learn more about code review, see our documentation on Tree Hygiene:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
-->

*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

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [ ] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [ ] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.

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

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
This commit is contained in:
Paulik8 2025-02-07 00:24:57 +01:00 committed by GitHub
parent 1e035cc693
commit a6344bf2b3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1524,14 +1524,29 @@ class SemanticsProperties extends DiagnosticableTree {
/// a level 3 is a subsection of that, and so on.
final int? headingLevel;
/// Provides hint values which override the default hints on supported
/// platforms.
/// Overrides the default accessibility hints provided by the platform.
///
/// On Android, If no hint overrides are used then default [hint] will be
/// combined with the [label]. Otherwise, the [hint] will be ignored as long
/// as there as at least one non-null hint override.
/// This [hintOverrides] property does not affect how the platform processes hints;
/// it only sets the custom text that will be read by assistive technology.
///
/// On iOS, these are always ignored and the default [hint] is used instead.
/// On Android, these overrides replace the default hints for semantics nodes
/// with tap or long-press actions. For example, if [SemanticsHintOverrides.onTapHint]
/// is provided, instead of saying `Double tap to activate`, the screen reader
/// will say `Double tap to <onTapHint>`.
///
/// On iOS, this property is ignored, and default platform behavior applies.
///
/// Example usage:
/// ```dart
/// const Semantics.fromProperties(
/// properties: SemanticsProperties(
/// hintOverrides: SemanticsHintOverrides(
/// onTapHint: 'open settings',
/// ),
/// ),
/// child: Text('button'),
/// )
/// ```
final SemanticsHintOverrides? hintOverrides;
/// The reading direction of the [label], [value], [increasedValue],