Google is committed to advancing racial equity for Black communities. See how.

androidx.compose.ui.semantics

Interfaces

SemanticsModifier

A Modifier.Element that adds semantics key/value for use in testing, accessibility, and similar use cases.

SemanticsPropertyReceiver

Classes

AccessibilityAction

Data class for standard accessibility action.

AccessibilityRangeInfo

Data class for accessibility range information.

AccessibilityScrollState

The scroll state of this node if this node is scrollable.

CustomAccessibilityAction

Data class for custom accessibility action.

SemanticsConfiguration

Describes the semantic information associated with the owning component

SemanticsNode

A list of key/value pairs associated with a layout node or its subtree.

SemanticsOwner

Owns SemanticsNode objects and notifies listeners of changes to the semantics tree

SemanticsPropertyKey

Enums

Role

The type of user interface element.

Extension functions summary

For Modifier
Modifier

Clears the semantics of all the descendant nodes and sets new semantics.

Modifier
Modifier.semantics(mergeDescendants: Boolean = false, properties: SemanticsPropertyReceiver.() -> Unit)

Add semantics key/value pairs to the layout node, for use in testing, accessibility, etc.

For SemanticsPropertyReceiver
Unit
SemanticsPropertyReceiver.copyText(label: String? = null, action: () -> Boolean)

This function adds the SemanticsActions.CopyText to the SemanticsPropertyReceiver.

Unit
SemanticsPropertyReceiver.cutText(label: String? = null, action: () -> Boolean)

This function adds the SemanticsActions.CutText to the SemanticsPropertyReceiver.

Unit

Whether this element is a Dialog.

Unit

Whether this semantics node is disabled.

Unit
SemanticsPropertyReceiver.dismiss(label: String? = null, action: () -> Boolean)

This function adds the SemanticsActions.Dismiss to the SemanticsPropertyReceiver.

Unit

This function adds the SemanticsActions.GetTextLayoutResult to the SemanticsPropertyReceiver.

Unit

Whether this semantics node is hidden.

Unit
SemanticsPropertyReceiver.onClick(label: String? = null, action: () -> Boolean)

This function adds the SemanticsActions.OnClick to the SemanticsPropertyReceiver.

Unit
SemanticsPropertyReceiver.onLongClick(label: String? = null, action: () -> Boolean)

This function adds the SemanticsActions.OnLongClick to the SemanticsPropertyReceiver.

Unit
SemanticsPropertyReceiver.pasteText(label: String? = null, action: () -> Boolean)

This function adds the SemanticsActions.PasteText to the SemanticsPropertyReceiver.

Unit

Whether this semantics node represents a Popup.

Unit
SemanticsPropertyReceiver.scrollBy(label: String? = null, action: (x: Float, y: Float) -> Boolean)

This function adds the SemanticsActions.ScrollBy to the SemanticsPropertyReceiver.

Unit
SemanticsPropertyReceiver.setProgress(label: String? = null, action: (Float) -> Boolean)

This function adds the SemanticsActions.SetProgress to the SemanticsPropertyReceiver.

Unit
SemanticsPropertyReceiver.setSelection(label: String? = null, action: (startIndex: Int, endIndex: Int, traversalMode: Boolean) -> Boolean)

This function adds the SemanticsActions.SetSelection to the SemanticsPropertyReceiver.

Unit
SemanticsPropertyReceiver.setText(label: String? = null, action: (AnnotatedString) -> Boolean)

This function adds the SemanticsActions.SetText to the SemanticsPropertyReceiver.

For SemanticsOwner
List<SemanticsNode>

Finds all SemanticsNodes in the tree owned by this SemanticsOwner.

For SemanticsConfiguration
T?

Extension properties summary

For SemanticsPropertyReceiver
String

String

String

Developer-set content description of the semantics node.

List<CustomAccessibilityAction>

Custom actions which are defined by app developers.

Boolean

Whether this semantics node is focused.

AccessibilityScrollState

The horizontal scroll state of this node if this node is scrollable.

ImeAction

Contains the IME action provided by the node.

Role

The type of user interface element.

Boolean

Whether this element is selected (out of a list of possible selections).

String

Developer-set state description of the semantics node.

AccessibilityRangeInfo

The node is a range with current value.

String

Test tag attached to this semantics node.