mosaic-runtime/com.jakewharton.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.

LayoutScopeMarker

@DslMarker

annotation class LayoutScopeMarker

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.

TextStyle

@Immutable

@JvmInline

value class TextStyle

Properties

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.

isUnspecifiedColor

@Stable

val Color.isUnspecifiedColor: Boolean

true when this is Color.Unspecified.

isUnspecifiedTextStyle

@Stable

val TextStyle.isUnspecifiedTextStyle: Boolean

true when this is TextStyle.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.

Layout

@Composable

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

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.

Static

@Composable

fun <T> Static(items: SnapshotStateList<T>, content: @Composable (T) -> Unit)

Will render each value emitted by items as permanent output above the regular display.

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.

Text

@Composable

fun Text(value: AnnotatedString, modifier: Modifier = Modifier, color: Color = Color.Unspecified, background: Color = Color.Unspecified, textStyle: TextStyle = TextStyle.Unspecified)

@Composable

fun Text(value: String, modifier: Modifier = Modifier, color: Color = Color.Unspecified, background: Color = Color.Unspecified, textStyle: TextStyle = TextStyle.Unspecified)