Skip to content

F
Front-End
Unverified Commit b01cb301 authored by chunhtai's avatar chunhtai Committed by GitHub
Browse files
Options

Adds more documentations around ignoreSemantics deprecations. (#131287) 

migration guide update https://github.com/flutter/website/pull/9124

fixes the concerns in https://github.com/flutter/flutter/pull/120619
parent 55fe41be
Show whitespace changes
Inline Side-by-side
Showing with 88 additions and 33 deletions
packages/flutter/lib/src/rendering/proxy_box.dart
View file @ b01cb301
...@@ -3547,7 +3547,14 @@ class RenderRepaintBoundary extends RenderProxyBox { ...@@ -3547,7 +3547,14 @@ class RenderRepaintBoundary extends RenderProxyBox {
/// as usual. It just cannot be the target of located events, because its render /// as usual. It just cannot be the target of located events, because its render
/// object returns false from [hitTest]. /// object returns false from [hitTest].
/// ///
/// {@macro flutter.widgets.IgnorePointer.Semantics} /// ## Semantics
///
/// Using this class may also affect how the semantics subtree underneath is
/// collected.
///
/// {@macro flutter.widgets.IgnorePointer.semantics}
///
/// {@macro flutter.widgets.IgnorePointer.ignoringSemantics}
/// ///
/// See also: /// See also:
/// ///
...@@ -3574,7 +3581,7 @@ class RenderIgnorePointer extends RenderProxyBox { ...@@ -3574,7 +3581,7 @@ class RenderIgnorePointer extends RenderProxyBox {
/// Regardless of whether this render object is ignored during hit testing, it /// Regardless of whether this render object is ignored during hit testing, it
/// will still consume space during layout and be visible during painting. /// will still consume space during layout and be visible during painting.
/// ///
/// {@macro flutter.widgets.IgnorePointer.Semantics} /// {@macro flutter.widgets.IgnorePointer.semantics}
bool get ignoring => _ignoring; bool get ignoring => _ignoring;
bool _ignoring; bool _ignoring;
set ignoring(bool value) { set ignoring(bool value) {
...@@ -3589,7 +3596,7 @@ class RenderIgnorePointer extends RenderProxyBox { ...@@ -3589,7 +3596,7 @@ class RenderIgnorePointer extends RenderProxyBox {
/// Whether the semantics of this render object is ignored when compiling the semantics tree. /// Whether the semantics of this render object is ignored when compiling the semantics tree.
/// ///
/// {@macro flutter.widgets.IgnorePointer.Semantics} /// {@macro flutter.widgets.IgnorePointer.ignoringSemantics}
/// ///
/// See [SemanticsNode] for additional information about the semantics tree. /// See [SemanticsNode] for additional information about the semantics tree.
@Deprecated( @Deprecated(
...@@ -3790,7 +3797,14 @@ class RenderOffstage extends RenderProxyBox { ...@@ -3790,7 +3797,14 @@ class RenderOffstage extends RenderProxyBox {
/// its children from being the target of located events, because its render /// its children from being the target of located events, because its render
/// object returns true from [hitTest]. /// object returns true from [hitTest].
/// ///
/// {@macro flutter.widgets.AbsorbPointer.Semantics} /// ## Semantics
///
/// Using this class may also affect how the semantics subtree underneath is
/// collected.
///
/// {@macro flutter.widgets.AbsorbPointer.semantics}
///
/// {@macro flutter.widgets.AbsorbPointer.ignoringSemantics}
/// ///
/// See also: /// See also:
/// ///
...@@ -3818,7 +3832,7 @@ class RenderAbsorbPointer extends RenderProxyBox { ...@@ -3818,7 +3832,7 @@ class RenderAbsorbPointer extends RenderProxyBox {
/// testing, it will still consume space during layout and be visible during /// testing, it will still consume space during layout and be visible during
/// painting. /// painting.
/// ///
/// {@macro flutter.widgets.AbsorbPointer.Semantics} /// {@macro flutter.widgets.AbsorbPointer.semantics}
bool get absorbing => _absorbing; bool get absorbing => _absorbing;
bool _absorbing; bool _absorbing;
set absorbing(bool value) { set absorbing(bool value) {
...@@ -3834,7 +3848,7 @@ class RenderAbsorbPointer extends RenderProxyBox { ...@@ -3834,7 +3848,7 @@ class RenderAbsorbPointer extends RenderProxyBox {
/// Whether the semantics of this render object is ignored when compiling the /// Whether the semantics of this render object is ignored when compiling the
/// semantics tree. /// semantics tree.
/// ///
/// {@macro flutter.widgets.AbsorbPointer.Semantics} /// {@macro flutter.widgets.AbsorbPointer.ignoringSemantics}
/// ///
/// See [SemanticsNode] for additional information about the semantics tree. /// See [SemanticsNode] for additional information about the semantics tree.
@Deprecated( @Deprecated(
......
packages/flutter/lib/src/rendering/proxy_sliver.dart
View file @ b01cb301
...@@ -205,7 +205,14 @@ class RenderSliverOpacity extends RenderProxySliver { ...@@ -205,7 +205,14 @@ class RenderSliverOpacity extends RenderProxySliver {
/// child as usual. It just cannot be the target of located events, because its /// child as usual. It just cannot be the target of located events, because its
/// render object returns false from [hitTest]. /// render object returns false from [hitTest].
/// ///
/// {@macro flutter.widgets.IgnorePointer.Semantics} /// ## Semantics
///
/// Using this class may also affect how the semantics subtree underneath is
/// collected.
///
/// {@macro flutter.widgets.IgnorePointer.semantics}
///
/// {@macro flutter.widgets.IgnorePointer.ignoringSemantics}
class RenderSliverIgnorePointer extends RenderProxySliver { class RenderSliverIgnorePointer extends RenderProxySliver {
/// Creates a render object that is invisible to hit testing. /// Creates a render object that is invisible to hit testing.
/// ///
...@@ -228,7 +235,7 @@ class RenderSliverIgnorePointer extends RenderProxySliver { ...@@ -228,7 +235,7 @@ class RenderSliverIgnorePointer extends RenderProxySliver {
/// Regardless of whether this render object is ignored during hit testing, it /// Regardless of whether this render object is ignored during hit testing, it
/// will still consume space during layout and be visible during painting. /// will still consume space during layout and be visible during painting.
/// ///
/// {@macro flutter.widgets.IgnorePointer.Semantics} /// {@macro flutter.widgets.IgnorePointer.semantics}
bool get ignoring => _ignoring; bool get ignoring => _ignoring;
bool _ignoring; bool _ignoring;
set ignoring(bool value) { set ignoring(bool value) {
...@@ -244,7 +251,7 @@ class RenderSliverIgnorePointer extends RenderProxySliver { ...@@ -244,7 +251,7 @@ class RenderSliverIgnorePointer extends RenderProxySliver {
/// Whether the semantics of this render object is ignored when compiling the /// Whether the semantics of this render object is ignored when compiling the
/// semantics tree. /// semantics tree.
/// ///
/// {@macro flutter.widgets.IgnorePointer.Semantics} /// {@macro flutter.widgets.IgnorePointer.ignoringSemantics}
@Deprecated( @Deprecated(
'Create a custom sliver ignore pointer widget instead. ' 'Create a custom sliver ignore pointer widget instead. '
'This feature was deprecated after v3.8.0-12.0.pre.' 'This feature was deprecated after v3.8.0-12.0.pre.'
......
packages/flutter/lib/src/widgets/basic.dart
View file @ b01cb301
...@@ -6839,20 +6839,33 @@ class RepaintBoundary extends SingleChildRenderObjectWidget { ...@@ -6839,20 +6839,33 @@ class RepaintBoundary extends SingleChildRenderObjectWidget {
/// ///
/// ## Semantics /// ## Semantics
/// ///
/// Using this widget may also affect how the semantics subtree underneath this /// Using this class may also affect how the semantics subtree underneath is
/// widget is collected. /// collected.
///
/// {@template flutter.widgets.IgnorePointer.semantics}
/// If [ignoring] is true, pointer-related [SemanticsAction]s are removed from
/// the semantics subtree. Otherwise, the subtree remains untouched.
/// {@endtemplate}
///
/// {@template flutter.widgets.IgnorePointer.ignoringSemantics}
/// The usages of [ignoringSemantics] are deprecated and not recommended. This
/// property was introduced to workaround the semantics behavior of the
/// [IgnorePointer] and its friends before v3.8.0-12.0.pre.
///
/// Before that version, entire semantics subtree is dropped if [ignoring] is
/// true. Developers can only use [ignoringSemantics] to preserver the semantics
/// subtrees.
///
/// After that version, with [ignoring] set to true, it only prevents semantics
/// user actions in the semantics subtree but leaves the other
/// [SemanticsProperties] intact. Therefore, the [ignoringSemantics] is no
/// longer needed.
/// ///
/// {@template flutter.widgets.IgnorePointer.Semantics}
/// If [ignoringSemantics] is true, the semantics subtree is dropped. Therefore, /// If [ignoringSemantics] is true, the semantics subtree is dropped. Therefore,
/// the subtree will be invisible to assistive technologies. /// the subtree will be invisible to assistive technologies.
/// ///
/// If [ignoringSemantics] is false, the semantics subtree is collected as /// If [ignoringSemantics] is false, the semantics subtree is collected as
/// usual. /// usual.
///
/// If [ignoringSemantics] is not set, then [ignoring] decides how the
/// semantics subtree is collected. If [ignoring] is true, pointer-related
/// [SemanticsAction]s are removed from the semantics subtree. Otherwise, the
/// subtree remains untouched.
/// {@endtemplate} /// {@endtemplate}
/// ///
/// See also: /// See also:
...@@ -6880,7 +6893,7 @@ class IgnorePointer extends SingleChildRenderObjectWidget { ...@@ -6880,7 +6893,7 @@ class IgnorePointer extends SingleChildRenderObjectWidget {
/// Regardless of whether this widget is ignored during hit testing, it will /// Regardless of whether this widget is ignored during hit testing, it will
/// still consume space during layout and be visible during painting. /// still consume space during layout and be visible during painting.
/// ///
/// {@macro flutter.widgets.IgnorePointer.Semantics} /// {@macro flutter.widgets.IgnorePointer.semantics}
/// ///
/// Defaults to true. /// Defaults to true.
final bool ignoring; final bool ignoring;
...@@ -6888,7 +6901,7 @@ class IgnorePointer extends SingleChildRenderObjectWidget { ...@@ -6888,7 +6901,7 @@ class IgnorePointer extends SingleChildRenderObjectWidget {
/// Whether the semantics of this widget is ignored when compiling the /// Whether the semantics of this widget is ignored when compiling the
/// semantics subtree. /// semantics subtree.
/// ///
/// {@macro flutter.widgets.IgnorePointer.Semantics} /// {@macro flutter.widgets.IgnorePointer.ignoringSemantics}
/// ///
/// See [SemanticsNode] for additional information about the semantics tree. /// See [SemanticsNode] for additional information about the semantics tree.
@Deprecated( @Deprecated(
...@@ -6943,19 +6956,33 @@ class IgnorePointer extends SingleChildRenderObjectWidget { ...@@ -6943,19 +6956,33 @@ class IgnorePointer extends SingleChildRenderObjectWidget {
/// ///
/// ## Semantics /// ## Semantics
/// ///
/// Using this widget may also affect how the semantics subtree underneath this /// Using this class may also affect how the semantics subtree underneath is
/// widget is collected. /// collected.
///
/// {@template flutter.widgets.AbsorbPointer.semantics}
/// If [absorbing] is true, pointer-related [SemanticsAction]s are removed from
/// the semantics subtree. Otherwise, the subtree remains untouched.
/// {@endtemplate}
///
/// {@template flutter.widgets.AbsorbPointer.ignoringSemantics}
/// The usages of [ignoringSemantics] are deprecated and not recommended. This
/// property was introduced to workaround the semantics behavior of the
/// [IgnorePointer] and its friends before v3.8.0-12.0.pre.
/// ///
/// {@template flutter.widgets.AbsorbPointer.Semantics} /// Before that version, entire semantics subtree is dropped if [absorbing] is
/// If [ignoringSemantics] is true, the semantics subtree is dropped. /// true. Developers can only use [ignoringSemantics] to preserver the semantics
/// subtrees.
///
/// After that version, with [absorbing] set to true, it only prevents semantics
/// user actions in the semantics subtree but leaves the other
/// [SemanticsProperties] intact. Therefore, the [ignoringSemantics] is no
/// longer needed.
///
/// If [ignoringSemantics] is true, the semantics subtree is dropped. Therefore,
/// the subtree will be invisible to assistive technologies.
/// ///
/// If [ignoringSemantics] is false, the semantics subtree is collected as /// If [ignoringSemantics] is false, the semantics subtree is collected as
/// usual. /// usual.
///
/// If [ignoringSemantics] is not set, then [absorbing] decides how the
/// semantics subtree is collected. If [absorbing] is true, pointer-related
/// [SemanticsAction]s are removed from the semantics subtree. Otherwise, the
/// subtree remains untouched.
/// {@endtemplate} /// {@endtemplate}
/// ///
/// See also: /// See also:
...@@ -6983,7 +7010,7 @@ class AbsorbPointer extends SingleChildRenderObjectWidget { ...@@ -6983,7 +7010,7 @@ class AbsorbPointer extends SingleChildRenderObjectWidget {
/// testing, it will still consume space during layout and be visible during /// testing, it will still consume space during layout and be visible during
/// painting. /// painting.
/// ///
/// {@macro flutter.widgets.AbsorbPointer.Semantics} /// {@macro flutter.widgets.AbsorbPointer.semantics}
/// ///
/// Defaults to true. /// Defaults to true.
final bool absorbing; final bool absorbing;
...@@ -6991,7 +7018,7 @@ class AbsorbPointer extends SingleChildRenderObjectWidget { ...@@ -6991,7 +7018,7 @@ class AbsorbPointer extends SingleChildRenderObjectWidget {
/// Whether the semantics of this render object is ignored when compiling the /// Whether the semantics of this render object is ignored when compiling the
/// semantics tree. /// semantics tree.
/// ///
/// {@macro flutter.widgets.AbsorbPointer.Semantics} /// {@macro flutter.widgets.AbsorbPointer.ignoringSemantics}
/// ///
/// See [SemanticsNode] for additional information about the semantics tree. /// See [SemanticsNode] for additional information about the semantics tree.
@Deprecated( @Deprecated(
......
packages/flutter/lib/src/widgets/sliver.dart
View file @ b01cb301
...@@ -1178,7 +1178,14 @@ class SliverOpacity extends SingleChildRenderObjectWidget { ...@@ -1178,7 +1178,14 @@ class SliverOpacity extends SingleChildRenderObjectWidget {
/// child as usual. It just cannot be the target of located events, because it /// child as usual. It just cannot be the target of located events, because it
/// returns false from [RenderSliver.hitTest]. /// returns false from [RenderSliver.hitTest].
/// ///
/// {@macro flutter.widgets.IgnorePointer.Semantics} /// ## Semantics
///
/// Using this class may also affect how the semantics subtree underneath is
/// collected.
///
/// {@macro flutter.widgets.IgnorePointer.semantics}
///
/// {@macro flutter.widgets.IgnorePointer.ignoringSemantics}
/// ///
/// See also: /// See also:
/// ///
...@@ -1203,13 +1210,13 @@ class SliverIgnorePointer extends SingleChildRenderObjectWidget { ...@@ -1203,13 +1210,13 @@ class SliverIgnorePointer extends SingleChildRenderObjectWidget {
/// Regardless of whether this sliver is ignored during hit testing, it will /// Regardless of whether this sliver is ignored during hit testing, it will
/// still consume space during layout and be visible during painting. /// still consume space during layout and be visible during painting.
/// ///
/// {@macro flutter.widgets.IgnorePointer.Semantics} /// {@macro flutter.widgets.IgnorePointer.semantics}
final bool ignoring; final bool ignoring;
/// Whether the semantics of this sliver is ignored when compiling the /// Whether the semantics of this sliver is ignored when compiling the
/// semantics tree. /// semantics tree.
/// ///
/// {@macro flutter.widgets.IgnorePointer.Semantics} /// {@macro flutter.widgets.IgnorePointer.ignoringSemantics}
@Deprecated( @Deprecated(
'Create a custom sliver ignore pointer widget instead. ' 'Create a custom sliver ignore pointer widget instead. '
'This feature was deprecated after v3.8.0-12.0.pre.' 'This feature was deprecated after v3.8.0-12.0.pre.'
......
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

HIAST - GitLab