api/dev.s7a.strata.modifier/Modifier

Modifier

Immutable ordered active modifier descriptions.

The first description is the outermost node and the last description is nearest the component. Composition is value based when its descriptions obey the immutable modifier contract. The runtime reconciles modifier positions by referential ModifierNodeType token.

Parameters

elements

the immutable ordered descriptions owned by this value.

Types

Companion

object Companion

Common modifier values.

Functions

actionDispatcher

fun Modifier.actionDispatcher(): ActionDispatcher

Captures the typed action handlers declared directly on this modifier chain.

background

fun Modifier.background(color: ArgbColor): Modifier

Paints a color across the modifier's complete local bounds before its content. The new behavior is appended inside the existing modifier chain, so existing outer paint behavior remains earlier.

containerBackground

fun Modifier.containerBackground(rows: Int = 3): Modifier

Sizes the modified component to a Minecraft 26.2 generic chest panel and paints its background before content.

elements

fun elements(): List<ModifierElement>

Returns the immutable description snapshot to the retained runtime.

equals

open operator override fun equals(other: Any?): Boolean

fillMaxHeight

fun Modifier.fillMaxHeight(): Modifier

Fills a bounded parent height while preserving an unbounded height. The new behavior is appended inside the existing modifier chain and leaves the width policy unchanged.

fillMaxSize

fun Modifier.fillMaxSize(): Modifier

Fills every bounded parent axis while preserving unbounded axes. The new behavior is appended inside the existing modifier chain.

fillMaxWidth

fun Modifier.fillMaxWidth(): Modifier

Fills a bounded parent width while preserving an unbounded width. The new behavior is appended inside the existing modifier chain and leaves the height policy unchanged.

focusable

fun Modifier.focusable(): Modifier

Makes the logical component a keyboard and text-input focus target.

hashCode

open override fun hashCode(): Int

height

fun Modifier.height(height: Int): Modifier

Constrains the height to an exact requested size after clamping it into the parent constraints. The new behavior is appended inside the existing modifier chain and leaves the width policy unchanged.

heightIn

fun Modifier.heightIn(min: Int = 0, max: Int = Int.MAX_VALUE): Modifier

Constrains the height to an independently clamped inclusive range. A requested range disjoint from its parent range is pinned to the nearest parent boundary. Int.MAX_VALUE remains an unbounded maximum, and the new behavior is appended inside the existing modifier chain.

imageBackground

fun Modifier.imageBackground(source: ImageSource, scale: ImageScale = ImageScale.Stretch): Modifier

Paints arbitrary immutable image pixels behind the modified component's content.

fun Modifier.imageBackground(source: ImageSource, border: Insets, centerMode: NineSliceCenterMode = NineSliceCenterMode.Tiled): Modifier

Paints arbitrary immutable image pixels as a Minecraft-compatible nine-slice background behind content.

initialFocus

fun Modifier.initialFocus(): Modifier

Makes the logical component the initial focus target when layout has no retained focus owner.

menuBackground

fun Modifier.menuBackground(): Modifier

Paints the selected Minecraft menu texture behind the modified component's content.

onAction

fun <T : Any> Modifier.onAction(key: ActionKey<T>, callback: (T) -> ActionResult): Modifier

Handles one typed component action emitted by the component wrapped by this modifier.

onCharacterInput

fun Modifier.onCharacterInput(callback: (TextInputEvent.Character) -> InputResult): Modifier

Adds a focused committed-character callback.

onCheckedChange

fun Modifier.onCheckedChange(action: (Boolean) -> Unit): Modifier

Handles and consumes Checkbox selected-value changes.

onCycle

fun <T : Any> Modifier.onCycle(action: (T) -> Unit): Modifier

Handles and consumes typed CycleButton value changes.

onDrag

fun Modifier.onDrag(action: () -> Unit): Modifier

Runs action for every pointer drag that hits this modifier without consuming the event.

fun Modifier.onDrag(callback: (PointerEvent.Drag, IntOffset) -> InputResult): Modifier

Handles every pointer drag that hits this modifier's laid-out bounds.

onFocusChanged

fun Modifier.onFocusChanged(callback: (FocusEvent) -> Unit): Modifier

Adds a callback for distinct retained focus transitions and makes the logical component focusable.

onHover

fun Modifier.onHover(callback: (PointerHoverEvent) -> Unit): Modifier

Observes distinct pointer enter and exit transitions for this modifier's laid-out bounds.

onKeyEvent

fun Modifier.onKeyEvent(callback: (KeyboardEvent) -> InputResult): Modifier

Adds a focused callback for every key press and release.

onKeyPress

fun Modifier.onKeyPress(callback: (KeyboardEvent.Press) -> InputResult): Modifier

Adds a focused key-press callback.

onKeyRelease

fun Modifier.onKeyRelease(callback: (KeyboardEvent.Release) -> InputResult): Modifier

Adds a focused key-release callback.

onLeadingItemsRequested

fun Modifier.onLeadingItemsRequested(action: (ListLoadRequest) -> Unit): Modifier

Handles and consumes demand for rows before a virtual list's loaded window.

onMove

fun Modifier.onMove(action: () -> Unit): Modifier

Runs action for every pointer move that hits this modifier without consuming the event.

fun Modifier.onMove(callback: (PointerEvent.Move, IntOffset) -> InputResult): Modifier

Handles every pointer move that hits this modifier's laid-out bounds.

onPointerEvent

fun Modifier.onPointerEvent(callback: (PointerEvent, IntOffset) -> InputResult): Modifier

Handles every typed pointer event that hits this modifier's laid-out bounds.

onPreedit

fun Modifier.onPreedit(callback: (TextInputEvent.Preedit) -> InputResult): Modifier

Adds a focused input-method preedit callback.

onPress

fun Modifier.onPress(action: () -> Unit): Modifier

Runs action for every primary pointer press that hits this modifier and consumes the event. Other button presses remain ignored so lower or earlier handlers can process them.

fun Modifier.onPress(callback: (PointerEvent.Press, IntOffset) -> InputResult): Modifier

Handles every pointer press that hits this modifier's laid-out bounds.

onRelease

fun Modifier.onRelease(action: () -> Unit): Modifier

Runs action for every pointer release that hits this modifier and consumes the event.

fun Modifier.onRelease(callback: (PointerEvent.Release, IntOffset) -> InputResult): Modifier

Handles every pointer release that hits this modifier's laid-out bounds.

onScroll

fun Modifier.onScroll(action: () -> Unit): Modifier

Runs action for every pointer scroll event that hits this modifier and consumes the event.

fun Modifier.onScroll(callback: (PointerEvent.Scroll, IntOffset) -> InputResult): Modifier

Handles every pointer scroll event that hits this modifier's laid-out bounds.

onSelectionChange

fun <K : Any> Modifier.onSelectionChange(action: (K) -> Unit): Modifier

Handles and consumes typed SelectionList key changes.

onSliderChange

fun Modifier.onSliderChange(action: (Double) -> Unit): Modifier

Handles and consumes Slider numeric-value changes.

onTextInput

fun Modifier.onTextInput(callback: (TextInputEvent) -> InputResult): Modifier

Adds a focused callback for both committed characters and input-method preedit updates.

onTrailingItemsRequested

fun Modifier.onTrailingItemsRequested(action: (ListLoadRequest) -> Unit): Modifier

Handles and consumes demand for rows after a virtual list's loaded window.

padding

fun Modifier.padding(insets: Insets): Modifier

Adds checked distances around the virtual child. The new behavior is appended inside the existing modifier chain. Measurement reports an ArithmeticException if a measured child extent plus the checked inset total overflows.

fun Modifier.padding(all: Int): Modifier

Adds one distance around every side of the virtual child. The new behavior is appended inside the existing modifier chain.

fun Modifier.padding(horizontal: Int, vertical: Int): Modifier

Adds equal horizontal and equal vertical distances around the virtual child. The new behavior is appended inside the existing modifier chain.

fun Modifier.padding(left: Int = 0, top: Int = 0, right: Int = 0, bottom: Int = 0): Modifier

Adds independently specified distances around the virtual child. Unspecified sides default to zero, and the new behavior is appended inside the existing modifier chain.

semantics

fun Modifier.semantics(value: Semantics): Modifier

Emits one separate unresolved semantics entry before entries produced by the modifier's content. The new behavior is appended inside the existing modifier chain, so existing outer entries remain earlier.

size

fun Modifier.size(width: Int, height: Int): Modifier

Constrains both axes to exact requested sizes after clamping them into the parent constraints. The new behavior is appended inside the existing modifier chain.

sizeIn

fun Modifier.sizeIn(minWidth: Int = 0, minHeight: Int = 0, maxWidth: Int = Int.MAX_VALUE, maxHeight: Int = Int.MAX_VALUE): Modifier

Constrains both axes to independently clamped inclusive ranges. A requested range disjoint from its parent range is pinned to the nearest parent boundary. Int.MAX_VALUE remains an unbounded maximum, and the new behavior is appended inside the existing modifier chain.

then

fun then(modifier: Modifier): Modifier

Appends another chain inside the existing chain.

fun then(element: ModifierElement): Modifier

Appends one description inside the existing chain.

tooltip

fun Modifier.tooltip(text: UiText, delayMillis: Long = 500): Modifier

Shows a profile-backed root tooltip while the modified element remains hovered.

fun Modifier.tooltip(text: String, delayMillis: Long = 500): Modifier

Literal-text overload of tooltip.

toString

open override fun toString(): String

width

fun Modifier.width(width: Int): Modifier

Constrains the width to an exact requested size after clamping it into the parent constraints. The new behavior is appended inside the existing modifier chain and leaves the height policy unchanged.

widthIn

fun Modifier.widthIn(min: Int = 0, max: Int = Int.MAX_VALUE): Modifier

Constrains the width to an independently clamped inclusive range. A requested range disjoint from its parent range is pinned to the nearest parent boundary. Int.MAX_VALUE remains an unbounded maximum, and the new behavior is appended inside the existing modifier chain.