Skip to content

common • net.kernelpanicsoft.archie.gui.modifiers • Modifier

Modifier

interface Modifier

An ordered, immutable collection of modifier elements that decorate or add behavior to Compose UI elements. For example, backgrounds, padding and click event listeners decorate or add behavior to rows, text or buttons.

This class is taken from the androidx Jetpack Compose UI library so as to avoid extra dependencies.

Inheritors

Types

Companion

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.

Element

interface Element<Self : Modifier.Element<Self>> : Modifier

A single element contained within a Modifier chain.

Functions

all

abstract 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

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

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

fillMaxHeight

@Stablefun Modifier.fillMaxHeight(percent: Double = 1.0): Modifier

Forces element height to a percentage between min and max height constraints

fillMaxSize

@Stablefun Modifier.fillMaxSize(percent: Double = 1.0): Modifier

Forces element width and height to a percentage between min and max width and height constraints

fillMaxWidth

@Stablefun Modifier.fillMaxWidth(percent: Double = 1.0): Modifier

Forces element width to a percentage between min and max width constraints

foldIn

abstract 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.

foldOut

abstract 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.

height

@Stablefun Modifier.height(height: Int): Modifier

Sets identical min/max height constraints for this element.

onGloballyPositioned

fun Modifier.onGloballyPositioned(onGloballyPositioned: (IntCoordinates) -> Unit): Modifier

onSizeChanged

fun Modifier.onSizeChanged(onSizeChanged: (Size) -> Unit): Modifier

Notifies callback of any size changes to element.

size

@Stablefun Modifier.size(size: Int): Modifier

Sets identical min/max width and height constraints for this element.

@Stablefun Modifier.size(width: Int, height: Int): Modifier

Sets identical min/max width and height constraints for this element.

sizeIn

@Stablefun Modifier.sizeIn(minWidth: Int = 0, maxWidth: Int = Integer.MAX_VALUE, minHeight: Int = 0, maxHeight: Int = Integer.MAX_VALUE): Modifier

Sets min and max, width and height constraints for this element.

then

open infix fun then(other: Modifier): Modifier

Concatenates this modifier with another.

width

@Stablefun Modifier.width(width: Int): Modifier

Sets identical min/max width constraints for this element.