structures/ink.ui.structures.elements

Package-level declarations

Types

data class ButtonElement(val text: String, val onClick: () -> Unit, val sentiment: Sentiment = Sentiment.Nominal, val enabled: Boolean = true, val latchOnPress: Boolean = false) : UiElement.Interactive

A clickable button not a part of a block of text.

data class CheckBoxElement(val checked: Boolean, val onClick: () -> Unit) : UiElement.Interactive

Checkbox form element.

data class ElementList(val items: List<UiElement>, val positioning: Positioning = Positioning.Start, val groupingStyle: GroupingStyle = GroupingStyle.Items) : UiElement.Static

UI element that composites multiple elements together.

UI Element that does nothing. Can be used as a default when no element should be shown, or in grids to fill blank space.

data class MenuRowElement(val text: String, val onClick: () -> Unit? = null, val rightElement: UiElement? = null) : UiElement.Interactive

A clickable element in a list of related actions.

UI Element to indicate linear progress of work being done.

data class SpinnerElement(val value: String, val onNextValue: () -> Unit, val onPreviousValue: () -> Unit, val hasPreviousValue: Boolean = true, val hasNextValue: Boolean = true) : UiElement.Interactive

An element that can be cycled through values for.

UI Element to indicate the current state of a described label.

data class TextElement(val text: String, val style: TextStyle = TextStyle.Body) : UiElement.Static

A single contiguous block of text.

data class ThrobberElement(val caption: String? = null, val sentiment: Sentiment = Sentiment.Nominal) : UiElement.Static

UI Element to indicate that work is being done.

sealed interface UiElement

An individual view element in the UI.