structures/ink.ui.structures.elements

Package-level declarations

Types

@Serializable

@SerialName(value = "breadcrumb")

data class BreadcrumbElement(val items: List<BreadcrumbElement.Breadcrumb>) : UiElement.Static

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

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

CheckBoxElement

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

Checkbox form element.

DividerElement

@Serializable

@SerialName(value = "divider")

object DividerElement : UiElement.Static

ElementList

@Serializable

@SerialName(value = "element-list")

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

UI element that composites multiple elements together.

EmptyElement

@Serializable

@SerialName(value = "empty")

data object EmptyElement : UiElement.Static

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

FormattedText

@Serializable

@SerialName(value = "formatted-text")

data class FormattedText(val spans: List<FormattedText.Span>, val paragraph: Boolean = true) : UiElement.Static

IconElement

@Serializable

@SerialName(value = "icon")

data class IconElement(val symbol: Symbol, val sentiment: Sentiment = Sentiment.Nominal, val sizing: IconSizing = IconSizing.Medium) : UiElement.Static

A vector icon for signifying a noun or action.

MenuRowElement

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.

Orientation

@Serializable

enum Orientation : Enum<Orientation>

ProgressElement

@Serializable

sealed interface ProgressElement : UiElement.Static

UI Element to indicate linear progress of work being done.

SpinnerElement

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.

StackElement

data class StackElement(val requireDistinct: Boolean = true) : UiElement.Interactive

Element that buffers UI elements into its own layout dynamically.

StatusIndicatorElement

@Serializable

@SerialName(value = "status-indicator")

data class StatusIndicatorElement(val text: String, val sentiment: Sentiment) : UiElement.Static

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

TextElement

@Serializable

@SerialName(value = "text")

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

A single contiguous block of text.

TextListElement

@Serializable

@SerialName(value = "text-list")

data class TextListElement(val items: List<FormattedText>, val ordered: Boolean = false) : UiElement.Static

A bulleted or numbered list of text items.

ThrobberElement

@Serializable

@SerialName(value = "throbber")

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

UI Element to indicate that work is being done.

UiElement

sealed interface UiElement

An individual view element in the UI.

WeatherElement

data class WeatherElement(val temperature: String, val condition: WeatherElement.Condition, val secondaryText: String? = null, val title: String? = null, val daytime: Boolean = true, val sentiment: Sentiment? = null, val compact: Boolean = false) : UiElement.Static

Functions

inline

fun inline(vararg items: UiElement): ElementList

items

fun items(vararg items: UiElement): ElementList

println

suspend fun StackElement.println(message: String, textStyle: TextStyle = TextStyle.Body)

sections

fun sections(vararg items: UiElement): ElementList

unified

fun unified(vararg items: UiElement): ElementList