ComposeContentTestRule

Artifact: androidx.compose.ui:ui-test-junit4

View Source

Added in 1.0.0

Android/JVM

• android

  interface ComposeContentTestRule : ComposeTestRule

Known direct subclasses

AndroidComposeTestRule

AndroidComposeTestRule

---

A ComposeTestRule that allows you to set content without the necessity to provide a host for the content. The host, such as an Activity, will be created by the test rule.

An instance of ComposeContentTestRule can be created with createComposeRule. If you need to specify which particular Activity is started on Android, you can use createAndroidComposeRule.

If you don't want any host to be started automatically by the test rule on Android, you can use createEmptyComposeRule. In such a case, you will have to create a host in your test and set the content using one of Compose UI's setters (like ComponentActivity .setContent).

Summary

Public functions
Unit	setContent(composable: @Composable () -> Unit) Sets the given composable as a content of the current screen.	android

Inherited functions
From androidx.compose.ui.test.junit4.ComposeTestRule suspend Unit awaitIdle() Suspends until the UI is idle. android open Unit @RequiresApi(value = 34) disableAccessibilityChecks() Disables accessibility checks. android open Unit @RequiresApi(value = 34) enableAccessibilityChecks() Enables accessibility checks that will be run before every action that is expected to change the UI. android Unit registerIdlingResource(idlingResource: IdlingResource) Registers an IdlingResource in this test. android T <T : Any?> runOnIdle(action: () -> T) Executes the given action in the same way as runOnUiThread but waits until the app is idle before executing the action. android T <T : Any?> runOnUiThread(action: () -> T) Runs the given action on the UI thread. android Unit unregisterIdlingResource(idlingResource: IdlingResource) Unregisters an IdlingResource from this test. android Unit waitForIdle() Waits for the UI to become idle. android Unit waitUntil(timeoutMillis: Long, condition: () -> Boolean) Blocks until the given condition is satisfied. android open Unit waitUntil(     conditionDescription: String,     timeoutMillis: Long,     condition: () -> Boolean ) Blocks until the given condition is satisfied. android Unit @ExperimentalTestApi waitUntilAtLeastOneExists(matcher: SemanticsMatcher, timeoutMillis: Long) Blocks until at least one node matches the given matcher. android Unit @ExperimentalTestApi waitUntilDoesNotExist(matcher: SemanticsMatcher, timeoutMillis: Long) Blocks until no nodes match the given matcher. android Unit @ExperimentalTestApi waitUntilExactlyOneExists(matcher: SemanticsMatcher, timeoutMillis: Long) Blocks until exactly one node matches the given matcher. android Unit @ExperimentalTestApi waitUntilNodeCount(     matcher: SemanticsMatcher,     count: Int,     timeoutMillis: Long ) Blocks until the number of nodes matching the given matcher is equal to the given count. android
From androidx.compose.ui.test.SemanticsNodeInteractionsProvider SemanticsNodeInteractionCollection onAllNodes(matcher: SemanticsMatcher, useUnmergedTree: Boolean) Finds all semantics nodes that match the given condition. android SemanticsNodeInteraction onNode(matcher: SemanticsMatcher, useUnmergedTree: Boolean) Finds a semantics node that matches the given condition. android
From org.junit.rules.TestRule Statement apply(p0: Statement, p1: Description) android

Inherited properties
From androidx.compose.ui.test.junit4.ComposeTestRule Density density Current device screen's density. android MainTestClock mainClock Clock that drives frames and recompositions in compose tests. android

Public functions

setContent

android

Added in 1.0.0

fun setContent(composable: @Composable () -> Unit): Unit

Sets the given composable as a content of the current screen.

Use this in your tests to setup the UI content to be tested. This should be called exactly once per test.

Throws
kotlin.IllegalStateException	if called more than once per test.