mosaic-runtime/org.unitedsoftware.mosaic

Package-level declarations

Types

interface Clipboard

Puts text on the clipboard of the computer running the terminal.

@Stable

class ClipboardCopy(val text: String)

A copy of text to the clipboard.

interface Mosaic

NonInteractivePolicy

enum NonInteractivePolicy : Enum<NonInteractivePolicy>

Behaviors when there is no interactive TTY.

interface Notifier

Shows desktop notifications through the terminal.

@Immutable

value class PointerShape(val name: String)

A shape of the mouse pointer, named like the CSS cursor it corresponds to.

@Stable

class StaticLogger

TerminalControl

interface TerminalControl

Lets other programs use the terminal for a while, like an editor or an interactive command.

@Immutable

class TerminalState(val focused: Boolean, val theme: Terminal.Theme, val size: Terminal.Size)

interface TextCanvas

Properties

val LocalClipboard: ProvidableCompositionLocal<Clipboard>

val LocalNotifier: ProvidableCompositionLocal<Notifier>

LocalStaticLogger

val LocalStaticLogger: ProvidableCompositionLocal<StaticLogger>

LocalTerminalControl

val LocalTerminalControl: ProvidableCompositionLocal<TerminalControl>

LocalTerminalState

val LocalTerminalState: ProvidableCompositionLocal<TerminalState>

Functions

fun Mosaic(coroutineContext: CoroutineContext, onDraw: (Mosaic) -> Unit, terminal: Terminal): Mosaic

suspend fun runMosaic(onNonInteractive: NonInteractivePolicy = Exit, alternateScreen: Boolean = false, mouse: Boolean = alternateScreen, content: @Composable () -> Unit): Boolean

runMosaicBlocking

fun runMosaicBlocking(onNonInteractive: NonInteractivePolicy = Exit, alternateScreen: Boolean = false, mouse: Boolean = alternateScreen, content: @Composable () -> Unit): Boolean

fun runMosaicMain(alternateScreen: Boolean = false, mouse: Boolean = alternateScreen, content: @Composable () -> Unit)

Run content until it completes, for use in main.

@Composable

fun StaticEffect(content: @Composable () -> Unit)

Render content once as permanent output above the regular display.

WindowPointerShape

@Composable

fun WindowPointerShape(shape: PointerShape)

Sets the shape of the mouse pointer over the terminal window while this is in the composition, in terminals which support the Kitty pointer shape protocol. Others ignore it.

@Composable

fun WindowTitle(title: String)

Sets the title of the terminal window while this is in the composition.