redwood-runtime/app.cash.redwood/Modifier

Modifier

@Stable

@ObjCName(name = "Modifier", exact = true)

interface Modifier

An ordered, immutable collection of elements that change how a widget is laid out.

Inheritors

Element

Companion

Types

Companion

@ObjCName(name = "EmptyModifier", exact = true)

object Companion : Modifier

The companion object Modifier is the empty, default, or starter Modifier that contains no elements. Use it to create a new Modifier using modifier extension factory functions or as the default value for Modifier parameters.

Element

sealed interface Element : Modifier

A single element contained within a Modifier chain.

ScopedElement

interface ScopedElement : Modifier.Element

An Element whose usage is scoped to a parent widget.

UnscopedElement

interface UnscopedElement : Modifier.Element

An Element whose usage is available on any widget.

Functions

forEach

abstract fun forEach(block: (Modifier.Element) -> Unit)

Iterates over all Elements in this Modifier.

forEachScoped

abstract fun forEachScoped(block: (Modifier.ScopedElement) -> Unit)

Iterates over all ScopedElements in this Modifier.

forEachUnscoped

abstract fun forEachUnscoped(block: (Modifier.UnscopedElement) -> Unit)

Iterates over all UnscopedElements in this Modifier.

then

open infix fun then(other: Modifier): Modifier

Concatenates this modifier with another.