viewcompose-ui-foundation/com.viewcompose.ui.foundation

Package-level declarations

Types

Default visual, typography, and spacing tokens for alert dialogs.

data class AlertDialogOverrides(val containerColor: Int? = null, val titleColor: Int? = null, val textColor: Int? = null, val iconTint: Int? = null, val titleStyle: UiTextStyle? = null, val textStyle: UiTextStyle? = null, val shape: UiShape? = null, val contentPadding: UiDp? = null, val titleToTextSpacing: UiDp? = null, val textToButtonsSpacing: UiDp? = null, val buttonSpacing: UiDp? = null, val iconBottomSpacing: UiDp? = null, val iconSize: UiDp? = null, val minWidth: UiDp? = null)

Selectively replaces AlertDialog surface, typography, icon, and spacing appearance.

BadgeDefaults

object BadgeDefaults

Default color, size, and typography tokens for badge components.

BadgeOverrides

data class BadgeOverrides(val containerColor: Int? = null, val contentColor: Int? = null, val textStyle: UiTextStyle? = null, val shape: UiShape? = null, val dotSize: UiDp? = null, val pillHeight: UiDp? = null, val pillMinWidth: UiDp? = null, val pillHorizontalPadding: UiDp? = null)

Selectively replaces Badge appearance and visual geometry.

BasicButtonStyle

data class BasicButtonStyle(val surface: BasicSurfaceStyle, val contentColor: Int, val textStyle: UiTextStyle, val stateLayerColors: UiStateLayerColors, val minimumWidth: UiDp = UiDp.Zero, val minimumHeight: UiDp = UiDp.Zero, val visualHeight: UiDp? = null, val paddingHorizontal: UiDp = UiDp.Zero, val paddingVertical: UiDp = UiDp.Zero, val iconSize: UiDp = UiDp.Zero, val iconSpacing: UiDp = UiDp.Zero)

Defines fully resolved values for a BasicButton action composite.

BasicSurfaceStyle

data class BasicSurfaceStyle(val fill: Brush, val shape: UiShape, val borderWidth: UiDp = UiDp.Zero, val borderColor: Int = 0, val elevation: UiDp = UiDp.Zero, val dropShadows: List<UiShadow> = emptyList(), val innerShadows: List<UiShadow> = emptyList(), val clipContent: Boolean = false, val interactionIndication: UiInteractionIndication? = null)

Defines fully resolved visual values consumed by BasicSurface.

BasicTextFieldStyle

data class BasicTextFieldStyle(val cursorColor: Int, val textColor: Int, val textStyle: UiTextStyle, val placeholderColor: Int, val containerColor: Int, val borderWidth: UiDp, val borderColor: Int, val shape: UiShape, val minimumHeight: UiDp, val horizontalPadding: UiDp, val verticalPadding: UiDp)

Defines the complete resolved appearance consumed by BasicTextField.

BottomAppBarDefaults

object BottomAppBarDefaults

Default visual and size tokens for bottom app bars.

BottomAppBarOverrides

data class BottomAppBarOverrides(val containerColor: Int? = null, val contentColor: Int? = null, val height: UiDp? = null, val horizontalPadding: UiDp? = null, val elevation: UiDp? = null)

Selectively replaces BottomAppBar appearance and visual spacing.

BoxScope

class BoxScope : LayoutScope

Box content scope that exposes box-alignment modifiers.

ButtonDefaults

object ButtonDefaults

Resolves Button appearance from the current theme and scoped ButtonOverrides.

ButtonOverrides

data class ButtonOverrides(val containerColor: Int? = null, val disabledContainerColor: Int? = null, val contentColor: Int? = null, val disabledContentColor: Int? = null, val borderColor: Int? = null, val disabledBorderColor: Int? = null, val borderWidth: UiDp? = null, val shape: UiShape? = null, val stateLayerColors: UiStateLayerColors? = null, val textStyle: UiTextStyle? = null, val minimumHeight: UiDp? = null, val visualHeight: UiDp? = null, val horizontalPadding: UiDp? = null, val verticalPadding: UiDp? = null, val iconSize: UiDp? = null, val iconSpacing: UiDp? = null)

Selectively replaces low-frequency appearance values resolved by Button.

ButtonSize

enum ButtonSize : Enum<ButtonSize>

Interaction-density tier used to select Button dimensions and typography.

ButtonVariant

enum ButtonVariant : Enum<ButtonVariant>

Visual hierarchy used to select Button colors, border, and container treatment.

CardDefaults

object CardDefaults

Default visual and interaction tokens for card components.

CardVariant

enum CardVariant : Enum<CardVariant>

Visual hierarchy variants for card components.

CheckboxOverrides

data class CheckboxOverrides(val labelColor: Int? = null, val disabledLabelColor: Int? = null, val checkedColor: Int? = null, val uncheckedColor: Int? = null, val disabledCheckedColor: Int? = null, val disabledUncheckedColor: Int? = null, val textStyle: UiTextStyle? = null, val stateLayerColors: UiStateLayerColors? = null, val minimumHeight: UiDp? = null)

Selectively replaces Checkbox appearance without affecting other input-control families.

ChipDefaults

object ChipDefaults

Resolves Chip colors, dimensions, typography, and feedback from the current theme.

ChipVariant

enum ChipVariant : Enum<ChipVariant>

Semantic chip role used to select selected-container and border treatment.

CircularProgressIndicatorOverrides

data class CircularProgressIndicatorOverrides(val indicatorColor: Int? = null, val trackColor: Int? = null, val size: UiDp? = null, val trackThickness: UiDp? = null)

Selectively replaces circular progress-indicator appearance.

ColumnScope

class ColumnScope : LayoutScope

Column content scope that exposes vertical-layout-specific parent-data modifiers.

CompositionEffectContext

object CompositionEffectContext

Marks integration-owned effect callbacks that run after their declaring provider stack returns.

ContentColor

object ContentColor

Exposes the current default content color, normally provided by a theme or surface.

CoreObservedPropertyFrame

data class CoreObservedPropertyFrame(val renderStats: RenderStats = RenderStats(), val renderResult: RenderTreeResult? = null, val commitEffects: List<CoreRenderCommitEffect> = emptyList(), val commitFailures: List<CoreRenderCommitFailure> = emptyList())

Lightweight renderer result for one property-only transaction.

CoreObservedPropertyPatch

data class CoreObservedPropertyPatch(val id: Long, val target: CoreObservedPropertyTarget, val previous: VNode, val next: VNode)

One renderer-neutral property-only VNode replacement in an atomic batch.

CoreObservedPropertyTarget

class CoreObservedPropertyTarget(val handle: Any, node: VNode)

Renderer-owned exact target recorded for one committed observed property.

CoreRenderCommitEffect

data class CoreRenderCommitEffect(val operation: RenderFailureOperation, val nodeKey: Any?, val commit: () -> Unit)

Native mutation deferred by the renderer until the session commit phase.

CoreRenderCommitFailure

data class CoreRenderCommitFailure(val operation: RenderFailureOperation?, val nodeKey: Any?, val cause: Throwable)

Native failure captured by the renderer while rendering or disposing mounted nodes.

CoreRenderEngine

interface CoreRenderEngine

Narrow render-engine contract installed by a host module.

CoreRenderFrame

data class CoreRenderFrame(val mountedNodes: List<Any>, val observedPropertyTargets: Map<Long, CoreObservedPropertyTarget> = emptyMap(), val renderStats: RenderStats = RenderStats(), val renderResult: RenderTreeResult? = null, val commitEffects: List<CoreRenderCommitEffect> = emptyList(), val commitFailures: List<CoreRenderCommitFailure> = emptyList())

Output prepared by a renderer for one frame.

CoreReusableRenderTree

interface CoreReusableRenderTree

Opaque renderer-owned native tree detached from a render container and logical session.

DesignSystemDiagnostics

object DesignSystemDiagnostics

Reads optional design-system attribution for the current synchronous composition scope.

DialogOverlayContent

data class DialogOverlayContent(val surface: OverlaySurfaceContent)

Holds content that a runtime host can render into a dialog-owned surface.

DialogOverlayHandle

interface DialogOverlayHandle

Represents a platform dialog instance that can be updated in place or dismissed.

DialogOverlayHost

class DialogOverlayHost(presenter: DialogOverlayPresenter) : SessionBoundSurfaceOverlayHost<DialogOverlaySpec, DialogOverlayContent, DialogOverlayHandle>

Synchronizes declarative overlay requests to a dialog presenter and owns lifecycle by session/key.

DialogOverlayPresenter

interface DialogOverlayPresenter

Platform-provided dialog presentation entry point; widget-core depends only on this minimal contract.

DialogOverlaySpec

class DialogOverlaySpec(val dismissOnBackPress: Boolean = true, val dismissOnClickOutside: Boolean = true, val position: DialogPosition = DialogPosition.Center, val scrimOpacity: Float = 0.32f, val onDismissRequest: () -> Unit? = null)

Describes platform-neutral behavior for one dialog overlay.

DialogPosition

enum DialogPosition : Enum<DialogPosition>

Defines where a dialog is anchored inside its host window.

DisposableEffectResult

fun interface DisposableEffectResult

Holds one runtime-owned cleanup operation produced by DisposableEffectScope.onDispose.

DisposableEffectScope

class DisposableEffectScope

Builds the terminal cleanup result required by DisposableEffect.

DividerDefaults

object DividerDefaults

Default visual tokens for divider components.

DropdownMenuDefaults

object DropdownMenuDefaults

Default visual, size, and spacing tokens for dropdown menus and their items.

Environment

object Environment

Exposes density, locales, layout direction, and resource revision for the current scope.

ExtendedFloatingActionButtonOverrides

data class ExtendedFloatingActionButtonOverrides(val containerColor: Int? = null, val contentColor: Int? = null, val shape: UiShape? = null, val elevation: UiDp? = null, val stateLayerColors: UiStateLayerColors? = null, val textStyle: UiTextStyle? = null, val iconSize: UiDp? = null, val height: UiDp? = null, val horizontalPadding: UiDp? = null, val iconSpacing: UiDp? = null)

Selectively replaces ExtendedFloatingActionButton appearance.

FabDefaults

object FabDefaults

Resolves FAB and extended-FAB defaults from the current theme.

FabSize

enum FabSize : Enum<FabSize>

Size tier used to select FAB bounds, icon size, and shape.

FloatingActionButtonOverrides

data class FloatingActionButtonOverrides(val containerColor: Int? = null, val contentColor: Int? = null, val shape: UiShape? = null, val elevation: UiDp? = null, val stateLayerColors: UiStateLayerColors? = null)

Selectively replaces regular FloatingActionButton appearance.

HorizontalPagerScope

class HorizontalPagerScope

Declares delayed pager pages with explicit logical identity and semantic revisions.

IconButtonDefaults

object IconButtonDefaults

Resolves IconButton appearance from semantic Button roles and independent scoped overrides.

IconButtonOverrides

data class IconButtonOverrides(val containerColor: Int? = null, val disabledContainerColor: Int? = null, val contentColor: Int? = null, val disabledContentColor: Int? = null, val borderColor: Int? = null, val disabledBorderColor: Int? = null, val borderWidth: UiDp? = null, val shape: UiShape? = null, val stateLayerColors: UiStateLayerColors? = null, val size: UiDp? = null, val contentPadding: UiDp? = null)

Selectively replaces low-frequency appearance values resolved by IconButton.

IconDefaults

object IconDefaults

Default size and tint tokens for icon components.

ImageLoading

object ImageLoading

Resolves the image loader captured by image nodes in the current tree-building scope.

InputControlDefaults

object InputControlDefaults

Resolves native input-control appearance from theme tokens and family-specific overrides.

LayoutScope

open class LayoutScope : UiTreeBuilder

Base layout DSL scope that extends UiTreeBuilder so children can keep emitting nodes.

LazyGridScope

class LazyGridScope

Declares keyed lazy-grid entries with spans and separated logical and physical ownership.

LazyItemsSnapshot

class LazyItemsSnapshot<out T>

Carries one immutable lazy-collection submission with a framework-created identity.

LazyListScope

class LazyListScope

Declares keyed lazy-list entries whose logical sessions are independent from recycled Views.

LinearProgressIndicatorOverrides

data class LinearProgressIndicatorOverrides(val indicatorColor: Int? = null, val trackColor: Int? = null, val trackThickness: UiDp? = null)

Selectively replaces linear progress-indicator appearance.

ListItemDefaults

object ListItemDefaults

Default typography, color, size, and spacing tokens for list items.

LocalAnimationCoroutineContext

object LocalAnimationCoroutineContext

Exposes the additional coroutine context used by animations in the current composition.

LocalFocusManager

object LocalFocusManager

Exposes the focus owner for the render session currently being composed.

LocalMonotonicFrameClock

object LocalMonotonicFrameClock

Exposes the monotonic frame clock used by the current composition scope.

LocalSaveableStateRegistry

object LocalSaveableStateRegistry

Exposes the saveable-state registry installed for the current composition.

ModalBottomSheetAppearance

data class ModalBottomSheetAppearance(val containerColor: Int, val contentColor: Int, val shape: UiShape, val scrimOpacity: Float, val navigationBarColor: ModalBottomSheetNavigationBarColor)

Carries complete modal-bottom-sheet appearance across an overlay session boundary.

ModalBottomSheetDefaults

object ModalBottomSheetDefaults

Default visual tokens for modal bottom sheets.

ModalBottomSheetNavigationBarColor

sealed interface ModalBottomSheetNavigationBarColor

Selects the system navigation-bar treatment while a modal bottom sheet is visible.

ModalBottomSheetOverlayContent

data class ModalBottomSheetOverlayContent(val surface: OverlaySurfaceContent)

Holds content that a runtime host can render into a bottom-sheet-owned surface.

ModalBottomSheetOverlayHandle

interface ModalBottomSheetOverlayHandle

Represents a platform modal bottom-sheet instance currently shown.

ModalBottomSheetOverlayHost

class ModalBottomSheetOverlayHost(presenter: ModalBottomSheetOverlayPresenter) : SessionBoundSurfaceOverlayHost<ModalBottomSheetOverlaySpec, ModalBottomSheetOverlayContent, ModalBottomSheetOverlayHandle>

Synchronizes declarative bottom sheet overlay requests to the platform presenter and reuses handles for the same entry.

ModalBottomSheetOverlayPresenter

interface ModalBottomSheetOverlayPresenter

Platform-provided bottom sheet presenter responsible for creating the real UI container.

ModalBottomSheetOverlaySpec

class ModalBottomSheetOverlaySpec(val dismissOnBackPress: Boolean = true, val dismissOnClickOutside: Boolean = true, val skipPartiallyExpanded: Boolean = false, val appearance: ModalBottomSheetAppearance, val onDismissRequest: () -> Unit? = null)

Describes platform-neutral behavior for one modal bottom-sheet overlay.

ModalBottomSheetOverrides

data class ModalBottomSheetOverrides(val containerColor: Int? = null, val contentColor: Int? = null, val shape: UiShape? = null, val scrimOpacity: Float? = null, val navigationBarColor: ModalBottomSheetNavigationBarColor? = null)

Selectively replaces modal-bottom-sheet appearance before it crosses the overlay boundary.

NavigationBarDefaults

object NavigationBarDefaults

Resolves NavigationBar appearance from theme tokens and scoped overrides.

NavigationBarOverrides

data class NavigationBarOverrides(val containerColor: Int? = null, val selectedIconColor: Int? = null, val unselectedIconColor: Int? = null, val selectedLabelColor: Int? = null, val unselectedLabelColor: Int? = null, val indicatorColor: Int? = null, val selectedStateLayerColors: UiStateLayerColors? = null, val unselectedStateLayerColors: UiStateLayerColors? = null, val iconSize: UiDp? = null, val labelStyle: UiTextStyle? = null, val badgeColor: Int? = null, val badgeTextColor: Int? = null, val height: UiDp? = null)

Selectively replaces NavigationBar appearance without carrying selection or destination content.

NavigationBarScope

class NavigationBarScope

Item collection scope for NavigationBar.

NodeTypeBindingStats

data class NodeTypeBindingStats(val rebound: Int = 0, val patched: Int = 0, val skipped: Int = 0)

Binding statistics for one node type.

ObservedNodeSpec

class ObservedNodeSpec<S : NodeSpec>

Supplies a complete node-property snapshot for direct transactional patching.

ObservedValue

class ObservedValue<T>

Supplies one typed value whose Snapshot State reads can update a supported node property without recomposing the surrounding declaration.

OverlayEntryId

data class OverlayEntryId(val sessionId: OverlaySessionId, val requestKey: String)

Uniquely identifies one overlay request within a render session.

OverlayHost

interface OverlayHost

Reconciles declarative overlay requests with platform surfaces.

OverlayHostContext

object OverlayHostContext

Exposes the overlay host installed for the current composition.

OverlayHostDefaults

object OverlayHostDefaults

Default platform-independent overlay host implementations.

OverlayRequest

data class OverlayRequest(val key: String, val type: OverlayType, val payload: Any? = null, val contentToken: Any? = null)

Describes one overlay that a render frame wants to keep active.

OverlaySessionId

data class OverlaySessionId(val value: String)

Identifies overlay commits owned by one render session.

OverlaySurfaceContent

class OverlaySurfaceContent

Content snapshot that can render inside an independent overlay surface.

OverlaySurfaceSession

class OverlaySurfaceSession

Independent RenderSession wrapper for an overlay surface.

OverlayType

enum OverlayType : Enum<OverlayType>

Overlay surface and transient-feedback types supported by the core protocol.

PopupAlignment

enum PopupAlignment : Enum<PopupAlignment>

Declares the preferred alignment of a popup relative to its anchor.

PopupBounds

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

Represents rectangular bounds consumed by popup positioning.

PopupOverflowPolicy

enum PopupOverflowPolicy : Enum<PopupOverflowPolicy>

Controls how popup placement is adjusted when it overflows the available viewport.

PopupOverlayContent

data class PopupOverlayContent(val surface: OverlaySurfaceContent)

Holds content that a runtime host can render into a popup-owned surface.

PopupOverlayHandle

interface PopupOverlayHandle

Represents a platform popup instance that can be updated in place or dismissed.

PopupOverlayHost

class PopupOverlayHost(presenter: PopupOverlayPresenter) : SessionBoundSurfaceOverlayHost<PopupOverlaySpec, PopupOverlayContent, PopupOverlayHandle>

Synchronizes popup overlay requests to the platform presenter and filters out non-popup requests.

PopupOverlayPresenter

interface PopupOverlayPresenter

Platform-provided popup presenter that receives declarative specs and content tokens.

PopupOverlaySpec

class PopupOverlaySpec(val anchorId: String, val alignment: PopupAlignment = PopupAlignment.BelowStart, val overflowPolicy: PopupOverflowPolicy = PopupOverflowPolicy.FlipThenClamp, val windowMargin: Int = 0, val dismissOnClickOutside: Boolean = true, val focusable: Boolean = true, val offsetX: Int = 0, val offsetY: Int = 0, val onDismissRequest: () -> Unit? = null)

Describes platform-neutral placement, dismissal, and focus behavior for one popup.

PopupPosition

data class PopupPosition(val x: Int, val y: Int, val resolvedAlignment: PopupAlignment, val wasClamped: Boolean)

Result of resolving one popup placement request.

PopupPositioner

object PopupPositioner

Resolves anchor-relative popup placement, layout direction, offsets, and viewport overflow.

PopupSize

data class PopupSize(val width: Int, val height: Int)

Size of a popup in the positioning coordinate space.

ProduceStateScope

interface ProduceStateScope<T> : CoroutineScope

Writable State scope and coroutine lifetime exposed to a produceState producer.

ProgressIndicatorDefaults

object ProgressIndicatorDefaults

Resolves linear and circular progress appearance from theme tokens and independent overrides.

PullToRefreshDefaults

object PullToRefreshDefaults

Default visual tokens for pull-to-refresh components.

RadioButtonOverrides

data class RadioButtonOverrides(val labelColor: Int? = null, val disabledLabelColor: Int? = null, val checkedColor: Int? = null, val uncheckedColor: Int? = null, val disabledCheckedColor: Int? = null, val disabledUncheckedColor: Int? = null, val textStyle: UiTextStyle? = null, val stateLayerColors: UiStateLayerColors? = null, val minimumHeight: UiDp? = null)

Selectively replaces RadioButton appearance without affecting Checkbox or Switch.

RenderFailure

data class RenderFailure(val frameId: Long?, val phase: RenderFailurePhase, val recovery: RenderFailureRecovery, val cause: Throwable, val operation: RenderFailureOperation? = null, val nodeKey: Any? = null)

Structured record for one render-session failure.

RenderFailureOperation

enum RenderFailureOperation : Enum<RenderFailureOperation>

Native Android-view interoperability operation associated with a failure.

RenderFailurePhase

enum RenderFailurePhase : Enum<RenderFailurePhase>

Stage in the render-session pipeline where an operation failed.

RenderFailureRecovery

enum RenderFailureRecovery : Enum<RenderFailureRecovery>

State guaranteed by the framework after a render failure has been handled.

RenderFrameReport

data class RenderFrameReport(val frameId: Long, val status: RenderFrameStatus, val failures: List<RenderFailure> = emptyList())

Result of one completed synchronous render attempt.

RenderFrameStatus

enum RenderFrameStatus : Enum<RenderFrameStatus>

Final status of one synchronous render attempt.

RenderPatchOperation

enum RenderPatchOperation : Enum<RenderPatchOperation>

Reconciliation operations reported by the renderer.

RenderPatchRecord

data class RenderPatchRecord(val operation: RenderPatchOperation, val type: NodeType, val key: Any?, val parentKey: Any?, val index: Int, val moved: Boolean = false, val detail: String? = null, val toolingMetadata: UiNodeToolingMetadata? = null)

One ordered reconciliation operation applied to the mounted tree.

RenderSession

class RenderSession(container: RenderContainerHandle, content: UiTreeBuilder.() -> Unit, debug: Boolean = false, debugTag: String = "ViewCompose", overlayHost: OverlayHost = OverlayHostDefaults.noOp, onRenderStats: (RenderStats) -> Unit? = null, onRenderResult: (RenderTreeResult) -> Unit? = null, onRenderFailure: (RenderFailure) -> Unit? = null)

Owns composition, rendering, effects, overlays, and cleanup for one renderer container.

RenderSessionFocusManagerFactory

fun interface RenderSessionFocusManagerFactory

Creates the focus adapter associated with one renderer-owned container.

RenderSessionPlatformDiagnostics

interface RenderSessionPlatformDiagnostics

Platform diagnostics used by the composition-to-render session coordinator.

RenderSessionRuntime

interface RenderSessionRuntime

Scheduling policy that coalesces, defers, or immediately runs RenderSession requests.

RenderSessionRuntimeFactory

fun interface RenderSessionRuntimeFactory

Platform factory for creating one scheduling runtime per RenderSession.

RenderSessionSourceRegistration

interface RenderSessionSourceRegistration

Lifecycle handle for a source session registered through RenderSessionSourceTooling.

RenderSessionSourceTooling

interface RenderSessionSourceTooling

Q3 platform adapter for tracking the source and visibility lifetime of nested render sessions.

RenderStats

data class RenderStats(val inserts: Int = 0, val reuses: Int = 0, val removals: Int = 0, val reboundNodes: Int = 0, val patchedNodes: Int = 0, val skippedBindings: Int = 0, val skippedSubtrees: Int = 0, val bindingsByType: Map<NodeType, NodeTypeBindingStats> = emptyMap())

Aggregate renderer binding statistics for one frame.

RenderStructureStats

data class RenderStructureStats(val vnodeCount: Int = 0, val mountedNodeCount: Int = 0, val maxVNodeDepth: Int = 0, val maxMountedDepth: Int = 0)

Size and depth statistics for declarative and mounted trees.

RenderTreeNode

data class RenderTreeNode(val type: NodeType, val key: Any?, val toolingMetadata: UiNodeToolingMetadata? = null, val children: List<RenderTreeNode> = emptyList())

Platform-independent node in a diagnostic render-tree snapshot.

RenderTreeResult

data class RenderTreeResult(val stats: RenderStats = RenderStats(), val structure: RenderStructureStats = RenderStructureStats(), val warnings: List<String> = emptyList(), val tree: List<RenderTreeNode> = emptyList(), val patches: List<RenderPatchRecord> = emptyList(), val composition: CompositionDiagnostics = CompositionDiagnostics())

Complete opt-in diagnostics for one render frame.

RestoredSaveableValue

class RestoredSaveableValue

A reserved restored value that must be committed or released after composition resolves.

RowScope

class RowScope : LayoutScope

Row content scope that exposes horizontal-layout-specific parent-data modifiers.

SaveableStateRegistry

interface SaveableStateRegistry

Coordinates values that survive composition disposal and host recreation.

Saver

class Saver<Original, Saveable>(val save: (Original) -> Saveable, val restore: (Saveable) -> Original)

Converts a state holder or domain value to and from a host-saveable representation.

ScaffoldDefaults

object ScaffoldDefaults

Default container and content colors for scaffold components.

ScrollableScope

class ScrollableScope

Builds nested scrollable content without exposing the outer UiTreeBuilder.

SearchBarDefaults

object SearchBarDefaults

Resolves SearchBar defaults from the current theme.

SegmentedControlDefaults

object SegmentedControlDefaults

Resolves segmented-control appearance from theme tokens and scoped overrides.

SegmentedControlOverrides

data class SegmentedControlOverrides(val containerColor: Int? = null, val disabledContainerColor: Int? = null, val indicatorColor: Int? = null, val disabledIndicatorColor: Int? = null, val contentColor: Int? = null, val disabledContentColor: Int? = null, val selectedContentColor: Int? = null, val disabledSelectedContentColor: Int? = null, val shape: UiShape? = null, val textStyle: UiTextStyle? = null, val unselectedStateLayerColors: UiStateLayerColors? = null, val selectedStateLayerColors: UiStateLayerColors? = null, val minimumHeight: UiDp? = null, val horizontalPadding: UiDp? = null, val verticalPadding: UiDp? = null)

Selectively replaces SegmentedControl appearance resolved by SegmentedControlDefaults.

SegmentedControlSize

enum SegmentedControlSize : Enum<SegmentedControlSize>

Interaction-density tier used to select segmented-control dimensions and typography.

SessionBoundSurfaceOverlayHost

abstract class SessionBoundSurfaceOverlayHost<Spec : Any, Content : Any, Handle>(overlayType: OverlayType, decode: (OverlayRequest) -> Pair<Spec, Content>?) : OverlayHost

Reconciles platform surface handles by session-scoped declarative identity.

SliderOverrides

data class SliderOverrides(val thumbColor: Int? = null, val activeTrackColor: Int? = null, val inactiveTrackColor: Int? = null, val disabledThumbColor: Int? = null, val disabledActiveTrackColor: Int? = null, val disabledInactiveTrackColor: Int? = null, val minimumHeight: UiDp? = null)

Selectively replaces Slider appearance while preserving separate thumb and track roles.

SnackbarDuration

enum SnackbarDuration : Enum<SnackbarDuration>

Defines how long a snackbar presenter keeps an entry visible.

SnackbarOverlayPresenter

interface SnackbarOverlayPresenter

Platform-provided entry point for showing and dismissing snackbars.

SnackbarOverlaySpec

class SnackbarOverlaySpec(val message: String, val actionLabel: String? = null, val duration: SnackbarDuration = SnackbarDuration.Short, val queuePolicy: TransientFeedbackQueuePolicy = TransientFeedbackQueuePolicy.Enqueue, val onAction: () -> Unit? = null, val onDismiss: (TransientFeedbackDismissReason) -> Unit? = null)

Describes snackbar content, duration, callbacks, and queue behavior.

StaticContentRevision

object StaticContentRevision

Explicitly declares that keyed content has no changing ordinary non-State inputs.

SurfaceDefaults

object SurfaceDefaults

Default visual and interaction tokens for surface components.

SurfaceVariant

enum SurfaceVariant : Enum<SurfaceVariant>

Semantic color variants for surface components.

SwitchOverrides

data class SwitchOverrides(val labelColor: Int? = null, val disabledLabelColor: Int? = null, val checkedThumbColor: Int? = null, val uncheckedThumbColor: Int? = null, val disabledCheckedThumbColor: Int? = null, val disabledUncheckedThumbColor: Int? = null, val checkedTrackColor: Int? = null, val uncheckedTrackColor: Int? = null, val disabledCheckedTrackColor: Int? = null, val disabledUncheckedTrackColor: Int? = null, val textStyle: UiTextStyle? = null, val stateLayerColors: UiStateLayerColors? = null, val minimumHeight: UiDp? = null)

Selectively replaces Switch appearance without collapsing thumb and track state roles.

TabRowDefaults

object TabRowDefaults

Resolves TabRow appearance from theme tokens and scoped overrides.

TabRowOverrides

data class TabRowOverrides(val indicatorColor: Int? = null, val indicatorHeight: UiDp? = null, val indicatorCornerRadius: UiDp? = null, val indicatorPosition: TabIndicatorPosition? = null, val indicatorWidthMode: TabIndicatorWidthMode? = null, val indicatorFixedWidth: UiDp? = null, val containerColor: Int? = null, val scrollable: Boolean? = null, val equalWidth: Boolean? = null, val unselectedStateLayerColors: UiStateLayerColors? = null, val selectedStateLayerColors: UiStateLayerColors? = null, val itemSpacing: UiDp? = null, val itemPaddingHorizontal: UiDp? = null, val itemPaddingVertical: UiDp? = null, val minimumItemWidth: UiDp? = null)

Selectively replaces TabRow appearance and visual layout policy.

TabRowScope

class TabRowScope

Declares eager keyed tab children in the parent composition.

TextDefaults

object TextDefaults

Resolves default typography and color values for text components.

TextFieldDefaults

object TextFieldDefaults

Resolves TextField appearance from the current theme and scoped TextFieldOverrides.

TextFieldInputProfile

data class TextFieldInputProfile(val keyboardOptions: TextFieldKeyboardOptions = TextFieldKeyboardOptions(), val autofillHints: Set<TextFieldAutofillHint> = emptySet())

Couples keyboard and autofill semantics for one TextField input purpose.

TextFieldLinePolicy

sealed interface TextFieldLinePolicy

Defines the visual-line policy for a high-level TextField.

TextFieldOverrides

data class TextFieldOverrides(val containerColor: Int? = null, val disabledContainerColor: Int? = null, val errorContainerColor: Int? = null, val textColor: Int? = null, val disabledTextColor: Int? = null, val errorTextColor: Int? = null, val placeholderColor: Int? = null, val disabledPlaceholderColor: Int? = null, val errorPlaceholderColor: Int? = null, val labelColor: Int? = null, val disabledLabelColor: Int? = null, val errorLabelColor: Int? = null, val supportingTextColor: Int? = null, val disabledSupportingTextColor: Int? = null, val errorSupportingTextColor: Int? = null, val borderColor: Int? = null, val disabledBorderColor: Int? = null, val errorBorderColor: Int? = null, val borderWidth: UiDp? = null, val cursorColor: Int? = null, val shape: UiShape? = null, val textStyle: UiTextStyle? = null, val labelTextStyle: UiTextStyle? = null, val supportingTextStyle: UiTextStyle? = null, val minimumHeight: UiDp? = null, val horizontalPadding: UiDp? = null, val verticalPadding: UiDp? = null)

Selectively replaces low-frequency appearance values resolved by TextField.

TextFieldSize

enum TextFieldSize : Enum<TextFieldSize>

Interaction-density tier used to select TextField dimensions and typography.

TextFieldVariant

enum TextFieldVariant : Enum<TextFieldVariant>

Visual treatment used to select TextField container and border defaults.

TextStyle

object TextStyle

Exposes the default text style for the current composition scope.

Theme

object Theme

Exposes the immutable theme snapshot and its token families for the current composition.

ToastDuration

enum ToastDuration : Enum<ToastDuration>

Defines how long a toast presenter keeps an entry visible.

ToastOverlayPresenter

interface ToastOverlayPresenter

Platform-provided entry point for showing and dismissing toasts.

ToastOverlaySpec

class ToastOverlaySpec(val message: String, val duration: ToastDuration = ToastDuration.Short, val queuePolicy: TransientFeedbackQueuePolicy = TransientFeedbackQueuePolicy.Enqueue, val onDismiss: (TransientFeedbackDismissReason) -> Unit? = null)

Describes toast content, duration, callback, and queue behavior.

TooltipDefaults

object TooltipDefaults

Default visual and spacing tokens for plain tooltips.

TopAppBarDefaults

object TopAppBarDefaults

Default visual, typography, and size tokens for top app bars.

TopAppBarOverrides

data class TopAppBarOverrides(val containerColor: Int? = null, val titleColor: Int? = null, val navigationIconColor: Int? = null, val actionIconColor: Int? = null, val titleStyle: UiTextStyle? = null, val height: UiDp? = null, val horizontalPadding: UiDp? = null, val titleStartPadding: UiDp? = null)

Selectively replaces TopAppBar appearance and visual spacing.

TransientFeedbackDismissReason

enum TransientFeedbackDismissReason : Enum<TransientFeedbackDismissReason>

Identifies why a transient-feedback entry stopped being visible or was never shown.

TransientFeedbackOverlayHost

class TransientFeedbackOverlayHost(snackbarPresenter: SnackbarOverlayPresenter, toastPresenter: ToastOverlayPresenter) : OverlayHost

Manages snackbar/toast queueing, replacement, and clearing while delegating final presentation to platform presenters.

TransientFeedbackQueuePolicy

enum TransientFeedbackQueuePolicy : Enum<TransientFeedbackQueuePolicy>

Controls how a transient-feedback request interacts with active and pending entries.

TransientFeedbackQueueSnapshot

data class TransientFeedbackQueueSnapshot(val active: OverlayEntryId?, val pending: List<OverlayEntryId>, val consumed: Set<OverlayEntryId>)

Immutable diagnostic snapshot of a transient-feedback queue.

TypographyTier

enum TypographyTier : Enum<TypographyTier>

Semantic size tiers used to select typography tokens.

UiAppBarSizing

data class UiAppBarSizing(val topHeight: UiDp, val topHorizontalPadding: UiDp, val topTitleStartPadding: UiDp, val bottomHeight: UiDp, val bottomHorizontalPadding: UiDp, val bottomElevation: UiDp)

Defines top and bottom app-bar dimensions.

UiBadgeSizing

data class UiBadgeSizing(val dotSize: UiDp, val pillHeight: UiDp, val pillMinWidth: UiDp, val pillHorizontalPadding: UiDp)

Defines dot and labeled badge dimensions.

UiButtonSizing

data class UiButtonSizing(val compactHeight: UiDp, val mediumHeight: UiDp, val largeHeight: UiDp, val compactHorizontalPadding: UiDp, val mediumHorizontalPadding: UiDp, val largeHorizontalPadding: UiDp, val compactVerticalPadding: UiDp, val mediumVerticalPadding: UiDp, val largeVerticalPadding: UiDp, val compactVisualHeight: UiDp = compactHeight, val mediumVisualHeight: UiDp = mediumHeight, val largeVisualHeight: UiDp = largeHeight)

Defines effective target and visible-container dimensions for each Button size tier.

UiChipSizing

data class UiChipSizing(val height: UiDp, val horizontalPadding: UiDp, val leadingIconPadding: UiDp, val iconSize: UiDp, val trailingIconSize: UiDp, val iconSpacing: UiDp)

Defines dimensions for compact labeled chips.

UiColors

data class UiColors(val background: Int, val onBackground: Int = contentColorFor(background), val surface: Int, val surfaceVariant: Int, val surfaceDim: Int = surface, val surfaceBright: Int = surface, val surfaceContainerLowest: Int = background, val surfaceContainerLow: Int = surface, val surfaceContainer: Int = surface, val surfaceContainerHigh: Int = surfaceVariant, val surfaceContainerHighest: Int = surfaceVariant, val onSurface: Int, val onSurfaceVariant: Int, val primary: Int, val onPrimary: Int = contentColorFor(primary), val primaryContainer: Int = primary, val onPrimaryContainer: Int = contentColorFor(primaryContainer), val secondary: Int, val onSecondary: Int = contentColorFor(secondary), val secondaryContainer: Int = secondary, val onSecondaryContainer: Int = contentColorFor(secondaryContainer), val tertiary: Int = secondary, val onTertiary: Int = contentColorFor(tertiary), val tertiaryContainer: Int = tertiary, val onTertiaryContainer: Int = contentColorFor(tertiaryContainer), val error: Int, val onError: Int = contentColorFor(error), val errorContainer: Int = error, val onErrorContainer: Int = contentColorFor(errorContainer), val success: Int, val warning: Int, val info: Int, val outline: Int, val outlineVariant: Int = outline, val surfaceTint: Int = primary, val inverseSurface: Int = onSurface, val inverseOnSurface: Int = background, val inversePrimary: Int = primary, val scrim: Int = 0xFF000000.toInt())

Stores the complete semantic color scheme as packed ARGB integers.

UiComponentAttribution

data class UiComponentAttribution(val familyId: String, val recipeId: String, val backend: UiComponentBackend, val conformance: UiDesignConformance, val capabilityPath: String, val fallback: String = "none")

Immutable diagnostic attribution for one design-system component family.

UiComponentBackend

enum UiComponentBackend : Enum<UiComponentBackend>

Selects the design-system-neutral execution strategy behind a component recipe.

UiControlSizeDefaults

object UiControlSizeDefaults

Creates the framework baseline core component dimensions.

UiControlSizing

data class UiControlSizing(val button: UiButtonSizing, val textField: UiTextFieldSizing, val segmentedControl: UiSegmentedControlSizing, val progressIndicator: UiProgressIndicatorSizing, val fab: UiFabSizing = UiFabSizing.default(), val chip: UiChipSizing = UiChipSizing.default(), val searchBar: UiSearchBarSizing = UiSearchBarSizing.default(), val navigationBar: UiNavigationBarSizing = UiNavigationBarSizing.default(), val appBar: UiAppBarSizing = UiAppBarSizing.default(), val listItem: UiListItemSizing = UiListItemSizing.default(), val menu: UiMenuSizing = UiMenuSizing.default(), val tooltip: UiTooltipSizing = UiTooltipSizing.default(), val badge: UiBadgeSizing = UiBadgeSizing.default(), val switch: UiSwitchSizing = UiSwitchSizing.default(), val minimumInteractiveHeight: UiDp = UiDp.Zero)

Aggregates all core component sizing token families.

UiDesignConformance

enum UiDesignConformance : Enum<UiDesignConformance>

Reports the accepted fidelity result for one component recipe and capability path.

UiDesignSystemAttribution

data class UiDesignSystemAttribution(val designSystemId: String, val recipeSetId: String, val components: List<UiComponentAttribution>, val integrations: List<UiIntegrationAttribution> = emptyList())

Immutable identity and component-attribution snapshot for one active design-system scope.

UiDslMarker

@DslMarker

annotation class UiDslMarker

DSL marker that limits receiver visibility in nested widget DSL scopes.

UiEnvironmentDefaults

object UiEnvironmentDefaults

Supplies deterministic environment defaults when no platform configuration is available.

UiFabSizing

data class UiFabSizing(val smallSize: UiDp, val mediumSize: UiDp, val largeSize: UiDp, val smallIconSize: UiDp, val mediumIconSize: UiDp, val largeIconSize: UiDp, val elevation: UiDp, val extendedHeight: UiDp, val extendedHorizontalPadding: UiDp, val extendedIconSpacing: UiDp)

Defines dimensions and elevation for floating action buttons.

UiIntegrationAttribution

data class UiIntegrationAttribution(val capabilityId: String, val transportId: String, val presenterId: String, val conformance: UiDesignConformance, val fallback: String = "none")

Immutable diagnostic attribution for one platform or library integration capability.

UiInteractionTokens

data class UiInteractionTokens(val pressedStateLayerOpacity: Float, val focusedStateLayerOpacity: Float = pressedStateLayerOpacity, val hoveredStateLayerOpacity: Float = focusedStateLayerOpacity)

Defines design-system-neutral opacity policy for transient component state layers.

UiListItemSizing

data class UiListItemSizing(val minHeight: UiDp, val horizontalPadding: UiDp, val verticalPadding: UiDp, val leadingTrailingSpacing: UiDp, val textSpacing: UiDp)

Defines list-item content spacing and minimum height.

UiLocal

class UiLocal<T>

Application-facing handle for a typed, thread-scoped ViewCompose local value.

UiLocalProvider

class UiLocalProvider

One pending local/value binding used by ProvideLocals for batch installation.

UiLocals

object UiLocals

Reads typed local values from the current thread-scoped composition context.

UiLocalSnapshot

class UiLocalSnapshot

Opaque snapshot of every active ViewCompose local.

UiMenuSizing

data class UiMenuSizing(val elevation: UiDp, val minWidth: UiDp, val verticalPadding: UiDp, val itemHeight: UiDp, val itemHorizontalPadding: UiDp, val iconSize: UiDp, val iconToTextSpacing: UiDp)

Defines menu surface, item, and icon dimensions.

UiNavigationBarSizing

data class UiNavigationBarSizing(val height: UiDp, val iconSize: UiDp, val labelSizeSp: UiSp)

Defines bottom navigation-bar dimensions.

UiOverlayDefaults

object UiOverlayDefaults

Creates the framework baseline modal overlay tokens.

UiOverlays

data class UiOverlays(val scrimOpacity: Float)

Defines visual tokens shared by modal overlays.

UiProgressIndicatorSizing

data class UiProgressIndicatorSizing(val linearTrackThickness: UiDp, val circularSize: UiDp, val circularTrackThickness: UiDp)

Defines dimensions shared by linear and circular progress indicators.

UiSearchBarSizing

data class UiSearchBarSizing(val height: UiDp, val horizontalPadding: UiDp, val iconSize: UiDp, val iconSpacing: UiDp, val elevation: UiDp)

Defines search-bar dimensions and resting elevation.

UiSegmentedControlSizing

data class UiSegmentedControlSizing(val compactHeight: UiDp, val mediumHeight: UiDp, val largeHeight: UiDp, val compactHorizontalPadding: UiDp, val mediumHorizontalPadding: UiDp, val largeHorizontalPadding: UiDp, val compactVerticalPadding: UiDp, val mediumVerticalPadding: UiDp, val largeVerticalPadding: UiDp)

Defines compact, medium, and large segmented-control dimensions.

UiShapeDefaults

object UiShapeDefaults

Creates the framework baseline component shape tiers.

UiShapes

data class UiShapes(val small: UiShape, val medium: UiShape, val large: UiShape = medium, val extraSmall: UiShape = small, val extraLarge: UiShape = large, val full: UiShape = UiShape.roundedRelative(0.5f))

Defines the complete semantic corner scale available to component defaults.

UiStateColor

data class UiStateColor(val defaultColor: Int, val disabledColor: Int = defaultColor, val pressedColor: Int = defaultColor, val focusedColor: Int = pressedColor, val checkedColor: Int = defaultColor, val selectedColor: Int = checkedColor)

Stores one semantic color across enabled and interactive states.

UiStateColorDefaults

object UiStateColorDefaults

Derives framework state-color roles from a semantic UiColors scheme.

UiStateColors

data class UiStateColors(val primaryText: UiStateColor, val secondaryText: UiStateColor, val control: UiStateColor, val controlActivated: UiStateColor)

Groups state-aware colors commonly consumed by component defaults.

UiSwitchSizing

data class UiSwitchSizing(val trackWidth: UiDp, val trackHeight: UiDp, val thumbDiameter: UiDp, val trackPadding: UiDp, val labelSpacing: UiDp)

Defines the visible geometry of a design-owned Switch composite.

UiTextFieldSizing

data class UiTextFieldSizing(val compactHeight: UiDp, val mediumHeight: UiDp, val largeHeight: UiDp, val compactHorizontalPadding: UiDp, val mediumHorizontalPadding: UiDp, val largeHorizontalPadding: UiDp, val compactVerticalPadding: UiDp, val mediumVerticalPadding: UiDp, val largeVerticalPadding: UiDp)

Defines compact, medium, and large text-field dimensions.

UiTextStyle

data class UiTextStyle(val fontSizeSp: UiSp, val fontWeight: Int? = null, val fontFamily: Typeface? = null, val letterSpacingEm: Float? = null, val lineHeightSp: UiSp? = null, val includeFontPadding: Boolean = false, val textDecoration: TextDecoration? = null)

Defines an Android-rendered text style independent from a particular widget.

UiThemeDefaults

object UiThemeDefaults

Creates complete built-in light and dark theme snapshots without reading Android resources.

UiThemeMetadata

data class UiThemeMetadata(val origin: UiThemeOrigin = UiThemeOrigin.Custom, val isDark: Boolean? = null, val revision: Long = 0, val provenance: UiTokenProvenance = UiTokenProvenance( sourceId = origin.name, defaultOrigin = origin, ))

Carries non-visual theme diagnostics without affecting token resolution.

UiThemeOrigin

enum UiThemeOrigin : Enum<UiThemeOrigin>

Identifies the source that produced a theme snapshot for diagnostics and host bridging.

UiThemeTokens

data class UiThemeTokens(val colors: UiColors, val typography: UiTypography, val stateColors: UiStateColors = UiStateColorDefaults.from(colors), val shapes: UiShapes = UiShapeDefaults.default(), val controls: UiControlSizing = UiControlSizeDefaults.default(), val interactions: UiInteractionTokens = defaultInteractionTokens(), val overlays: UiOverlays = UiOverlayDefaults.default(), val metadata: UiThemeMetadata = UiThemeMetadata())

Immutable theme snapshot consumed by component defaults and renderers.

UiTokenProvenance

data class UiTokenProvenance(val sourceId: String, val defaultOrigin: UiThemeOrigin, val tokenOrigins: Map<String, UiThemeOrigin> = emptyMap())

Describes where effective token values originated without changing visual resolution.

UiTooltipSizing

data class UiTooltipSizing(val horizontalPadding: UiDp, val verticalPadding: UiDp)

Defines padding inside a tooltip surface.

UiTreeBuilder

open class UiTreeBuilder

ViewCompose declarative tree builder that collects widget DSL calls into platform-neutral VNode lists.

UiTypography

data class UiTypography(val titleMedium: UiTextStyle, val bodyMedium: UiTextStyle, val labelMedium: UiTextStyle, val titleLarge: UiTextStyle = titleMedium, val titleSmall: UiTextStyle = titleMedium, val bodyLarge: UiTextStyle = bodyMedium, val bodySmall: UiTextStyle = bodyMedium, val labelLarge: UiTextStyle = labelMedium, val labelSmall: UiTextStyle = labelMedium, val headlineLarge: UiTextStyle = titleLarge, val headlineMedium: UiTextStyle = titleMedium, val headlineSmall: UiTextStyle = titleSmall, val displayLarge: UiTextStyle = headlineLarge, val displayMedium: UiTextStyle = headlineMedium, val displaySmall: UiTextStyle = headlineSmall)

Groups display, headline, title, body, and label typography at three semantic tiers.

UiWidgetCore

object UiWidgetCore

Widget layer marker for declarative core widget capabilities and dependency-chain identification.

Properties

LocalContentColor

val LocalContentColor: UiLocal<Int>

Default semantic content color inherited by text and icon components.

LocalDensity

val LocalDensity: UiLocal<UiDensity>

The current density. Kept separate from locale and direction so scoped overrides are explicit.

LocalLayoutDirection

val LocalLayoutDirection: UiLocal<UiLayoutDirection>

Current logical layout direction used to resolve start and end edges.

LocalLocales

val LocalLocales: UiLocal<UiLocaleList>

Current ordered locale preferences for resource and formatting decisions.

LocalRenderResultListener

val LocalRenderResultListener: UiLocal<(RenderTreeResult) -> Unit?>

Optional callback propagated through locals so child render sessions (lazy/pager/overlay session hosts) can report render diagnostics.

LocalResourceRevision

val LocalResourceRevision: UiLocal<Long>

Current host-scoped resource invalidation identity.

LocalTextStyle

val LocalTextStyle: UiLocal<UiTextStyle>

Default text style inherited by text-bearing components.

Functions

AlertDialog

fun UiTreeBuilder.AlertDialog(visible: Boolean, title: String, text: String, confirmButtonText: String, onConfirm: () -> Unit, dismissButtonText: String? = null, onDismiss: () -> Unit? = null, icon: ImageSource? = null, overrides: AlertDialogOverrides = AlertDialogOverrides.None, requestKey: String = "alert_dialog", dismissOnBackPress: Boolean = true, dismissOnClickOutside: Boolean = true, onDismissRequest: () -> Unit? = null)

Emits a standard confirmation dialog composite.

autoSaver

fun <T> autoSaver(): Saver<T, Any?>

Returns the default saver for host-compatible values and MutableState.

Badge

fun UiTreeBuilder.Badge(count: Int? = null, overrides: BadgeOverrides = BadgeOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Emits a dot or labeled badge using one resolved appearance snapshot.

BadgedBox

fun UiTreeBuilder.BadgedBox(badge: UiTreeBuilder.() -> Unit, key: Any? = null, modifier: Modifier = Modifier, content: BoxScope.() -> Unit)

Overlays badge content at the logical top-end corner of primary content.

BasicButton

fun UiTreeBuilder.BasicButton(text: String, onClick: () -> Unit?, style: BasicButtonStyle, enabled: Boolean = true, leadingIcon: ImageSource? = null, trailingIcon: ImageSource? = null, key: Any? = null, modifier: Modifier = Modifier)

Emits a design-system-neutral text action composed from BasicSurface, Row, Text, and Icon.

BasicSurface

fun UiTreeBuilder.BasicSurface(style: BasicSurfaceStyle, contentColor: Int, enabled: Boolean = true, onClick: () -> Unit? = null, minimumWidth: UiDp = UiDp.Zero, minimumHeight: UiDp = UiDp.Zero, visualHeight: UiDp? = null, role: SemanticsRole? = null, key: Any? = null, contentAlignment: BoxAlignment = BoxAlignment.TopStart, modifier: Modifier = Modifier, content: BoxScope.() -> Unit)

Emits a design-system-neutral surface from fully resolved visual and interaction values.

BasicTextField

fun UiTreeBuilder.BasicTextField(state: TextFieldState, style: BasicTextFieldStyle, hint: String = "", placeholder: String = hint, enabled: Boolean = true, singleLine: Boolean = true, readOnly: Boolean = false, maxLines: Int = if (singleLine) 1 else Int.MAX_VALUE, minLines: Int = if (singleLine) 1 else 1, keyboardOptions: TextFieldKeyboardOptions = TextFieldKeyboardOptions(), inputTransformation: InputTransformation? = null, receiveContent: ReceiveContentConfiguration = ReceiveContentConfiguration.Default, onKeyboardAction: (TextFieldImeAction) -> Boolean? = null, onFocusChange: (Boolean) -> Unit? = null, autofillHints: Set<TextFieldAutofillHint> = emptySet(), key: Any? = null, modifier: Modifier = Modifier)

Emits the low-level text input node without outer label or supporting text.

BottomAppBar

fun UiTreeBuilder.BottomAppBar(overrides: BottomAppBarOverrides = BottomAppBarOverrides.None, key: Any? = null, modifier: Modifier = Modifier, content: RowScope.() -> Unit)

Emits a bottom app bar and provides its resolved content role to descendants.

Box

fun UiTreeBuilder.Box(key: Any? = null, contentAlignment: BoxAlignment = BoxAlignment.TopStart, modifier: Modifier = Modifier, content: BoxScope.() -> Unit)

Overlays children in one layout container without adding interaction behavior.

buildVNodeTree

fun buildVNodeTree(content: UiTreeBuilder.() -> Unit): List<VNode>

Builds one VNode tree without requiring a host session.

Button

fun UiTreeBuilder.Button(text: String, onClick: () -> Unit? = null, leadingIcon: ImageSource.Resource? = null, trailingIcon: ImageSource.Resource? = null, variant: ButtonVariant = ButtonVariant.Primary, size: ButtonSize = ButtonSize.Medium, enabled: Boolean = true, overrides: ButtonOverrides = ButtonOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Displays a themed text action and invokes onClick for an accepted enabled click.

captureUiLocalSnapshot

fun captureUiLocalSnapshot(): UiLocalSnapshot

Captures currently active ViewCompose locals.

Card

fun UiTreeBuilder.Card(onClick: () -> Unit? = null, variant: CardVariant = CardVariant.Filled, enabled: Boolean = true, key: Any? = null, modifier: Modifier = Modifier, content: BoxScope.() -> Unit)

Creates a themed card whose variant selects fill, border, and elevation roles.

Checkbox

fun UiTreeBuilder.Checkbox(text: String, checked: Boolean, onCheckedChange: (Boolean) -> Unit, enabled: Boolean = true, overrides: CheckboxOverrides = CheckboxOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Displays a labeled checkbox and reports accepted checked-state changes.

Chip

fun UiTreeBuilder.Chip(label: String, onClick: () -> Unit, variant: ChipVariant = ChipVariant.Assist, selected: Boolean = false, leadingIcon: ImageSource? = null, onTrailingIconClick: () -> Unit? = null, enabled: Boolean = true, key: Any? = null, modifier: Modifier = Modifier)

Creates a compact themed action with optional selected and icon regions.

CircularProgressIndicator

fun UiTreeBuilder.CircularProgressIndicator(progress: Float? = null, overrides: CircularProgressIndicatorOverrides = CircularProgressIndicatorOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Emits a circular determinate or indeterminate progress indicator.

Column

fun UiTreeBuilder.Column(key: Any? = null, spacing: UiDp = UiDp.Zero, arrangement: MainAxisArrangement = MainAxisArrangement.Start, horizontalAlignment: HorizontalAlignment = HorizontalAlignment.Start, modifier: Modifier = Modifier, content: ColumnScope.() -> Unit)

Places eager children along a vertical main axis.

createOverlaySurfaceSession

fun createOverlaySurfaceSession(container: RenderContainerHandle, content: OverlaySurfaceContent): OverlaySurfaceSession

Creates an independent surface session for a platform overlay container.

createSaveableStateRegistry

fun createSaveableStateRegistry(restoredValues: Map<String, Any?> = emptyMap(), canBeSaved: (Any?) -> Boolean = { true }): SaveableStateRegistry

Creates the thread-safe default SaveableStateRegistry.

DesignSystemAttributionProvider

fun UiTreeBuilder.DesignSystemAttributionProvider(attribution: UiDesignSystemAttribution, content: UiTreeBuilder.() -> Unit)

Provides one bounded design-system diagnostic snapshot while building content.

Dialog

fun UiTreeBuilder.Dialog(visible: Boolean, requestKey: String = "dialog", dismissOnBackPress: Boolean = true, dismissOnClickOutside: Boolean = true, position: DialogPosition = DialogPosition.Center, scrimOpacity: Float = Theme.overlays.scrimOpacity, onDismissRequest: () -> Unit? = null, content: UiTreeBuilder.() -> Unit)

Submits custom DSL content as a keyed modal dialog overlay.

DisposableEffect

fun ~~DisposableEffect~~(effect: DisposableEffectScope.() -> DisposableEffectResult)

Rejects a disposable effect without an explicit lifecycle identity.

fun DisposableEffect(key1: Any?, effect: DisposableEffectScope.() -> DisposableEffectResult)

Starts cleanup-aware synchronous work after a successful frame commits.

fun DisposableEffect(vararg keys: Any?, effect: DisposableEffectScope.() -> DisposableEffectResult)

Starts cleanup-aware work identified by a non-empty structural key list.

fun DisposableEffect(key1: Any?, key2: Any?, effect: DisposableEffectScope.() -> DisposableEffectResult)

Starts cleanup-aware work identified by two structural keys.

fun DisposableEffect(key1: Any?, key2: Any?, key3: Any?, effect: DisposableEffectScope.() -> DisposableEffectResult)

Starts cleanup-aware work identified by three structural keys.

Divider

fun UiTreeBuilder.Divider(color: Int = DividerDefaults.color(), thickness: UiDp = DividerDefaults.thickness(), key: Any? = null, modifier: Modifier = Modifier)

Draws a solid divider with a theme-resolved default thickness.

DropdownMenu

fun UiTreeBuilder.DropdownMenu(expanded: Boolean, anchorId: String, onDismissRequest: () -> Unit, alignment: PopupAlignment = PopupAlignment.BelowStart, overflowPolicy: PopupOverflowPolicy = PopupOverflowPolicy.FlipThenClamp, windowMargin: UiDp = 8.dp, requestKey: String = "dropdown_menu", modifier: Modifier = Modifier, content: ColumnScope.() -> Unit)

Shows themed menu content in a focusable popup anchored to anchorId.

DropdownMenuItem

fun UiTreeBuilder.DropdownMenuItem(text: String, onClick: () -> Unit, leadingIcon: ImageSource? = null, trailingText: String? = null, enabled: Boolean = true, modifier: Modifier = Modifier)

Creates one full-width action row for a dropdown menu.

ExtendedFloatingActionButton

fun UiTreeBuilder.ExtendedFloatingActionButton(text: String, onClick: () -> Unit, icon: ImageSource? = null, overrides: ExtendedFloatingActionButtonOverrides = ExtendedFloatingActionButtonOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Emits an extended floating action button with a label and optional icon.

FloatingActionButton

fun UiTreeBuilder.FloatingActionButton(onClick: () -> Unit, size: FabSize = FabSize.Medium, overrides: FloatingActionButtonOverrides = FloatingActionButtonOverrides.None, key: Any? = null, modifier: Modifier = Modifier, content: UiTreeBuilder.() -> Unit)

Emits a semantic floating action button with a caller-owned content slot.

FlowColumn

fun UiTreeBuilder.FlowColumn(key: Any? = null, horizontalSpacing: UiDp = UiDp.Zero, verticalSpacing: UiDp = UiDp.Zero, maxItemsInEachColumn: Int = Int.MAX_VALUE, modifier: Modifier = Modifier, content: LayoutScope.() -> Unit)

Places eager children top-to-bottom and wraps them into additional columns.

FlowRow

fun UiTreeBuilder.FlowRow(key: Any? = null, horizontalSpacing: UiDp = UiDp.Zero, verticalSpacing: UiDp = UiDp.Zero, maxItemsInEachRow: Int = Int.MAX_VALUE, modifier: Modifier = Modifier, content: LayoutScope.() -> Unit)

Places eager children left-to-right and wraps them into additional rows.

HorizontalPager

fun UiTreeBuilder.HorizontalPager(currentPage: Int, onPageChanged: (Int) -> Unit, pagerState: PagerState? = null, offscreenPageLimit: Int = -1, userScrollEnabled: Boolean = true, reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), key: Any? = null, modifier: Modifier = Modifier, pages: HorizontalPagerScope.() -> Unit)

Emits a horizontal pager with one keyed lazy session per page.

Icon

fun UiTreeBuilder.Icon(source: ImageSource?, contentDescription: String? = null, tint: Int = IconDefaults.tint(), size: UiDp = IconDefaults.size(), requestOptions: UiImageRequestOptions = UiImageRequestOptions(), key: Any? = null, modifier: Modifier = Modifier)

Emits fixed-size icon content using the current content color and image loader.

IconButton

fun UiTreeBuilder.IconButton(icon: ImageSource?, contentDescription: String? = null, onClick: () -> Unit? = null, variant: ButtonVariant = ButtonVariant.Text, size: ButtonSize = ButtonSize.Medium, requestOptions: UiImageRequestOptions = UiImageRequestOptions(), enabled: Boolean = true, overrides: IconButtonOverrides = IconButtonOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Emits an icon-only button whose image uses the current scoped loader.

Image

fun UiTreeBuilder.Image(source: ImageSource?, contentDescription: String? = null, contentScale: ImageContentScale = ImageContentScale.Fit, tint: Int? = null, placeholder: ImageSource.Resource? = null, error: ImageSource.Resource? = placeholder, fallback: ImageSource.Resource? = placeholder, requestOptions: UiImageRequestOptions = UiImageRequestOptions(), key: Any? = null, modifier: Modifier = Modifier)

Emits image content backed by a resource or the current scoped image loader.

installRenderSessionPlatform

fun installRenderSessionPlatform(renderEngine: CoreRenderEngine, coroutineContext: CoroutineContext, runtimeFactory: RenderSessionRuntimeFactory, focusManagerFactory: RenderSessionFocusManagerFactory, diagnostics: RenderSessionPlatformDiagnostics)

Atomically installs the platform capabilities required by every RenderSession.

key

fun <T> key(vararg keys: Any?, block: () -> T): T

Declares stable identity for a composition subtree so state follows business keys instead of call-order reuse.

LaunchedEffect

fun ~~LaunchedEffect~~(block: suspend CoroutineScope.() -> Unit)

Rejects a launched effect without an explicit lifecycle identity.

fun LaunchedEffect(key1: Any?, block: suspend CoroutineScope.() -> Unit)

Launches composition-owned suspending work after a successful commit.

fun LaunchedEffect(vararg keys: Any?, block: suspend CoroutineScope.() -> Unit)

Launches composition-owned work identified by a non-empty structural key list.

fun LaunchedEffect(key1: Any?, key2: Any?, block: suspend CoroutineScope.() -> Unit)

Launches composition-owned work identified by two structural keys.

fun LaunchedEffect(key1: Any?, key2: Any?, key3: Any?, block: suspend CoroutineScope.() -> Unit)

Launches composition-owned work identified by three structural keys.

LazyColumn

fun UiTreeBuilder.LazyColumn(contentPadding: LazyContentPadding = LazyContentPadding.None, spacing: UiDp = UiDp.Zero, state: LazyListState? = null, reverseLayout: Boolean = false, userScrollEnabled: Boolean = true, prefetchPolicy: LazyLayoutPrefetchPolicy = LazyLayoutPrefetchPolicy(), reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), focusFollowKeyboard: Boolean = false, modifier: Modifier = Modifier, content: LazyListScope.() -> Unit)

Virtualizes scoped vertical items while preserving captured locals per active item session.

fun <T> UiTreeBuilder.LazyColumn(items: LazyItemsSnapshot<T>, key: (T) -> Any, contentType: (T) -> Any? = { null }, contentRevision: (T) -> Any? = { it }, contentPadding: UiDp = UiDp.Zero, spacing: UiDp = UiDp.Zero, state: LazyListState? = null, reverseLayout: Boolean = false, userScrollEnabled: Boolean = true, prefetchPolicy: LazyLayoutPrefetchPolicy = LazyLayoutPrefetchPolicy(), reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), focusFollowKeyboard: Boolean = false, modifier: Modifier = Modifier, itemContent: UiTreeBuilder.(T) -> Unit)

Virtualizes a copied item snapshot with a bounded whole-table reuse path.

fun <T> UiTreeBuilder.LazyColumn(items: List<T>, key: (T) -> Any, contentType: (T) -> Any? = { null }, contentRevision: (T) -> Any? = { it }, contentPadding: UiDp = UiDp.Zero, spacing: UiDp = UiDp.Zero, state: LazyListState? = null, reverseLayout: Boolean = false, userScrollEnabled: Boolean = true, prefetchPolicy: LazyLayoutPrefetchPolicy = LazyLayoutPrefetchPolicy(), reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), focusFollowKeyboard: Boolean = false, modifier: Modifier = Modifier, itemContent: UiTreeBuilder.(T) -> Unit)

Virtualizes vertical list data with explicit logical identity and revision contracts.

LazyRow

fun UiTreeBuilder.LazyRow(contentPadding: LazyContentPadding = LazyContentPadding.None, spacing: UiDp = UiDp.Zero, state: LazyListState? = null, reverseLayout: Boolean = false, userScrollEnabled: Boolean = true, prefetchPolicy: LazyLayoutPrefetchPolicy = LazyLayoutPrefetchPolicy(), reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), modifier: Modifier = Modifier, content: LazyListScope.() -> Unit)

Virtualizes scoped horizontal items while preserving captured locals per active item session.

fun <T> UiTreeBuilder.LazyRow(items: LazyItemsSnapshot<T>, key: (T) -> Any, contentType: (T) -> Any? = { null }, contentRevision: (T) -> Any? = { it }, contentPadding: UiDp = UiDp.Zero, spacing: UiDp = UiDp.Zero, state: LazyListState? = null, reverseLayout: Boolean = false, userScrollEnabled: Boolean = true, prefetchPolicy: LazyLayoutPrefetchPolicy = LazyLayoutPrefetchPolicy(), reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), modifier: Modifier = Modifier, itemContent: UiTreeBuilder.(T) -> Unit)

Virtualizes a copied horizontal item snapshot with bounded whole-table reuse.

fun <T> UiTreeBuilder.LazyRow(items: List<T>, key: (T) -> Any, contentType: (T) -> Any? = { null }, contentRevision: (T) -> Any? = { it }, contentPadding: UiDp = UiDp.Zero, spacing: UiDp = UiDp.Zero, state: LazyListState? = null, reverseLayout: Boolean = false, userScrollEnabled: Boolean = true, prefetchPolicy: LazyLayoutPrefetchPolicy = LazyLayoutPrefetchPolicy(), reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), modifier: Modifier = Modifier, itemContent: UiTreeBuilder.(T) -> Unit)

Virtualizes horizontal list data with explicit logical identity and revision contracts.

LazyVerticalGrid

fun UiTreeBuilder.LazyVerticalGrid(cells: GridCells = GridCells.Fixed(2), contentPadding: LazyContentPadding = LazyContentPadding.None, horizontalSpacing: UiDp = UiDp.Zero, verticalSpacing: UiDp = UiDp.Zero, state: LazyListState? = null, reverseLayout: Boolean = false, userScrollEnabled: Boolean = true, prefetchPolicy: LazyLayoutPrefetchPolicy = LazyLayoutPrefetchPolicy(), reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), focusFollowKeyboard: Boolean = false, modifier: Modifier = Modifier, content: LazyGridScope.() -> Unit)

Emits a virtualized vertical grid from explicitly keyed LazyGridScope entries.

fun <T> UiTreeBuilder.LazyVerticalGrid(items: LazyItemsSnapshot<T>, cells: GridCells = GridCells.Fixed(2), key: (T) -> Any, contentType: (T) -> Any? = { null }, contentRevision: (T) -> Any? = { it }, span: (T) -> GridItemSpan = { GridItemSpan.Single }, contentPadding: UiDp = UiDp.Zero, horizontalSpacing: UiDp = UiDp.Zero, verticalSpacing: UiDp = UiDp.Zero, state: LazyListState? = null, reverseLayout: Boolean = false, userScrollEnabled: Boolean = true, prefetchPolicy: LazyLayoutPrefetchPolicy = LazyLayoutPrefetchPolicy(), reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), focusFollowKeyboard: Boolean = false, modifier: Modifier = Modifier, itemContent: UiTreeBuilder.(T) -> Unit)

Virtualizes a copied grid snapshot with bounded whole-table reuse.

fun <T> UiTreeBuilder.LazyVerticalGrid(items: List<T>, cells: GridCells = GridCells.Fixed(2), key: (T) -> Any, contentType: (T) -> Any? = { null }, contentRevision: (T) -> Any? = { it }, span: (T) -> GridItemSpan = { GridItemSpan.Single }, contentPadding: UiDp = UiDp.Zero, horizontalSpacing: UiDp = UiDp.Zero, verticalSpacing: UiDp = UiDp.Zero, state: LazyListState? = null, reverseLayout: Boolean = false, userScrollEnabled: Boolean = true, prefetchPolicy: LazyLayoutPrefetchPolicy = LazyLayoutPrefetchPolicy(), reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), focusFollowKeyboard: Boolean = false, modifier: Modifier = Modifier, itemContent: UiTreeBuilder.(T) -> Unit)

Emits a virtualized vertical grid from list data and stable item identities.

LinearProgressIndicator

fun UiTreeBuilder.LinearProgressIndicator(progress: Float? = null, overrides: LinearProgressIndicatorOverrides = LinearProgressIndicatorOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Emits a linear determinate or indeterminate progress indicator.

ListItem

fun UiTreeBuilder.ListItem(headlineText: String, supportingText: String? = null, overlineText: String? = null, leadingContent: UiTreeBuilder.() -> Unit? = null, trailingContent: UiTreeBuilder.() -> Unit? = null, onClick: () -> Unit? = null, key: Any? = null, modifier: Modifier = Modifier)

Creates one structured list row with optional leading, supporting, and trailing regions.

listSaver

fun <T> listSaver(save: (T) -> List<Any?>, restore: (List<Any?>) -> T): Saver<T, List<Any?>>

Creates a saver whose host representation is a list.

mapSaver

fun <T> mapSaver(save: (T) -> Map<String, Any?>, restore: (Map<String, Any?>) -> T): Saver<T, Map<String, Any?>>

Creates a saver whose host representation is a string-keyed map.

ModalBottomSheet

fun UiTreeBuilder.ModalBottomSheet(visible: Boolean, requestKey: String = "bottom_sheet", dismissOnBackPress: Boolean = true, dismissOnClickOutside: Boolean = true, skipPartiallyExpanded: Boolean = false, overrides: ModalBottomSheetOverrides = ModalBottomSheetOverrides.None, onDismissRequest: () -> Unit? = null, content: UiTreeBuilder.() -> Unit)

Requests a modal bottom sheet with a stable session-scoped identity.

mutableStateSaver

fun <T, Saveable> mutableStateSaver(valueSaver: Saver<T, Saveable>, policy: SnapshotMutationPolicy<T> = structuralEqualityPolicy()): Saver<MutableState<T>, Saveable>

Creates a MutableState saver by applying valueSaver to the contained value.

NavigationBar

fun UiTreeBuilder.NavigationBar(selectedIndex: Int, onItemSelected: (Int) -> Unit, overrides: NavigationBarOverrides = NavigationBarOverrides.None, key: Any? = null, modifier: Modifier = Modifier, items: NavigationBarScope.() -> Unit)

Emits a bottom navigation bar backed by caller-owned destination selection.

observedNodeSpec

fun <S : NodeSpec> observedNodeSpec(inputs: List<Any?> = emptyList(), read: () -> S): ObservedNodeSpec<S>

Creates a complete observed NodeSpec for the low-level observed UiTreeBuilder.emit overload.

observedValue

fun <T> observedValue(inputs: List<Any?> = emptyList(), read: () -> T): ObservedValue<T>

Creates a typed node-property value observed by the owning RenderSession.

override

fun UiThemeTokens.override(colors: UiColors? = null, stateColors: UiStateColors? = null, typography: UiTypography? = null, shapes: UiShapes? = null, controls: UiControlSizing? = null, interactions: UiInteractionTokens? = null, overlays: UiOverlays? = null): UiThemeTokens

Creates an immutable partial override of this theme snapshot.

PlainTooltip

fun UiTreeBuilder.PlainTooltip(text: String, visible: Boolean, anchorId: String, alignment: PopupAlignment = PopupAlignment.BelowStart, overflowPolicy: PopupOverflowPolicy = PopupOverflowPolicy.FlipThenClamp, windowMargin: UiDp = 8.dp, dismissOnClickOutside: Boolean = true, onDismissRequest: () -> Unit? = null, requestKey: String = "tooltip")

Shows lightweight text in a non-focusable popup anchored to a rendered semantics id.

Popup

fun UiTreeBuilder.Popup(visible: Boolean, anchorId: String, requestKey: String = "popup", alignment: PopupAlignment = PopupAlignment.BelowStart, overflowPolicy: PopupOverflowPolicy = PopupOverflowPolicy.FlipThenClamp, windowMargin: UiDp = 8.dp, dismissOnClickOutside: Boolean = true, focusable: Boolean = true, offsetX: UiDp = UiDp.Zero, offsetY: UiDp = UiDp.Zero, onDismissRequest: () -> Unit? = null, content: UiTreeBuilder.() -> Unit)

Submits custom DSL content as a keyed popup anchored to a rendered semantics id.

produceState

fun <T> produceState(initialValue: T, vararg keys: Any?, producer: suspend ProduceStateScope<T>.() -> Unit): State<T>

Converts values produced by a composition-scoped coroutine into observable State.

ProvideAlertDialogOverrides

fun UiTreeBuilder.ProvideAlertDialogOverrides(overrides: AlertDialogOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse AlertDialog overrides for content.

ProvideAnimationCoroutineContext

fun UiTreeBuilder.ProvideAnimationCoroutineContext(context: CoroutineContext, content: UiTreeBuilder.() -> Unit)

Provides context to animation APIs invoked while building content.

ProvideBadgeOverrides

fun UiTreeBuilder.ProvideBadgeOverrides(overrides: BadgeOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse Badge overrides for content.

ProvideBottomAppBarOverrides

fun UiTreeBuilder.ProvideBottomAppBarOverrides(overrides: BottomAppBarOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse BottomAppBar overrides for content.

ProvideButtonOverrides

fun UiTreeBuilder.ProvideButtonOverrides(overrides: ButtonOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse overrides into Button defaults for content.

ProvideCheckboxOverrides

fun UiTreeBuilder.ProvideCheckboxOverrides(overrides: CheckboxOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse overrides into Checkbox defaults for content.

ProvideCircularProgressIndicatorOverrides

fun UiTreeBuilder.ProvideCircularProgressIndicatorOverrides(overrides: CircularProgressIndicatorOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse overrides into circular progress defaults for content.

ProvideExtendedFloatingActionButtonOverrides

fun UiTreeBuilder.ProvideExtendedFloatingActionButtonOverrides(overrides: ExtendedFloatingActionButtonOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse extended-FAB overrides for content.

ProvideFloatingActionButtonOverrides

fun UiTreeBuilder.ProvideFloatingActionButtonOverrides(overrides: FloatingActionButtonOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse regular-FAB overrides for content.

ProvideIconButtonOverrides

fun UiTreeBuilder.ProvideIconButtonOverrides(overrides: IconButtonOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse overrides into IconButton defaults for content.

ProvideImageLoader

fun UiTreeBuilder.ProvideImageLoader(loader: UiImageLoader?, content: UiTreeBuilder.() -> Unit)

Provides an image loader to image components emitted by content.

ProvideLinearProgressIndicatorOverrides

fun UiTreeBuilder.ProvideLinearProgressIndicatorOverrides(overrides: LinearProgressIndicatorOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse overrides into linear progress defaults for content.

ProvideLocal

fun <T> UiTreeBuilder.ProvideLocal(local: UiLocal<T>, value: T, content: UiTreeBuilder.() -> Unit)

Provides one UiLocal within the content scope.

ProvideLocals

fun UiTreeBuilder.ProvideLocals(vararg values: UiLocalProvider, content: UiTreeBuilder.() -> Unit)

Provides multiple UiLocals in order within the content scope.

ProvideModalBottomSheetOverrides

fun UiTreeBuilder.ProvideModalBottomSheetOverrides(overrides: ModalBottomSheetOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse modal-bottom-sheet overrides for content.

ProvideMonotonicFrameClock

fun UiTreeBuilder.ProvideMonotonicFrameClock(clock: MonotonicFrameClock, content: UiTreeBuilder.() -> Unit)

Provides clock to frame-aware APIs invoked while building content.

ProvideNavigationBarOverrides

fun UiTreeBuilder.ProvideNavigationBarOverrides(overrides: NavigationBarOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse overrides into NavigationBar defaults for content.

ProvideOverlayHost

fun UiTreeBuilder.ProvideOverlayHost(host: OverlayHost, content: UiTreeBuilder.() -> Unit)

Provides an overlay host within the content scope.

ProvideRadioButtonOverrides

fun UiTreeBuilder.ProvideRadioButtonOverrides(overrides: RadioButtonOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse overrides into RadioButton defaults for content.

provides

infix fun <T> UiLocal<T>.provides(value: T): UiLocalProvider

Builds one local/value binding.

ProvideSaveableStateRegistry

fun UiTreeBuilder.ProvideSaveableStateRegistry(registry: SaveableStateRegistry, content: UiTreeBuilder.() -> Unit)

Provides registry to saveable-state APIs while content is built.

ProvideSegmentedControlOverrides

fun UiTreeBuilder.ProvideSegmentedControlOverrides(overrides: SegmentedControlOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse overrides into SegmentedControl defaults for content.

ProvideSliderOverrides

fun UiTreeBuilder.ProvideSliderOverrides(overrides: SliderOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse overrides into Slider defaults for content.

ProvideSwitchOverrides

fun UiTreeBuilder.ProvideSwitchOverrides(overrides: SwitchOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse overrides into Switch defaults for content.

ProvideTabRowOverrides

fun UiTreeBuilder.ProvideTabRowOverrides(overrides: TabRowOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse overrides into TabRow defaults for content.

ProvideTextFieldOverrides

fun UiTreeBuilder.ProvideTextFieldOverrides(overrides: TextFieldOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse overrides into TextField defaults for content.

ProvideTopAppBarOverrides

fun UiTreeBuilder.ProvideTopAppBarOverrides(overrides: TopAppBarOverrides, content: UiTreeBuilder.() -> Unit)

Merges sparse TopAppBar overrides for content.

PullToRefresh

fun UiTreeBuilder.PullToRefresh(isRefreshing: Boolean, onRefresh: () -> Unit, enabled: Boolean = true, indicatorColor: Int = PullToRefreshDefaults.indicatorColor(), key: Any? = null, modifier: Modifier = Modifier, content: ScrollableScope.() -> Unit)

Emits a controlled pull-to-refresh container around one scrollable-content scope.

RadioButton

fun UiTreeBuilder.RadioButton(text: String, checked: Boolean, onCheckedChange: (Boolean) -> Unit, enabled: Boolean = true, overrides: RadioButtonOverrides = RadioButtonOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Displays a labeled radio button for a caller-owned mutually exclusive selection flow.

remember

fun <T> remember(calculation: () -> T): T

Caches one value in the current composition scope.

fun <T> remember(vararg keys: Any?, calculation: () -> T): T

remember whose cached value is invalidated when keys change.

rememberCoroutineScope

fun rememberCoroutineScope(getContext: () -> CoroutineContext = { EmptyCoroutineContext }): CoroutineScope

Returns a stable coroutine scope cancelled when this remembered call leaves composition.

rememberLazyListState

fun rememberLazyListState(initialFirstVisibleItemIndex: Int = 0, initialFirstVisibleItemScrollOffset: Int = 0): LazyListState

Remembers lazy-collection state and restores its first visible item and pixel offset.

rememberSaveable

fun <T> rememberSaveable(vararg inputs: Any?, key: String? = null, init: () -> T): T

Remembers init's result and saves it through the current host registry.

fun <T, Saveable> rememberSaveable(vararg inputs: Any?, key: String? = null, saver: Saver<T, Saveable>, init: () -> T): T

Remembers a value and saves or restores it with saver.

rememberTextFieldState

fun rememberTextFieldState(initialDocument: TextDocument, initialSelection: TextRange = TextRange(initialDocument.text.length), historyLimit: Int = TextFieldState.DEFAULT_HISTORY_LIMIT): TextFieldState

Initializes saveable text editor state from a rich text document.

fun rememberTextFieldState(initialText: String = "", initialSelection: TextRange = TextRange(initialText.length), historyLimit: Int = TextFieldState.DEFAULT_HISTORY_LIMIT): TextFieldState

Remembers a stable text editor state and restores text plus directional selection after host recreation. Active IME composition and undo history are intentionally session-local.

rememberUpdatedState

fun <T> rememberUpdatedState(newValue: T): State<T>

Returns a stable state holder that publishes newValue only when the candidate frame commits.

RichText

fun UiTreeBuilder.RichText(document: TextDocument, style: UiTextStyle = TextDefaults.currentStyle(), color: Int = TextDefaults.primaryColor(), maxLines: Int = Int.MAX_VALUE, overflow: TextOverflow = TextOverflow.Clip, textAlign: TextAlign = TextAlign.Start, textDecoration: TextDecoration = style.textDecoration ?: TextDecoration.None, key: Any? = null, modifier: Modifier = Modifier)

Displays an immutable rich-text document while preserving span and paragraph ranges.

Row

fun UiTreeBuilder.Row(key: Any? = null, spacing: UiDp = UiDp.Zero, arrangement: MainAxisArrangement = MainAxisArrangement.Start, verticalAlignment: VerticalAlignment = VerticalAlignment.Top, modifier: Modifier = Modifier, content: RowScope.() -> Unit)

Places eager children along a horizontal main axis.

Scaffold

fun UiTreeBuilder.Scaffold(topBar: UiTreeBuilder.() -> Unit? = null, bottomBar: UiTreeBuilder.() -> Unit? = null, floatingActionButton: UiTreeBuilder.() -> Unit? = null, containerColor: Int = ScaffoldDefaults.containerColor(), contentColor: Int = ScaffoldDefaults.contentColor(), key: Any? = null, modifier: Modifier = Modifier, content: BoxScope.() -> Unit)

Arranges optional app bars, body content, and a floating action region into one page.

ScrollableColumn

fun UiTreeBuilder.ScrollableColumn(key: Any? = null, spacing: UiDp = UiDp.Zero, arrangement: MainAxisArrangement = MainAxisArrangement.Start, horizontalAlignment: HorizontalAlignment = HorizontalAlignment.Start, state: ScrollState? = null, userScrollEnabled: Boolean = true, focusFollowKeyboard: Boolean = false, modifier: Modifier = Modifier, content: ColumnScope.() -> Unit)

Emits a vertically scrolling container whose complete child tree remains mounted.

ScrollableRow

fun UiTreeBuilder.ScrollableRow(key: Any? = null, spacing: UiDp = UiDp.Zero, arrangement: MainAxisArrangement = MainAxisArrangement.Start, verticalAlignment: VerticalAlignment = VerticalAlignment.Top, state: ScrollState? = null, userScrollEnabled: Boolean = true, modifier: Modifier = Modifier, content: RowScope.() -> Unit)

Emits a horizontally scrolling container whose complete child tree remains mounted.

SearchBar

fun UiTreeBuilder.SearchBar(state: TextFieldState, onSearch: (String) -> Unit? = null, placeholder: String = "", leadingIcon: ImageSource? = null, trailingIcon: UiTreeBuilder.() -> Unit? = null, enabled: Boolean = true, key: Any? = null, modifier: Modifier = Modifier)

Creates a single-line search input backed by caller-owned state.

SegmentedControl

fun UiTreeBuilder.SegmentedControl(items: List<SegmentedControlItem>, selectedIndex: Int, onSelectionChange: (Int) -> Unit, size: SegmentedControlSize = SegmentedControlSize.Medium, enabled: Boolean = true, overrides: SegmentedControlOverrides = SegmentedControlOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Emits a mutually exclusive segmented selection control backed by caller-owned state.

SideEffect

fun SideEffect(effect: () -> Unit)

Runs synchronous publication work after every successful invocation commits.

fun SideEffect(key1: Any?, effect: () -> Unit)

Runs synchronous publication work on initial commit and when key1 changes.

fun SideEffect(vararg keys: Any?, effect: () -> Unit)

Runs effect on initial commit and when a non-empty structural key list changes.

fun SideEffect(key1: Any?, key2: Any?, effect: () -> Unit)

Runs effect on initial commit and when either structural key changes.

fun SideEffect(key1: Any?, key2: Any?, key3: Any?, effect: () -> Unit)

Runs effect on initial commit and when any of three structural keys changes.

Slider

fun UiTreeBuilder.Slider(value: Int, onValueChange: (Int) -> Unit, min: Int = 0, max: Int = 100, step: Int = 1, onValueChangeStarted: () -> Unit? = null, onValueChangeFinished: () -> Unit? = null, enabled: Boolean = true, overrides: SliderOverrides = SliderOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Displays an integer-valued slider and reports accepted value changes.

Snackbar

fun UiTreeBuilder.Snackbar(visible: Boolean, message: String, actionLabel: String? = null, duration: SnackbarDuration = SnackbarDuration.Short, queuePolicy: TransientFeedbackQueuePolicy = TransientFeedbackQueuePolicy.Enqueue, requestKey: String = "snackbar", onAction: () -> Unit? = null, onDismiss: (TransientFeedbackDismissReason) -> Unit? = null)

Submits a keyed snackbar request to the active overlay presenter.

Spacer

fun UiTreeBuilder.Spacer(key: Any? = null, modifier: Modifier = Modifier)

Reserves empty layout space determined by modifier.

Surface

fun UiTreeBuilder.Surface(key: Any? = null, variant: SurfaceVariant = SurfaceVariant.Default, enabled: Boolean = true, contentAlignment: BoxAlignment = BoxAlignment.TopStart, contentColor: Int = SurfaceDefaults.contentColor(variant), onClick: () -> Unit? = null, modifier: Modifier = Modifier, content: BoxScope.() -> Unit)

Creates a themed surface that provides contentColor to descendants.

Switch

fun UiTreeBuilder.Switch(text: String, checked: Boolean, onCheckedChange: (Boolean) -> Unit, enabled: Boolean = true, overrides: SwitchOverrides = SwitchOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Displays a labeled switch and reports accepted checked-state changes.

TabRow

fun UiTreeBuilder.TabRow(selectedIndex: Int, onTabSelected: (Int) -> Unit, pagerState: PagerState? = null, overrides: TabRowOverrides = TabRowOverrides.None, key: Any? = null, modifier: Modifier = Modifier, tabs: TabRowScope.() -> Unit)

Emits a TabRow whose tabs are eager keyed children in the parent composition.

Text

fun UiTreeBuilder.Text(text: ObservedValue<String>, style: UiTextStyle = TextDefaults.currentStyle(), color: Int = TextDefaults.primaryColor(), maxLines: Int = Int.MAX_VALUE, overflow: TextOverflow = TextOverflow.Clip, textAlign: TextAlign = TextAlign.Start, textDecoration: TextDecoration = style.textDecoration ?: TextDecoration.None, key: Any? = null, modifier: Modifier = Modifier)

Displays text whose content is patched directly when its observed dependencies change.

fun UiTreeBuilder.Text(text: String, style: UiTextStyle = TextDefaults.currentStyle(), color: Int = TextDefaults.primaryColor(), maxLines: Int = Int.MAX_VALUE, overflow: TextOverflow = TextOverflow.Clip, textAlign: TextAlign = TextAlign.Start, textDecoration: TextDecoration = style.textDecoration ?: TextDecoration.None, key: Any? = null, modifier: Modifier = Modifier)

Displays plain text with theme-resolved typography and color defaults.

TextField

fun UiTreeBuilder.TextField(state: TextFieldState, hint: String = "", label: String = "", placeholder: String = hint, supportingText: String = "", inputProfile: TextFieldInputProfile = TextFieldInputProfile.Text, linePolicy: TextFieldLinePolicy = TextFieldLinePolicy.SingleLine, readOnly: Boolean = false, inputTransformation: InputTransformation? = null, receiveContent: ReceiveContentConfiguration = ReceiveContentConfiguration.Default, onKeyboardAction: (TextFieldImeAction) -> Boolean? = null, onFocusChange: (Boolean) -> Unit? = null, variant: TextFieldVariant = TextFieldVariant.Filled, size: TextFieldSize = TextFieldSize.Medium, enabled: Boolean = true, isError: Boolean = false, overrides: TextFieldOverrides = TextFieldOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Emits a standard text field composite with label, placeholder, and supporting text.

textFieldStateSaver

fun textFieldStateSaver(historyLimit: Int = TextFieldState.DEFAULT_HISTORY_LIMIT): Saver<TextFieldState, List<Any?>>

Encodes and decodes saveable TextFieldState snapshots with an explicit version for future format changes.

Toast

fun UiTreeBuilder.Toast(visible: Boolean, message: String, duration: ToastDuration = ToastDuration.Short, queuePolicy: TransientFeedbackQueuePolicy = TransientFeedbackQueuePolicy.Enqueue, requestKey: String = "toast", onDismiss: (TransientFeedbackDismissReason) -> Unit? = null)

Submits a keyed toast request to the active overlay presenter.

toLazyItemsSnapshot

fun <T> Iterable<T>.toLazyItemsSnapshot(): LazyItemsSnapshot<T>

Copies these item references into an immutable lazy-collection submission with a new identity.

TopAppBar

fun UiTreeBuilder.TopAppBar(title: String, navigationIcon: UiTreeBuilder.() -> Unit? = null, actions: RowScope.() -> Unit? = null, overrides: TopAppBarOverrides = TopAppBarOverrides.None, key: Any? = null, modifier: Modifier = Modifier)

Emits a top app bar with independent title, navigation, and action content roles.

UiEnvironment

fun UiTreeBuilder.UiEnvironment(values: UiEnvironmentValues? = null, content: UiTreeBuilder.() -> Unit)

Provides one environment snapshot while building content.

uiLocalOf

fun <T> uiLocalOf(defaultFactory: () -> T): UiLocal<T>

Creates a UiLocal with an automatic diagnostic name.

fun <T> uiLocalOf(debugName: String, debugValueFormatter: (T) -> String? = null, defaultFactory: () -> T): UiLocal<T>

Creates a UiLocal with an explicit diagnostic name and optional formatter.

UiTheme

fun UiTreeBuilder.UiTheme(tokens: UiThemeTokens = UiThemeDefaults.light(), content: UiTreeBuilder.() -> Unit)

Provides one platform-independent theme snapshot while building content.

UiThemeOverride

fun UiTreeBuilder.UiThemeOverride(colors: UiColors? = null, stateColors: UiStateColors? = null, typography: UiTypography? = null, shapes: UiShapes? = null, controls: UiControlSizing? = null, interactions: UiInteractionTokens? = null, overlays: UiOverlays? = null, content: UiTreeBuilder.() -> Unit)

Provides selected token families over the current theme while building content.

fun UiTreeBuilder.UiThemeOverride(colors: UiColors.() -> UiColors? = null, stateColors: UiStateColors.() -> UiStateColors? = null, typography: UiTypography.() -> UiTypography? = null, shapes: UiShapes.() -> UiShapes? = null, controls: UiControlSizing.() -> UiControlSizing? = null, interactions: UiInteractionTokens.() -> UiInteractionTokens? = null, overlays: UiOverlays.() -> UiOverlays? = null, content: UiTreeBuilder.() -> Unit)

Computes and provides selected token families from their current values.

VerticalPager

fun UiTreeBuilder.VerticalPager(currentPage: Int, onPageChanged: (Int) -> Unit, pagerState: PagerState? = null, offscreenPageLimit: Int = -1, userScrollEnabled: Boolean = true, reusePolicy: CollectionReusePolicy = CollectionReusePolicy(), motionPolicy: CollectionMotionPolicy = CollectionMotionPolicy(), focusFollowKeyboard: Boolean = false, key: Any? = null, modifier: Modifier = Modifier, pages: HorizontalPagerScope.() -> Unit)

Emits a vertical pager with one keyed lazy session per page.

withUiLocalSnapshot

fun <T> withUiLocalSnapshot(snapshot: UiLocalSnapshot, block: () -> T): T

Runs block under the specified locals snapshot.