kewt-modifier/dev.kewt.modifier

Package-level declarations

Types

data class AlignmentModifier(val horizontal: HorizontalAlignment? = null, val vertical: VerticalAlignment? = null) : Modifier.Element

An element that defines the alignment of a component within its parent.

BackgroundModifier

data class BackgroundModifier(val color: Color) : Modifier.Element

An element that sets the background color.

BoldModifier

data object BoldModifier : Modifier.Element

An element that applies bold styling.

BorderModifier

data class BorderModifier(val style: BorderStyle, val color: Color = Color.Default) : Modifier.Element

An element that adds a border around a component.

BorderStyle

data class BorderStyle(val topLeft: Char, val topRight: Char, val bottomLeft: Char, val bottomRight: Char, val horizontal: Char, val vertical: Char)

Defines the characters used to draw borders around UI components.

Color

sealed class Color

Represents a color that can be used for foreground or background styling in a terminal.

FillMaxHeightModifier

data class FillMaxHeightModifier(val fraction: Float = 1.0f) : Modifier.Element

An element that requests a fraction of the available height.

FillMaxWidthModifier

data class FillMaxWidthModifier(val fraction: Float = 1.0f) : Modifier.Element

An element that requests a fraction of the available width.

ForegroundModifier

data class ForegroundModifier(val color: Color) : Modifier.Element

An element that sets the foreground (text) color.

HeightModifier

data class HeightModifier(val height: Int) : Modifier.Element

An element that constrains the height of a UI component.

HorizontalAlignment

enum HorizontalAlignment : Enum<HorizontalAlignment>

Possible horizontal alignment options.

ItalicModifier

data object ItalicModifier : Modifier.Element

An element that applies italic styling.

MarginModifier

data class MarginModifier(val left: Int = 0, val right: Int = 0, val top: Int = 0, val bottom: Int = 0) : Modifier.Element

An element that adds margin outside the boundary of a UI component.

Modifier

interface Modifier

An ordered, immutable collection of elements that decorate or augment a UI component.

OffsetModifier

data class OffsetModifier(val x: Int = 0, val y: Int = 0) : Modifier.Element

An element that applies a relative offset to a UI component.

PaddingModifier

data class PaddingModifier(val left: Int = 0, val right: Int = 0, val top: Int = 0, val bottom: Int = 0) : Modifier.Element

An element that adds padding around the content of a UI component.

StrikethroughModifier

data object StrikethroughModifier : Modifier.Element

An element that applies strikethrough styling.

UnderlineModifier

data object UnderlineModifier : Modifier.Element

An element that applies underline styling.

VerticalAlignment

enum VerticalAlignment : Enum<VerticalAlignment>

Possible vertical alignment options.

WeightModifier

data class WeightModifier(val weight: Float) : Modifier.Element

An element used in layout containers to distribute remaining space proportionally.

WidthModifier

data class WidthModifier(val width: Int) : Modifier.Element

An element that constrains the width of a UI component.

WrapContentHeightModifier

data object WrapContentHeightModifier : Modifier.Element

An element that signals the component should fit its content vertically.

WrapContentWidthModifier

data object WrapContentWidthModifier : Modifier.Element

An element that signals the component should fit its content horizontally.

Functions

align

fun Modifier.align(horizontal: HorizontalAlignment): Modifier

Sets the horizontal alignment.

fun Modifier.align(vertical: VerticalAlignment): Modifier

Sets the vertical alignment.

fun Modifier.align(horizontal: HorizontalAlignment, vertical: VerticalAlignment): Modifier

Sets both horizontal and vertical alignment.

background

fun Modifier.background(color: Color): Modifier

Sets the background color.

bold

fun Modifier.bold(): Modifier

Applies bold styling.

border

fun Modifier.border(style: BorderStyle, color: Color = Color.Default): Modifier

Adds a border with the specified style and color.

fillMaxHeight

fun Modifier.fillMaxHeight(fraction: Float = 1.0f): Modifier

Requests to fill the available height, optionally by a fraction.

fillMaxSize

fun Modifier.fillMaxSize(fraction: Float = 1.0f): Modifier

Requests to fill all available space, optionally by a fraction.

fillMaxWidth

fun Modifier.fillMaxWidth(fraction: Float = 1.0f): Modifier

Requests to fill the available width, optionally by a fraction.

findElement

inline fun <T : Modifier.Element> Modifier.findElement(): T?

Finds the last element of type T in the modifier chain.

flatten

fun Modifier.flatten(): List<Modifier.Element>

Flattens the recursive Modifier chain into a linear list of elements.

foreground

fun Modifier.foreground(color: Color): Modifier

Sets the foreground color.

height

fun Modifier.height(height: Int): Modifier

Constrains the height to a fixed height.

italic

fun Modifier.italic(): Modifier

Applies italic styling.

margin

fun Modifier.margin(all: Int): Modifier

Adds all characters of margin on all sides.

fun Modifier.margin(horizontal: Int = 0, vertical: Int = 0): Modifier

Adds horizontal and vertical margin.

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

Adds margin for each side individually.

offset

fun Modifier.offset(x: Int = 0, y: Int = 0): Modifier

Applies a relative x and y offset.

padding

fun Modifier.padding(all: Int): Modifier

Adds all characters of padding on all sides.

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

Adds horizontal and vertical padding.

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

Adds padding for each side individually.

strikethrough

fun Modifier.strikethrough(): Modifier

Applies strikethrough styling.

totalMargin

fun Modifier.totalMargin(): MarginModifier

Accumulates all MarginModifier elements in the chain into a single result.

totalOffset

fun Modifier.totalOffset(): OffsetModifier

Accumulates all OffsetModifier elements in the chain into a single result.

totalPadding

fun Modifier.totalPadding(): PaddingModifier

Accumulates all PaddingModifier elements in the chain into a single result.

underline

fun Modifier.underline(): Modifier

Applies underline styling.

weight

fun Modifier.weight(weight: Float): Modifier

Assigns a relative weight for layout distribution.

width

fun Modifier.width(width: Int): Modifier

Constrains the width to a fixed width.

wrapContentHeight

fun Modifier.wrapContentHeight(): Modifier

Sets vertical sizing to fit content.

wrapContentSize

fun Modifier.wrapContentSize(): Modifier

Sets both horizontal and vertical sizing to fit content.

wrapContentWidth

fun Modifier.wrapContentWidth(): Modifier

Sets horizontal sizing to fit content.