1.0.0

library/xyz.malefic.compose.iced

Package-level declarations

Types

interface Application<Model, Message>

Core interface for an Iced application following the Elm Architecture.

data class Button(val label: String, val onClick: () -> Unit = {}, val key: String? = null) : Element

Represents a button element that can trigger messages.

data class Card(val children: List<Element>, val key: String? = null) : Element

Represents a card container with elevation.

data class Checkbox(val checked: Boolean, val onCheckedChange: (Boolean) -> Unit = {}, val label: String? = null, val key: String? = null) : Element

Represents a checkbox element.

data class Column(val children: List<Element>, val key: String? = null) : Element

Represents a vertical container element that holds child elements.

interface Command<Message>

Represents a command that produces messages asynchronously. Commands are used to handle side effects in the Elm Architecture, such as HTTP requests, timers, or other asynchronous operations.

interface Element

Base interface for UI elements in the Iced framework. This provides a common abstraction for platform-specific UI implementations.

class IcedRuntime<Model, Message>(application: Application<Model, Message>)

Runtime for executing Iced applications with Jetpack Compose. This provides the bridge between the Elm Architecture model and Compose UI.

class NoneCommand<Message> : Command<Message>

A command that does nothing and produces no messages.

NoneSubscription

class NoneSubscription<Message> : Subscription<Message>

A subscription that produces no messages.

data class Row(val children: List<Element>, val key: String? = null) : Element

Represents a horizontal container element that holds child elements.

data class Spacer(val size: Int = 8, val key: String? = null) : Element

Represents a spacer element for adding space between elements.

interface Subscription<Message>

Represents a subscription to external events. Subscriptions allow applications to listen to events like time, keyboard input, or other continuous streams of data.

data class Switch(val checked: Boolean, val onCheckedChange: (Boolean) -> Unit = {}, val label: String? = null, val key: String? = null) : Element

Represents a switch/toggle element.

data class Text(val content: String, val key: String? = null) : Element

Represents a simple text element.

data class TextField(val value: String, val onValueChange: (String) -> Unit = {}, val placeholder: String = "", val key: String? = null) : Element

Represents a text input field.

Functions

fun <Message> batch(vararg commands: Command<Message>): Command<Message>

Creates a batch of commands that will execute concurrently.

operator fun <Model, Message> Application<Model, Message>.invoke()

Convenience operator function that runs this Application as a Composable.

fun <Model, Message> Application<Model, Message>.runIced()

Creates and runs an Iced application inside a Jetpack Compose context.