mordant/com.github.ajalt.mordant.widgets

Package-level declarations

Types

Caption

class Caption(val content: Widget, val top: Widget? = null, val bottom: Widget? = null) : Widget

Add a top and/or bottom caption to content

DefinitionListBuilder

class DefinitionListBuilder

DefinitionListEntryBuilder

class DefinitionListEntryBuilder

EmptyWidget

object EmptyWidget : Widget

A widget with 0 width, 0 height, and no content.

HorizontalRule

class HorizontalRule : Widget

A line drawn across the terminal, with an optional title.

OrderedList

class OrderedList : Widget

A numbered list of widgets.

Padding

data class Padding(val top: Int, val right: Int, val bottom: Int, val left: Int)

Panel

class Panel : Widget

A box drawn around another widget, with optional top and bottom titles.

ProgressBar

class ProgressBar : Widget

A horizontal bar that tracks progress.

SelectList

class SelectList : Widget

A list widget with selectable items.

Spinner

class Spinner(frames: List<Widget>, duration: Int = 1, initial: Int = 0) : Widget

A widget that will loop through a fixed list of frames.

Text

class Text : Widget

UnorderedList

class UnorderedList : Widget

Viewport

class Viewport(content: Widget, width: Int?, height: Int? = null, scrollRight: Int = 0, scrollDown: Int = 0) : Widget

Crop or pad another content widget to a fixed size, and optionally scroll visible portion of the widget within that size.

Functions

definitionList

fun definitionList(init: DefinitionListBuilder.() -> Unit): Widget

Build a definition list widget.

OrderedList

fun OrderedList(vararg listEntries: Widget, numberStyle: TextStyle? = null, numberSeparator: String? = null): OrderedList

fun OrderedList(vararg listEntries: String, numberStyle: TextStyle? = null, numberSeparator: String? = null): OrderedList

plus

operator fun Padding.plus(other: Padding): Padding

UnorderedList

fun UnorderedList(vararg listEntries: Widget, bulletText: String? = null, bulletStyle: TextStyle? = null): UnorderedList

fun UnorderedList(vararg listEntries: String, bulletText: String? = null, bulletStyle: TextStyle? = null): UnorderedList

withPadding

fun Widget.withPadding(padding: Padding, padEmptyLines: Boolean = true): Widget

Add padding around this widget.

fun Widget.withPadding(padEmptyLines: Boolean = true, padding: Padding.Builder.() -> Unit): Widget

fun Widget.withPadding(all: Int, padEmptyLines: Boolean = true): Widget

fun Widget.withPadding(top: Int, right: Int, bottom: Int, left: Int, padEmptyLines: Boolean = true): Widget