Companion

Kotlin |Java

companion object Companion : Modifier

kotlin.Any
↳	androidx.compose.ui.Modifier.Companion

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.Text
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.padding

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 methods
Boolean	all(predicate: (Modifier.Element) -> Boolean) Returns true if predicate returns true for all Elements in this Modifier or if this Modifier contains no Elements.
Boolean	any(predicate: (Modifier.Element) -> Boolean) Returns true if predicate returns true for any Element in this Modifier.
R	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.
R	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.
operator Modifier	plus(other: Modifier) Concatenates this modifier with another.
infix Modifier	then(other: Modifier) Concatenates this modifier with another.
String	toString()

Properties
Modifier	None An empty Modifier that contains no elements.

Public methods

all

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

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

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

foldIn

fun <R> 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

fun <R> 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.

plus

operator fun plus(other: Modifier): Modifier

Deprecated.

Concatenates this modifier with another.

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

then

infix fun then(other: Modifier): Modifier

Concatenates this modifier with another.

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

toString

fun toString(): String

Properties

None

val None: Modifier

Deprecated.

An empty Modifier that contains no elements. Suitable for use as a sentinel or default parameter.