Skip to content

Commit a6344bf

Browse files
authored
Changed docs for hintOverrides field of SemanticsProperties (#162632)
Fix flutter/flutter#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
1 parent 1e035cc commit a6344bf

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

packages/flutter/lib/src/semantics/semantics.dart

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1524,14 +1524,29 @@ class SemanticsProperties extends DiagnosticableTree {
15241524
/// a level 3 is a subsection of that, and so on.
15251525
final int? headingLevel;
15261526

1527-
/// Provides hint values which override the default hints on supported
1528-
/// platforms.
1527+
/// Overrides the default accessibility hints provided by the platform.
1528+
///
1529+
/// This [hintOverrides] property does not affect how the platform processes hints;
1530+
/// it only sets the custom text that will be read by assistive technology.
1531+
///
1532+
/// On Android, these overrides replace the default hints for semantics nodes
1533+
/// with tap or long-press actions. For example, if [SemanticsHintOverrides.onTapHint]
1534+
/// is provided, instead of saying `Double tap to activate`, the screen reader
1535+
/// will say `Double tap to <onTapHint>`.
15291536
///
1530-
/// On Android, If no hint overrides are used then default [hint] will be
1531-
/// combined with the [label]. Otherwise, the [hint] will be ignored as long
1532-
/// as there as at least one non-null hint override.
1537+
/// On iOS, this property is ignored, and default platform behavior applies.
15331538
///
1534-
/// On iOS, these are always ignored and the default [hint] is used instead.
1539+
/// Example usage:
1540+
/// ```dart
1541+
/// const Semantics.fromProperties(
1542+
/// properties: SemanticsProperties(
1543+
/// hintOverrides: SemanticsHintOverrides(
1544+
/// onTapHint: 'open settings',
1545+
/// ),
1546+
/// ),
1547+
/// child: Text('button'),
1548+
/// )
1549+
/// ```
15351550
final SemanticsHintOverrides? hintOverrides;
15361551

15371552
/// The reading direction of the [label], [value], [increasedValue],

0 commit comments

Comments
 (0)