coui-ui/io.github.suqi8.coui.kmp.basic

Package-level declarations

Types

BadgeColors

@Immutable

data class BadgeColors(val containerColor: Color, val contentColor: Color, val strokeColor: Color)

BadgeDefaults

object BadgeDefaults

Contains default values used by Badge and BadgeBox.

BasicComponentColors

@Immutable

data class BasicComponentColors(val color: Color, val disabledColor: Color)

BasicComponentDefaults

object BasicComponentDefaults

BreadcrumbBarColors

@Immutable

data class BreadcrumbBarColors(val color: Color, val highlightColor: Color, val disabledColor: Color, val separatorColor: Color, val backgroundColor: Color, val highlightBackgroundColor: Color, val disabledBackgroundColor: Color)

BreadcrumbBarDefaults

object BreadcrumbBarDefaults

BreadcrumbItem

@Stable

data class BreadcrumbItem(val path: String, val text: String? = null)

A single segment in a BreadcrumbBar. Each item carries a path segment used to reconstruct the full path, and an optional text for display. When text is null, path is shown.

ButtonColors

@Immutable

data class ButtonColors(val color: Color, val disabledColor: Color, val contentColor: Color, val disabledContentColor: Color)

ButtonDefaults

object ButtonDefaults

CardColors

@Immutable

data class CardColors(val color: Color, val contentColor: Color, val pressedColor: Color)

Colors used by a Card.

CardDefaults

object CardDefaults

CardListPosition

enum CardListPosition : Enum<CardListPosition>

The position of a row inside a card group, mirroring COUI's COUICardListHelper constants (NONE = 0, HEAD = 1, MIDDLE = 2, TAIL = 3, FULL = 4).

CheckboxColors

@Immutable

data class CheckboxColors(checkedForegroundColor: Color, uncheckedForegroundColor: Color, disabledCheckedForegroundColor: Color, disabledUncheckedForegroundColor: Color, checkedBackgroundColor: Color, uncheckedBackgroundColor: Color, disabledCheckedBackgroundColor: Color, disabledUncheckedBackgroundColor: Color)

CheckboxDefaults

object CheckboxDefaults

ChipColors

@Immutable

data class ChipColors(val containerColor: Color, val selectedContainerColor: Color, val disabledContainerColor: Color, val selectedDisabledContainerColor: Color, val contentColor: Color, val selectedContentColor: Color, val disabledContentColor: Color, val selectedDisabledContentColor: Color)

Colors used by a Chip.

ChipDefaults

object ChipDefaults

Contains default values used by Chip.

CodeTextFieldColors

@Immutable

data class CodeTextFieldColors(val cellBackgroundColor: Color, val textColor: Color, val focusedStrokeColor: Color, val securityCircleColor: Color, val cursorColor: Color)

Colors used by a CodeTextField in different parts of the component.

CodeTextFieldDefaults

object CodeTextFieldDefaults

Contains default values used by CodeTextField.

ColorSpace

enum ColorSpace : Enum<ColorSpace>

ColorSwatchPickerDefaults

object ColorSwatchPickerDefaults

Contains default values used by ColorSwatchPicker.

DatePickerDefaults

object DatePickerDefaults

Contains default values used by DatePicker.

DateValue

@Immutable

data class DateValue(val year: Int, val month: Int, val day: Int)

A plain calendar date holder used by DatePicker.

DividerDefaults

object DividerDefaults

DropdownColors

@Immutable

data class DropdownColors(val contentColor: Color, val summaryColor: Color, val containerColor: Color, val selectedContentColor: Color, val selectedSummaryColor: Color, val selectedContainerColor: Color, val selectedIndicatorColor: Color, val disabledContentColor: Color = contentColor, val alertContentColor: Color = contentColor, val headerColor: Color = summaryColor)

Colors used by dropdown option rows.

DropdownDefaults

object DropdownDefaults

DropdownEntry

@Stable

data class DropdownEntry(val items: List<DropdownItem>, val enabled: Boolean = true, val title: String? = null)

A group of dropdown items.

DropdownItem

@Stable

data class DropdownItem(val text: String, val enabled: Boolean = true, val selected: Boolean = false, val onClick: () -> Unit? = null, val icon: @Composable (Modifier) -> Unit? = null, val summary: String? = null, val children: List<DropdownItem>? = null, val hint: @Composable () -> Unit? = null, val alert: Boolean = false)

An item shown inside a dropdown, spinner, or dropdown menu.

FabPosition

@JvmInline

value class FabPosition

FloatingActionButtonDefaults

object FloatingActionButtonDefaults

Contains default values used by FloatingActionButton.

FloatingNavigationBarDefaults

object FloatingNavigationBarDefaults

Contains default values used by FloatingNavigationBar and FloatingNavigationBarItem.

FloatingToolbarDefaults

object FloatingToolbarDefaults

FullPageStatementColors

@Immutable

data class FullPageStatementColors(val titleColor: Color, val contentColor: Color, val secondaryButtonColor: Color)

Colors used by a FullPageStatement.

FullPageStatementDefaults

object FullPageStatementDefaults

Contains default values used by FullPageStatement.

IconButtonDefaults

object IconButtonDefaults

InputViewColors

@Immutable

data class InputViewColors(val cardColor: Color, val titleColor: Color, val disabledTitleColor: Color, val countColor: Color, val errorColor: Color)

Colors used by an InputView in different parts of the component.

InputViewDefaults

object InputViewDefaults

Contains default values used by InputView.

ListPopupDefaults

object ListPopupDefaults

ListPopupLayoutInfo

@Immutable

data class ListPopupLayoutInfo(val windowBounds: IntRect, val popupMargin: IntRect, val effectiveTransformOrigin: TransformOrigin, val localTransformOrigin: TransformOrigin, val popupLayoutPosition: PopupLayoutPosition)

The resolved layout information for a list popup, produced by rememberListPopupLayoutInfo.

LoadingButtonDefaults

object LoadingButtonDefaults

Contains default values used by LoadingButton.

NavigationBarDefaults

object NavigationBarDefaults

Contains default values used by NavigationBar and NavigationBarItem.

NavigationBarDisplayMode

enum NavigationBarDisplayMode : Enum<NavigationBarDisplayMode>

Defines the display mode for items in a NavigationBar.

NavigationItem

@Immutable

data class NavigationItem(val label: String, val icon: ImageVector)

The data class for NavigationBar.

NavigationRailDefaults

object NavigationRailDefaults

Contains default values used by NavigationRail and NavigationRailItem.

NavigationRailDisplayMode

enum NavigationRailDisplayMode : Enum<NavigationRailDisplayMode>

Defines the display mode for items in a NavigationRail.

NumberPickerColors

@Immutable

data class NumberPickerColors(selectedTextColor: Color, unselectedTextColor: Color, disabledSelectedTextColor: Color, disabledUnselectedTextColor: Color)

The colors for a NumberPicker.

NumberPickerDefaults

object NumberPickerDefaults

Contains default values used by NumberPicker.

PopupLayoutPosition

@Immutable

data class PopupLayoutPosition(val showBelow: Boolean, val showAbove: Boolean, val isRightAligned: Boolean)

Describes how the popup is placed relative to its anchor, used to drive the directional reveal and transform origin.

PopupPositionProvider

@Stable

interface PopupPositionProvider

PreciseClickState

@Stable

class PreciseClickState

Records where an anchor was last touched, so a popup can open at the finger rather than centred on the anchor — COUI PreciseClickHelper / PreciseLongPressHelper, which stash the DOWN (x, y) and pass it to the click callback, after which PopupMenuLocateHelper.setAnchor collapses the anchor bounds to that single point.

ProgressIndicatorColors

@Immutable

data class ProgressIndicatorColors(foregroundColor: Color, disabledForegroundColor: Color, backgroundColor: Color)

ProgressIndicatorDefaults

object ProgressIndicatorDefaults

PullToRefreshDefaults

object PullToRefreshDefaults

Default values for the PullToRefresh component.

PullToRefreshState

class PullToRefreshState(coroutineScope: CoroutineScope)

A UI state holder for the PullToRefresh composable.

RadioButtonColors

@Immutable

data class RadioButtonColors(selectedColor: Color, disabledSelectedColor: Color, unselectedColor: Color, disabledUnselectedColor: Color, centerColor: Color, disabledCenterColor: Color)

RadioButtonDefaults

object RadioButtonDefaults

RefreshState

sealed interface RefreshState

Represents the various visual states of the pull-to-refresh indicator.

RichTooltipColors

@Immutable

data class RichTooltipColors(val containerColor: Color, val contentColor: Color, val titleContentColor: Color, val actionContentColor: Color)

Colors for RichTooltip.

ScrollBarAdapter

interface ScrollBarAdapter

Defines how to scroll the scrollable component and how to display a scrollbar for it.

ScrollBarColors

@Immutable

data class ScrollBarColors(val thumbColor: Color, val trackColor: Color)

Colors for the scrollbar component.

ScrollBarDefaults

object ScrollBarDefaults

ScrollBehavior

@Stable

interface ScrollBehavior

SearchBarColors

@Immutable

data class SearchBarColors(val backgroundColor: Color, val labelColor: Color, val iconColor: Color, val clearIconColor: Color)

Colors used by the InputField of a SearchBar.

SearchBarDefaults

object SearchBarDefaults

Contains default values used by SearchBar and InputField.

SliderColors

@Immutable

data class SliderColors(foregroundColor: Color, disabledForegroundColor: Color, backgroundColor: Color, disabledBackgroundColor: Color, thumbColor: Color, disabledThumbColor: Color, keyPointColor: Color, keyPointForegroundColor: Color)

SliderDefaults

object SliderDefaults

SmallTitleDefaults

object SmallTitleDefaults

Contains default values used by SmallTitle.

SnackbarColors

@Immutable

data class SnackbarColors(val containerColor: Color, val contentColor: Color, val actionContentColor: Color, val dismissActionContentColor: Color)

Colors for Snackbar.

SnackbarData

interface SnackbarData

Interface representing the data of a Snackbar.

SnackbarDefaults

object SnackbarDefaults

Defaults for Snackbar.

SnackbarDuration

sealed interface SnackbarDuration

Possible durations of the Snackbar.

SnackbarHostState

@Stable

class SnackbarHostState

State of the SnackbarHost.

SnackbarResult

enum SnackbarResult : Enum<SnackbarResult>

Possible results of the Snackbar.

SnackbarVisuals

@Immutable

data class SnackbarVisuals(val message: String, val actionLabel: String?, val withDismissAction: Boolean, val duration: SnackbarDuration)

Visuals for a Snackbar.

SpinnerColors

typealias ~~SpinnerColors~~ = DropdownColors

SpinnerDefaults

object ~~SpinnerDefaults~~

SpinnerEntry

typealias ~~SpinnerEntry~~ = DropdownItem

StepperColors

@Immutable

data class StepperColors(val buttonColor: Color, val contentColor: Color, val disabledContentColor: Color)

Colors used by a Stepper.

StepperDefaults

object StepperDefaults

Contains default values used by Stepper.

SurfaceDefaults

object SurfaceDefaults

SwitchColors

@Immutable

data class SwitchColors(checkedThumbColor: Color, uncheckedThumbColor: Color, disabledCheckedThumbColor: Color, disabledUncheckedThumbColor: Color, checkedTrackColor: Color, uncheckedTrackColor: Color, disabledCheckedTrackColor: Color, disabledUncheckedTrackColor: Color)

SwitchDefaults

object SwitchDefaults

TabRowColors

@Immutable

data class TabRowColors(backgroundColor: Color, contentColor: Color, selectedBackgroundColor: Color, selectedContentColor: Color)

TabRowDefaults

object TabRowDefaults

TextButtonColors

@Immutable

data class TextButtonColors(val color: Color, val disabledColor: Color, val textColor: Color, val disabledTextColor: Color)

TextFieldColors

@Immutable

data class TextFieldColors(val backgroundColor: Color, val labelColor: Color, val borderColor: Color, val unfocusedBorderColor: Color, val errorColor: Color, val counterColor: Color, val iconColor: Color, val disabledTextColor: Color)

Colors used by a TextField in different parts of the component.

TextFieldDefaults

object TextFieldDefaults

Contains default values used by TextField.

TextFieldMode

enum TextFieldMode : Enum<TextFieldMode>

Background mode of a TextField, mirroring COUIEditText couiBackgroundMode.

TimePickerDefaults

object TimePickerDefaults

Contains default values used by TimePicker.

TimeValue

@Immutable

data class TimeValue(val hour: Int, val minute: Int)

A plain time-of-day holder used by TimePicker.

ToolbarPosition

@JvmInline

value class ToolbarPosition

Represents the position of a floating toolbar within the Scaffold. Used by Scaffold for placement calculations.

TooltipAnchorPosition

@JvmInline

value class TooltipAnchorPosition

The preferred position of a tooltip relative to its anchor. The tooltip flips to the opposite side when there is not enough room on the preferred side. Start / End resolve to Left / Right following the layout direction.

TooltipDefaults

object TooltipDefaults

Defaults for TooltipBox, PlainTooltip and RichTooltip.

TooltipScope

@Stable

sealed interface TooltipScope

Receiver scope for the TooltipBox tooltip content (PlainTooltip / RichTooltip). It exposes the resolved anchor position and the anchor bounds so a caret can be drawn pointing at the anchor.

TooltipState

@Stable

interface TooltipState

The state that controls the visibility of a TooltipBox.

TopAppBarDefaults

object TopAppBarDefaults

Contains default values used by TopAppBar and SmallTopAppBar.

TopAppBarState

@Stable

class TopAppBarState(initialHeightOffsetLimit: Float, initialHeightOffset: Float, initialContentOffset: Float)

A state object that can be hoisted to control and observe the top app bar state. The state is read and updated by a ScrollBehavior implementation.

TopTipsColors

@Immutable

data class TopTipsColors(val containerColor: Color, val contentColor: Color, val actionColor: Color, val closeButtonColor: Color, val closeIconColor: Color)

Colors used by a TopTips.

TopTipsDefaults

object TopTipsDefaults

Contains default values used by TopTips.

Properties

LocalNavigationBarDisplayMode

val LocalNavigationBarDisplayMode: ProvidableCompositionLocal<NavigationBarDisplayMode>

A composition local to control the display mode for items in a NavigationBar.

LocalNavigationRailDisplayMode

val LocalNavigationRailDisplayMode: ProvidableCompositionLocal<NavigationRailDisplayMode>

A composition local to control the display mode for items in a NavigationRail.

Package-level declarations

Types

Properties

Functions