mosaic-runtime/org.unitedsoftware.mosaic.ui

Package-level declarations

Types

@Stable

fun interface Alignment

An interface to calculate the position of a sized box inside an available space. Alignment is often used to define the alignment of a layout inside a parent layout.

Arrangement

@Immutable

object Arrangement

Used to specify the arrangement of the layout's children in layouts like Row or Column in the main axis direction (horizontal and vertical, respectively).

BiasAlignment

@Immutable

class BiasAlignment(val horizontalBias: Float, val verticalBias: Float) : Alignment

An Alignment specified by bias: for example, a bias of -1 represents alignment to the start/top, a bias of 0 will represent centering, and a bias of 1 will represent end/bottom. Any value can be specified to obtain an alignment. Inside the -1, 1 range, the obtained alignment will position the aligned size fully inside the available space, while outside the range it will the aligned size will be positioned partially or completely outside.

BoxScope

@Immutable

interface BoxScope

A BoxScope provides a scope for the children of Box.

Color

@Immutable

@JvmInline

value class Color

ColumnScope

@Immutable

interface ColumnScope

Scope for the children of Column.

ImageBitmap

@Stable

class ImageBitmap(val width: Int, val height: Int, val pixels: IntArray)

An image of width by height pixels, with the colors of its pixels as 0xAARRGGBB, row by row from the top left. The pixels must not change once the bitmap is shown.

LayoutScopeMarker

@DslMarker

annotation class LayoutScopeMarker

LazyListScope

interface LazyListScope

Receives the items of a LazyColumn.

LazyListState

@Stable

class LazyListState(firstVisibleItemIndex: Int = 0, firstVisibleItemScrollOffset: Int = 0)

The scroll position of a LazyColumn.

MosaicComposable

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.TYPE, AnnotationTarget.TYPE_PARAMETER])

annotation class MosaicComposable

An annotation that can be used to mark an composable function as being expected to be use in a composable function that is also marked or inferred to be marked as a MosaicComposable.

RowScope

@Immutable

interface RowScope

Scope for the children of Row.

SpinnerStyle

@Immutable

class SpinnerStyle(val frames: List<String>, val interval: Duration)

The frames of a Spinner, each shown for interval before the next.

TextFieldState

@Stable

class TextFieldState(initialText: String = "")

The editable text of a TextField, the position of its cursor, and its selection.

TextOverflow

enum TextOverflow : Enum<TextOverflow>

How Text shows text which does not fit.

TextStyle

@Immutable

@JvmInline

value class TextStyle

UnderlineStyle

@Immutable

@JvmInline

value class UnderlineStyle

Properties

DefaultProgressBarWidth

const val DefaultProgressBarWidth: Int = 20

The width of a ProgressBar whose modifier does not size it.

isEmptyTextStyle

@Stable

val TextStyle.isEmptyTextStyle: Boolean

true when this is TextStyle.Empty.

isNotEmptyTextStyle

@Stable

val TextStyle.isNotEmptyTextStyle: Boolean

false when this is TextStyle.Empty.

isSpecifiedColor

@Stable

val Color.isSpecifiedColor: Boolean

false when this is Color.Unspecified.

isSpecifiedTextStyle

@Stable

val TextStyle.isSpecifiedTextStyle: Boolean

false when this is TextStyle.Unspecified.

isSpecifiedUnderlineStyle

@Stable

val UnderlineStyle.isSpecifiedUnderlineStyle: Boolean

false when this is UnderlineStyle.Unspecified.

isUnspecifiedColor

@Stable

val Color.isUnspecifiedColor: Boolean

true when this is Color.Unspecified.

isUnspecifiedTextStyle

@Stable

val TextStyle.isUnspecifiedTextStyle: Boolean

true when this is TextStyle.Unspecified.

isUnspecifiedUnderlineStyle

@Stable

val UnderlineStyle.isUnspecifiedUnderlineStyle: Boolean

true when this is UnderlineStyle.Unspecified.

Functions

Box

@Composable

fun Box(modifier: Modifier = Modifier)

A box with no content that can participate in layout, drawing due to the modifier applied to it.

@Composable

fun Box(modifier: Modifier = Modifier, contentAlignment: Alignment = Alignment.TopStart, propagateMinConstraints: Boolean = false, content: @Composable BoxScope.() -> Unit)

Color

@Stable

fun Color(red: Float, green: Float, blue: Float): Color

@Stable

fun Color(red: Int, green: Int, blue: Int): Color

Creates a new Color instance from an RGB color components.

Column

@Composable

fun Column(modifier: Modifier = Modifier, verticalArrangement: Arrangement.Vertical = Arrangement.Top, horizontalAlignment: Alignment.Horizontal = Alignment.Start, content: @Composable ColumnScope.() -> Unit)

Filler

@Composable

fun Filler(char: Char, modifier: Modifier = Modifier, foreground: Color = Color.Unspecified, background: Color = Color.Unspecified, textStyle: TextStyle = TextStyle.Unspecified)

@Composable

fun Filler(codePoint: Int, modifier: Modifier = Modifier, foreground: Color = Color.Unspecified, background: Color = Color.Unspecified, textStyle: TextStyle = TextStyle.Unspecified)

Component that represents an layout of identical characters, whose size can be defined using Modifier.width, Modifier.height and Modifier.size modifiers.

Image

@Composable

fun Image(bitmap: ImageBitmap, modifier: Modifier = Modifier, contentDescription: String? = null)

Shows bitmap, scaled to fit the incoming constraints while keeping its aspect ratio, and at most as large as its pixels on the terminal when its cell size is known.

items

inline fun <T> LazyListScope.items(items: List<T>, noinline key: (item: T) -> Any? = null, crossinline itemContent: @Composable (item: T) -> Unit)

Adds an item for each of items.

itemsIndexed

inline fun <T> LazyListScope.itemsIndexed(items: List<T>, noinline key: (index: Int, item: T) -> Any? = null, crossinline itemContent: @Composable (index: Int, item: T) -> Unit)

Adds an item for each of items, passing its index as well.

Layout

@Composable

fun Layout(content: @Composable () -> Unit, modifier: Modifier = Modifier, debugInfo: () -> String = { "Layout()" }, measurePolicy: MeasurePolicy)

LazyColumn

@Composable

fun LazyColumn(modifier: Modifier = Modifier, state: LazyListState = rememberLazyListState(), content: LazyListScope.() -> Unit)

A column which only composes and lays out the items which are visible, so that it can hold more items than would be practical to compose at once, like the messages of a long conversation. Content outside of its bounds is clipped.

Popup

@Composable

fun Popup(alignment: Alignment = Alignment.TopStart, offset: IntOffset = IntOffset.Zero, content: @Composable () -> Unit)

Shows content on top of everything else, like a completion menu or a dialog.

ProgressBar

@Composable

fun ProgressBar(progress: Float, modifier: Modifier = Modifier, color: Color = Color.Unspecified, trackColor: Color = Color.Unspecified)

A bar which fills from the left as progress goes from 0 to 1, to an eighth of a cell.

rememberLazyListState

@Composable

fun rememberLazyListState(firstVisibleItemIndex: Int = 0, firstVisibleItemScrollOffset: Int = 0): LazyListState

Row

@Composable

fun Row(modifier: Modifier = Modifier, horizontalArrangement: Arrangement.Horizontal = Arrangement.Start, verticalAlignment: Alignment.Vertical = Alignment.Top, content: @Composable RowScope.() -> Unit)

Spacer

@Composable

fun Spacer(modifier: Modifier = Modifier)

Component that represents an empty space layout, whose size can be defined using Modifier.width, Modifier.height and Modifier.size modifiers.

Spinner

@Composable

fun Spinner(modifier: Modifier = Modifier, style: SpinnerStyle = SpinnerStyle.Dots, color: Color = Color.Unspecified, textStyle: TextStyle = TextStyle.Unspecified)

An animation which shows the frames of style in turn for as long as it is composed, for work whose progress is unknown. It is as wide as the widest frame, so that what follows it stays put.

takeOrElse

inline fun Color.takeOrElse(block: () -> Color): Color

If this color isSpecifiedColor then this is returned, otherwise block is executed and its result is returned.

inline fun TextStyle.takeOrElse(block: () -> TextStyle): TextStyle

If this text style isSpecifiedTextStyle then this is returned, otherwise block is executed and its result is returned.

inline fun UnderlineStyle.takeOrElse(block: () -> UnderlineStyle): UnderlineStyle

If this text style isSpecifiedUnderlineStyle then this is returned, otherwise block is executed and its result is returned.

Text

@Composable

fun Text(value: String, modifier: Modifier = Modifier, color: Color = Color.Unspecified, background: Color = Color.Unspecified, textStyle: TextStyle = TextStyle.Unspecified, underlineStyle: UnderlineStyle = UnderlineStyle.Unspecified, underlineColor: Color = Color.Unspecified, softWrap: Boolean = true, maxLines: Int = Int.MAX_VALUE, overflow: TextOverflow = TextOverflow.Clip)

Displays value.

@Composable

fun Text(value: AnnotatedString, modifier: Modifier = Modifier, color: Color = Color.Unspecified, background: Color = Color.Unspecified, textStyle: TextStyle = TextStyle.Unspecified, underlineStyle: UnderlineStyle = UnderlineStyle.Unspecified, underlineColor: Color = Color.Unspecified, softWrap: Boolean = true, maxLines: Int = Int.MAX_VALUE, overflow: TextOverflow = TextOverflow.Clip)

Displays value with its styles.

TextField

@Composable

fun TextField(state: TextFieldState, modifier: Modifier = Modifier, singleLine: Boolean = false, maxLines: Int = Int.MAX_VALUE, minLines: Int = 1, placeholder: String = "", color: Color = Color.Unspecified, placeholderColor: Color = Color.Unspecified, textStyle: TextStyle = TextStyle.Unspecified, onSubmit: (text: String) -> Unit? = null)

An editable text field.