Interface

CompositionGroup

CompositionGroup is a group of data slots tracked independently by composition.

Source set: Common
@JvmDefaultWithCompatibility
public interface CompositionGroup : CompositionData

CompositionGroup is a group of data slots tracked independently by composition. These groups correspond to flow control branches (such as if statements and function calls) as well as emitting of a node to the tree.

This interface is not intended to be used directly and is provided to allow the tools API to have access to data tracked during composition. The tools API should be used instead which provides a more usable interpretation of the slot table.

Properties

key

Source set: Common
public val key: Any

A value used to identify the group within its siblings and is typically a compiler generated integer but can be an object if the key composable is used.

sourceInfo

Source set: Common
public val sourceInfo: String?

Information recorded by the compiler to help tooling identify the source that generated the group. The format of this string is internal and is interpreted by the tools API which translates this information into source file name and offsets.

node

Source set: Common
public val node: Any?

If the group represents a node this returns a non-null value which is the node that was emitted for the group.

data

Source set: Common
public val data: Iterable<Any?>

The data stored in the slot table for this group. This information includes the values stored for parameters that are checked for change, any value passed as a parameter for androidx.compose.runtime.remember and the last value returned by androidx.compose.runtime.remember, etc.

identity

Source set: Common
public val identity: Any?

A value that identifies a Group independently of movement caused by recompositions.

groupSize

Source set: Common
public val groupSize: Int

The total number of groups, including itself, that this group contains.

slotsSize

Source set: Common
public val slotsSize: Int

Last updated: