Unverified Commit f2646b15 authored by Jonathan Joelson's avatar Jonathan Joelson Committed by GitHub

Update semantics live region documentation (#99987)

parent 11deb156
...@@ -92,3 +92,4 @@ TheOneWithTheBraid <the-one@with-the-braid.cf> ...@@ -92,3 +92,4 @@ TheOneWithTheBraid <the-one@with-the-braid.cf>
Alberto Miola <betoman96@gmail.com> Alberto Miola <betoman96@gmail.com>
Twin Sun, LLC <google-contrib@twinsunsolutions.com> Twin Sun, LLC <google-contrib@twinsunsolutions.com>
Taskulu LDA <contributions@taskulu.com> Taskulu LDA <contributions@taskulu.com>
Jonathan Joelson <jon@joelson.co>
...@@ -990,18 +990,16 @@ class SemanticsProperties extends DiagnosticableTree { ...@@ -990,18 +990,16 @@ class SemanticsProperties extends DiagnosticableTree {
/// If non-null, whether the node should be considered a live region. /// If non-null, whether the node should be considered a live region.
/// ///
/// On Android, when the label changes on a live region semantics node, /// A live region indicates that updates to semantics node are important.
/// TalkBack will make a polite announcement of the current label. This /// Platforms may use this information to make polite announcements to the
/// announcement occurs even if the node is not focused, but only if the label /// user to inform them of updates to this node.
/// has changed since the last update.
/// ///
/// On iOS, no announcements are made but the node is marked as /// An example of a live region is a [SnackBar] widget. On Android and iOS,
/// `UIAccessibilityTraitUpdatesFrequently`. /// live region causes a polite announcement to be generated automatically,
/// /// even if the widget does not have accessibility focus. This announcement
/// An example of a live region is the [SnackBar] widget. When it appears /// may not be spoken if the OS accessibility services are already
/// on the screen it may be difficult to focus to read the label. A live /// announcing something else, such as reading the label of a focused widget
/// region causes an initial polite announcement to be generated /// or providing a system announcement.
/// automatically.
/// ///
/// See also: /// See also:
/// ///
...@@ -4039,15 +4037,16 @@ class SemanticsConfiguration { ...@@ -4039,15 +4037,16 @@ class SemanticsConfiguration {
/// Whether the semantics node is a live region. /// Whether the semantics node is a live region.
/// ///
/// On Android, when the label changes on a live region semantics node, /// A live region indicates that updates to semantics node are important.
/// TalkBack will make a polite announcement of the current label. This /// Platforms may use this information to make polite announcements to the
/// announcement occurs even if the node is not focused, but only if the label /// user to inform them of updates to this node.
/// has changed since the last update.
/// ///
/// An example of a live region is the [SnackBar] widget. When it appears /// An example of a live region is a [SnackBar] widget. On Android and iOS,
/// on the screen it may be difficult to focus to read the label. A live /// live region causes a polite announcement to be generated automatically,
/// region causes an initial polite announcement to be generated /// even if the widget does not have accessibility focus. This announcement
/// automatically. /// may not be spoken if the OS accessibility services are already
/// announcing something else, such as reading the label of a focused widget
/// or providing a system announcement.
/// ///
/// See also: /// See also:
/// ///
......
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