SemanticsNodeInteraction

Kotlin |Java

class SemanticsNodeInteraction

kotlin.Any
↳	androidx.compose.ui.test.SemanticsNodeInteraction

Represents a semantics node and the path to fetch it from the semantics tree. One can interact with this node by performing actions such as performClick, assertions such as assertHasClickAction, or navigate to other nodes such as onChildren.

This is usually obtained from methods like onNode.

Example usage:

composeTestRule.onNodeWithTag("myCheckbox")
   .performClick()
   .assertIsOn()

useUnmergedTree is for tests with a special need to inspect "implementation detail" children. For example:

composeTestRule.setMaterialContent {
    // IconButton is a semantically merging composable.  All testTags of its children
    // are merged up into it in the default, "merged" semantics tree.
    IconButton(onClick = {}) {
        MyIcon(Modifier.testTag("icon"))
    }
}

// Assert that MyIcon is at the expected position inside the IconButton.
// Without useUnmergedTree, then the test would check the position of the IconButton (0, 0)
// instead of the position of the Icon (30, 30).
composeTestRule.onNodeWithTag("icon", useUnmergedTree = true)
    .assertLeftPosition(30.dp)
    .assertTopPosition(30.dp)

Summary

Public constructors
`<init>(testContext: TestContext, useUnmergedTree: Boolean, matcher: SemanticsMatcher)`

Public methods
Unit	`assertDoesNotExist()` Asserts that no item was found or that the item is no longer in the hierarchy.
SemanticsNodeInteraction	`assertExists(errorMessageOnFail: String? = null)` Asserts that the component was found and is part of the component tree.
SemanticsNode	`fetchSemanticsNode(errorMessageOnFail: String? = null)` Returns the semantics node captured by this object.

Extension functions

From androidx.compose.ui.test

SemanticsNodeInteraction	`SemanticsNodeInteraction.assert(matcher: SemanticsMatcher, messagePrefixOnError: () -> String = null)` Asserts that the provided matcher is satisfied for this node.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertHasClickAction()` Asserts that the current semantics node has a click action.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertHasNoClickAction()` Asserts that the current semantics node has doesn't have a click action.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertHeightIsAtLeast(expectedMinHeight: Dp)` Asserts that the layout of this node has height that is greater ot equal to expectedMinHeight.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertHeightIsEqualTo(expectedHeight: Dp)` Asserts that the layout of this node has height equal to expectedHeight.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsDisplayed()` Asserts that the current semantics node is displayed on screen.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsEnabled()` Asserts that the current semantics node is enabled.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsFocused()` Asserts that the current semantics node has a focus.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsHidden()` Asserts that the current semantics node has hidden property set to true.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsInMutuallyExclusiveGroup()` Asserts the semantics node is in a mutually exclusive group.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsNotDisplayed()` Asserts that the current semantics node is not displayed on screen.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsNotEnabled()` Asserts that the current semantics node is not enabled.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsNotFocused()` Asserts that the current semantics node does not have a focus.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsNotHidden()` Asserts that the current semantics node has hidden property set to false.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsNotSelected()` Asserts that the current semantics node is not selected.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsOff()` Asserts that the current semantics node is unchecked.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsOn()` Asserts that the current semantics node is checked.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsSelectable()` Asserts that the current semantics node is selectable.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsSelected()` Asserts that the current semantics node is selected.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertIsToggleable()` Asserts that the current semantics node is toggleable.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertLabelEquals(value: String)` Asserts the node's label equals the given String.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertLeftPositionInRootIsEqualTo(expectedLeft: Dp)` Asserts that the layout of this node has the left position in the root composable that is equal to the given position.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertPositionInRootIsEqualTo(expectedLeft: Dp, expectedTop: Dp)` Asserts that the layout of this node has position in the root composable that is equal to the given position.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertRangeInfoEquals(value: AccessibilityRangeInfo)` Asserts the node's range info equals the given value.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertTextEquals(value: String)` Asserts the node's text equals the given String.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertTopPositionInRootIsEqualTo(expectedTop: Dp)` Asserts that the layout of this node has the top position in the root composable that is equal to the given position.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertValueEquals(value: String)` Asserts the node's value equals the given value.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertWidthIsAtLeast(expectedMinWidth: Dp)` Asserts that the layout of this node has width that is greater ot equal to expectedMinWidth.
SemanticsNodeInteraction	`SemanticsNodeInteraction.assertWidthIsEqualTo(expectedWidth: Dp)` Asserts that the layout of this node has width equal to expectedWidth.
ImageBitmap	`SemanticsNodeInteraction.captureToImage()` Captures the underlying semantics node's surface into bitmap.
Dp	`SemanticsNodeInteraction.getAlignmentLinePosition(line: AlignmentLine)` Returns the position of an alignment line, or Dp.Unspecified if the line is not provided.
Bounds	`SemanticsNodeInteraction.getUnclippedBoundsInRoot()` Returns the bounds of the layout of this node.
SemanticsNodeInteractionCollection	`SemanticsNodeInteraction.onAncestors()` Returns all the ancestors of this node.
SemanticsNodeInteraction	`SemanticsNodeInteraction.onChild()` Returns exactly one child of this node.
SemanticsNodeInteraction	`SemanticsNodeInteraction.onChildAt(index: Int)` Returns child of this node at the given index.
SemanticsNodeInteractionCollection	`SemanticsNodeInteraction.onChildren()` Returns children of this node.
SemanticsNodeInteraction	`SemanticsNodeInteraction.onParent()` Returns a parent of this node.
SemanticsNodeInteraction	`SemanticsNodeInteraction.onSibling()` Returns exactly one sibling of this node.
SemanticsNodeInteractionCollection	`SemanticsNodeInteraction.onSiblings()` Returns all siblings of this node.
SemanticsNodeInteraction	`SemanticsNodeInteraction.performClick()` Performs a click action on the element represented by the given semantics node.
SemanticsNodeInteraction	`SemanticsNodeInteraction.performGesture(block: GestureScope.() -> Unit)` Executes the (partial) gesture specified in the given block.
Unit	`SemanticsNodeInteraction.performImeAction(alreadyHasFocus: Boolean = false)` Sends to this node the IME action associated with it in similar way to IME.
Boolean	`SemanticsNodeInteraction.performKeyPress(keyEvent: KeyEvent)` Send the specified KeyEvent to the focused component.
SemanticsNodeInteraction	`SemanticsNodeInteraction.performScrollTo()` Scrolls the closest enclosing scroll parent by the smallest amount such that this node is fully visible in its viewport.
Unit	`SemanticsNodeInteraction.performSemanticsAction(key: SemanticsPropertyKey<AccessibilityAction<T>`