Modifier.Companion

Kotlin |Java

object Modifier.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:

import androidx.compose.foundation.background
import androidx.compose.foundation.layout.padding
import androidx.compose.material.Text

Text(
    "Hello, World!",
    Modifier.padding(16.dp) // Outer padding; outside background
        .background(color = Color.Green) // Solid element background color
        .padding(16.dp) // Inner padding; inside background, around text
)

or as the default value for Modifier parameters:

import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.padding

@Composable
fun PaddedColumn(modifier: Modifier = Modifier) {
    Column(modifier.padding(10.dp)) {
        // ...
    }
}

Summary

Public functions
`open Boolean`	`all(predicate: (Modifier.Element) -> Boolean)` Returns `true` if `predicate` returns true for all `Element`s in this `Modifier` or if this `Modifier` contains no `Element`s.
`open Boolean`	`any(predicate: (Modifier.Element) -> Boolean)` Returns `true` if `predicate` returns true for any `Element` in this `Modifier`.
`open R`	`<R : Any?> foldIn(initial: R, operation: (R, Modifier.Element) -> R)` Accumulates a value starting with `initial` and applying `operation` to the current value and each element from outside in.
`open R`	`<R : Any?> foldOut(initial: R, operation: (Modifier.Element, R) -> R)` Accumulates a value starting with `initial` and applying `operation` to the current value and each element from inside out.
`open infix Modifier`	`then(other: Modifier)` Concatenates this modifier with another.
`open String`	`toString()`

Public functions

all

open fun all(predicate: (Modifier.Element) -> Boolean): Boolean

Returns true if predicate returns true for all Elements in this Modifier or if this Modifier contains no Elements.

any

open fun any(predicate: (Modifier.Element) -> Boolean): Boolean

Returns true if predicate returns true for any Element in this Modifier.

foldIn

open fun <R : Any?> foldIn(initial: R, operation: (R, Modifier.Element) -> R): R

Accumulates a value starting with initial and applying operation to the current value and each element from outside in.

Elements wrap one another in a chain from left to right; an Element that appears to the left of another in a + expression or in operation's parameter order affects all of the elements that appear after it. foldIn may be used to accumulate a value starting from the parent or head of the modifier chain to the final wrapped child.

foldOut

open fun <R : Any?> foldOut(initial: R, operation: (Modifier.Element, R) -> R): R

Accumulates a value starting with initial and applying operation to the current value and each element from inside out.

Elements wrap one another in a chain from left to right; an Element that appears to the left of another in a + expression or in operation's parameter order affects all of the elements that appear after it. foldOut may be used to accumulate a value starting from the child or tail of the modifier chain up to the parent or head of the chain.

then

open infix fun then(other: Modifier): Modifier

Concatenates this modifier with another.

Returns a Modifier representing this modifier followed by other in sequence.

toString

open fun toString(): String