Unverified Commit cc6f86e6 authored by chunhtai's avatar chunhtai Committed by GitHub

Clarifies semantics long press and semantics on tap documentation (#128599)

fixes https://github.com/flutter/flutter/issues/35112
parent a35ae601
...@@ -1367,8 +1367,13 @@ class SemanticsProperties extends DiagnosticableTree { ...@@ -1367,8 +1367,13 @@ class SemanticsProperties extends DiagnosticableTree {
/// the finger without moving it. For example, a button should implement this /// the finger without moving it. For example, a button should implement this
/// action. /// action.
/// ///
/// VoiceOver users on iOS and TalkBack users on Android can trigger this /// VoiceOver users on iOS and TalkBack users on Android *may* trigger this
/// action by double-tapping the screen while an element is focused. /// action by double-tapping the screen while an element is focused.
///
/// Note: different OSes or assistive technologies may decide to interpret
/// user inputs differently. Some may simulate real screen taps, while others
/// may call semantics tap. One way to handle taps properly is to provide the
/// same handler to both gesture tap and semantics tap.
final VoidCallback? onTap; final VoidCallback? onTap;
/// The handler for [SemanticsAction.longPress]. /// The handler for [SemanticsAction.longPress].
...@@ -1376,9 +1381,15 @@ class SemanticsProperties extends DiagnosticableTree { ...@@ -1376,9 +1381,15 @@ class SemanticsProperties extends DiagnosticableTree {
/// This is the semantic equivalent of a user pressing and holding the screen /// This is the semantic equivalent of a user pressing and holding the screen
/// with the finger for a few seconds without moving it. /// with the finger for a few seconds without moving it.
/// ///
/// VoiceOver users on iOS and TalkBack users on Android can trigger this /// VoiceOver users on iOS and TalkBack users on Android *may* trigger this
/// action by double-tapping the screen without lifting the finger after the /// action by double-tapping the screen without lifting the finger after the
/// second tap. /// second tap.
///
/// Note: different OSes or assistive technologies may decide to interpret
/// user inputs differently. Some may simulate real long presses, while others
/// may call semantics long press. One way to handle long press properly is to
/// provide the same handler to both gesture long press and semantics long
/// press.
final VoidCallback? onLongPress; final VoidCallback? onLongPress;
/// The handler for [SemanticsAction.scrollLeft]. /// The handler for [SemanticsAction.scrollLeft].
......
...@@ -6983,6 +6983,8 @@ class MetaData extends SingleChildRenderObjectWidget { ...@@ -6983,6 +6983,8 @@ class MetaData extends SingleChildRenderObjectWidget {
/// ///
/// See also: /// See also:
/// ///
/// * [SemanticsProperties], which contains a complete documentation for each
/// of the constructor parameters that belongs to semantics properties.
/// * [MergeSemantics], which marks a subtree as being a single node for /// * [MergeSemantics], which marks a subtree as being a single node for
/// accessibility purposes. /// accessibility purposes.
/// * [ExcludeSemantics], which excludes a subtree from the semantics tree /// * [ExcludeSemantics], which excludes a subtree from the semantics tree
...@@ -7004,6 +7006,8 @@ class Semantics extends SingleChildRenderObjectWidget { ...@@ -7004,6 +7006,8 @@ class Semantics extends SingleChildRenderObjectWidget {
/// ///
/// See also: /// See also:
/// ///
/// * [SemanticsProperties], which contains a complete documentation for each
/// of the constructor parameters that belongs to semantics properties.
/// * [SemanticsSortKey] for a class that determines accessibility traversal /// * [SemanticsSortKey] for a class that determines accessibility traversal
/// order. /// order.
Semantics({ Semantics({
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment