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

UiTreeBuilder

open class UiTreeBuilder(source)

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

Inheritors

LayoutScope

Constructors

UiTreeBuilder

constructor()

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.

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.

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.

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.

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.

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.

emit

fun emit(type: NodeType, key: Any? = null, spec: ObservedNodeSpec<out NodeSpec>, modifier: Modifier = Modifier, content: UiTreeBuilder.() -> Unit? = null)

Emits one VNode whose complete NodeSpec can update through a direct property transaction.

fun emit(type: NodeType, key: Any? = null, spec: NodeSpec, modifier: Modifier = Modifier, content: UiTreeBuilder.() -> Unit? = null)

Emits one VNode and recursively records its optional child subtree.

emitScoped

fun <S : UiTreeBuilder> emitScoped(type: NodeType, key: Any? = null, inputs: List<Any?> = emptyList(), modifier: Modifier = Modifier, scopeFactory: () -> S, spec: S.() -> NodeSpec, content: S.() -> Unit)

Emits one VNode whose children are collected by a dedicated UiTreeBuilder subtype.

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.

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.

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.

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.

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.

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.

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.

RecomposeBoundary

fun RecomposeBoundary(key: Any? = null, inputs: List<Any?> = emptyList(), content: UiTreeBuilder.() -> Unit)

Creates an explicit restart boundary without emitting an Android View.

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.

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.

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.

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.

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.