ui/kiwi.orbit.compose.ui.controls

Package-level declarations

Types

object BadgeDefaults

object ButtonDefaults

CircularProgressIndicatorDefaults

object CircularProgressIndicatorDefaults

class ListScope

PasswordStrengthColor

object PasswordStrengthColor

PillButtonContainerScope

interface PillButtonContainerScope

StepperSemanticsActions

object StepperSemanticsActions

interface TileGroupScope

TimelineItemStatus

enum TimelineItemStatus : Enum<TimelineItemStatus>

object TimelineScope

interface ToastData

class ToastHostState(onActionClick: (String) -> Unit, onDismiss: (String) -> Unit)

TopAppBarScrollBehavior

interface TopAppBarScrollBehavior

TopAppBarSemantics

object TopAppBarSemantics

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 TopAppBarScrollBehavior implementation.

Properties

val ActionFadeLine: HorizontalAlignmentLine

Models the height of the fading gradient - how much should be the content shifted under the action slot.

DefaultActionFadeHeight

val DefaultActionFadeHeight: Dp

Action's top gradient currently decreased from 16.dp to minimize contentPadding (auto)scrolling issues. We need a new api for scroll to be able to account for this semi-transparent area. https://issuetracker.google.com/issues/221252680

Functions

fun AlertCritical(title: @Composable ColumnScope.() -> Unit, modifier: Modifier = Modifier, suppressed: Boolean = false, icon: Painter? = Icons.AlertOctagon, actions: @Composable () -> Unit = {}, content: @Composable ColumnScope.() -> Unit)

fun AlertInfo(title: @Composable ColumnScope.() -> Unit, modifier: Modifier = Modifier, suppressed: Boolean = false, icon: Painter? = Icons.InformationCircle, actions: @Composable () -> Unit = {}, content: @Composable ColumnScope.() -> Unit)

AlertInlineCritical

fun AlertInlineCritical(title: @Composable () -> Unit, action: @Composable () -> Unit, modifier: Modifier = Modifier, suppressed: Boolean = false, icon: Painter? = Icons.AlertOctagon)

AlertInlineInfo

fun AlertInlineInfo(title: @Composable () -> Unit, action: @Composable () -> Unit, modifier: Modifier = Modifier, suppressed: Boolean = false, icon: Painter? = Icons.InformationCircle)

AlertInlineSuccess

fun AlertInlineSuccess(title: @Composable () -> Unit, action: @Composable () -> Unit, modifier: Modifier = Modifier, suppressed: Boolean = false, icon: Painter? = Icons.CheckCircle)

AlertInlineWarning

fun AlertInlineWarning(title: @Composable () -> Unit, action: @Composable () -> Unit, modifier: Modifier = Modifier, suppressed: Boolean = false, icon: Painter? = Icons.AlertCircle)

fun AlertSuccess(title: @Composable ColumnScope.() -> Unit, modifier: Modifier = Modifier, suppressed: Boolean = false, icon: Painter? = Icons.CheckCircle, actions: @Composable () -> Unit = {}, content: @Composable ColumnScope.() -> Unit)

fun AlertWarning(title: @Composable ColumnScope.() -> Unit, modifier: Modifier = Modifier, suppressed: Boolean = false, icon: Painter? = Icons.AlertCircle, actions: @Composable () -> Unit = {}, content: @Composable ColumnScope.() -> Unit)

BadgeBundleBasic

fun BadgeBundleBasic(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

BadgeBundleMedium

fun BadgeBundleMedium(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

fun BadgeBundleTop(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

BadgeCircleCritical

fun BadgeCircleCritical(value: Int, modifier: Modifier = Modifier)

Red normal colored circled Badge.

BadgeCircleCriticalSubtle

fun BadgeCircleCriticalSubtle(value: Int, modifier: Modifier = Modifier)

Red light colored circled Badge.

BadgeCircleInfo

fun BadgeCircleInfo(value: Int, modifier: Modifier = Modifier)

Blue normal colored circled Badge.

BadgeCircleInfoSubtle

fun BadgeCircleInfoSubtle(value: Int, modifier: Modifier = Modifier)

Blue light colored circled Badge.

BadgeCircleNeutral

fun BadgeCircleNeutral(value: Int, modifier: Modifier = Modifier)

Cloud colored circled Badge.

BadgeCircleNeutralStrong

fun BadgeCircleNeutralStrong(value: Int, modifier: Modifier = Modifier)

Black colored circled Badge.

BadgeCircleNeutralSubtle

fun BadgeCircleNeutralSubtle(value: Int, modifier: Modifier = Modifier)

White colored circled Badge.

BadgeCircleSuccess

fun BadgeCircleSuccess(value: Int, modifier: Modifier = Modifier)

Green normal colored circled Badge.

BadgeCircleSuccessSubtle

fun BadgeCircleSuccessSubtle(value: Int, modifier: Modifier = Modifier)

Green light colored circled Badge.

BadgeCircleWarning

fun BadgeCircleWarning(value: Int, modifier: Modifier = Modifier)

Orange normal colored circled Badge.

BadgeCircleWarningSubtle

fun BadgeCircleWarningSubtle(value: Int, modifier: Modifier = Modifier)

Orange light colored circled Badge.

fun BadgeCritical(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

Red normal colored Badge.

BadgeCriticalSubtle

fun BadgeCriticalSubtle(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

Red light colored Badge.

fun BadgeInfo(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

Blue normal colored Badge.

BadgeInfoSubtle

fun BadgeInfoSubtle(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

Blue light colored Badge.

fun BadgeList(modifier: Modifier = Modifier, contentEmphasis: ContentEmphasis = ContentEmphasis.Normal, verticalArrangement: Arrangement.Vertical = Arrangement.spacedBy(8.dp), content: @Composable ColumnScope.() -> Unit)

BadgeListItemCritical

fun BadgeListItemCritical(icon: Painter, modifier: Modifier = Modifier, iconContentDescription: String? = null, content: @Composable () -> Unit)

BadgeListItemInfo

fun BadgeListItemInfo(icon: Painter, modifier: Modifier = Modifier, iconContentDescription: String? = null, content: @Composable () -> Unit)

BadgeListItemNeutral

fun BadgeListItemNeutral(icon: Painter, modifier: Modifier = Modifier, iconContentDescription: String? = null, content: @Composable () -> Unit)

BadgeListItemSuccess

fun BadgeListItemSuccess(icon: Painter, modifier: Modifier = Modifier, iconContentDescription: String? = null, content: @Composable () -> Unit)

BadgeListItemWarning

fun BadgeListItemWarning(icon: Painter, modifier: Modifier = Modifier, iconContentDescription: String? = null, content: @Composable () -> Unit)

fun BadgeListSmall(modifier: Modifier = Modifier, contentEmphasis: ContentEmphasis = ContentEmphasis.Normal, verticalArrangement: Arrangement.Vertical = Arrangement.spacedBy(8.dp), content: @Composable ColumnScope.() -> Unit)

fun BadgeNeutral(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

Cloud colored Badge.

BadgeNeutralStrong

fun BadgeNeutralStrong(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

Black colored Badge.

BadgeNeutralSubtle

fun BadgeNeutralSubtle(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

White colored Badge.

fun BadgePrimitive(backgroundColor: Color, modifier: Modifier = Modifier, borderStroke: BorderStroke? = null, contentColor: Color = contentColorFor(backgroundColor), backgroundBrush: Brush? = null, horizontalArrangement: Arrangement.Horizontal = BadgeDefaults.HorizontalArrangement, verticalAlignment: Alignment.Vertical = BadgeDefaults.VerticalAlignment, contentPadding: PaddingValues = BadgeDefaults.ContentPadding, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

fun BadgeSuccess(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

Green normal colored Badge.

BadgeSuccessSubtle

fun BadgeSuccessSubtle(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

Green light colored Badge.

fun BadgeWarning(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

Orange normal colored Badge.

BadgeWarningSubtle

fun BadgeWarningSubtle(modifier: Modifier = Modifier, icon: @Composable RowScope.() -> Unit = {}, content: @Composable RowScope.() -> Unit)

Orange light colored Badge.

ButtonBundleBasic

fun ButtonBundleBasic(onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable RowScope.() -> Unit)

Colored button for basic product level visualization.

ButtonBundleMedium

fun ButtonBundleMedium(onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable RowScope.() -> Unit)

Colored button for medium product level visualization.

ButtonBundleTop

fun ButtonBundleTop(onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable RowScope.() -> Unit)

Colored button for top product level visualization.

fun ButtonCritical(onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable RowScope.() -> Unit)

Button for critical action.

ButtonCriticalSubtle

fun ButtonCriticalSubtle(onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable RowScope.() -> Unit)

Button for critical action with subtle color variant.

ButtonLinkCritical

fun ButtonLinkCritical(onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable RowScope.() -> Unit)

ButtonLink with common button appearance.

ButtonLinkPrimary

fun ButtonLinkPrimary(onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable RowScope.() -> Unit)

ButtonLink with common button appearance.

ButtonLinkSecondary

fun ButtonLinkSecondary(onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable RowScope.() -> Unit)

ButtonLink with common button appearance.

fun ButtonPrimary(onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable RowScope.() -> Unit)

Primary button.

ButtonPrimarySubtle

fun ButtonPrimarySubtle(onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable RowScope.() -> Unit)

Primary button with subtle color variant.

ButtonPrimitive

fun ButtonPrimitive(onClick: () -> Unit, backgroundColor: Color, modifier: Modifier = Modifier, backgroundBrush: Brush? = null, contentColor: Color = contentColorFor(backgroundColor), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, shape: Shape = OrbitTheme.shapes.normal, textStyle: TextStyle = OrbitTheme.typography.bodyNormalMedium.copy(textAlign = TextAlign.Center), contentArrangement: Arrangement.Horizontal = ButtonDefaults.HorizontalArrangement, contentPadding: PaddingValues = ButtonDefaults.ContentPadding, content: @Composable RowScope.() -> Unit)

ButtonSecondary

fun ButtonSecondary(onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable RowScope.() -> Unit)

Secondary button.

ButtonTextLinkCritical

fun ButtonTextLinkCritical(text: String, onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Text aligning version of ButtonLink.

ButtonTextLinkPrimary

fun ButtonTextLinkPrimary(text: String, onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Text aligning version of ButtonLink.

ButtonTextLinkSecondary

fun ButtonTextLinkSecondary(text: String, onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Text aligning version of ButtonLink.

ButtonToggleContainer

fun <S> ButtonToggleContainer(targetState: S, modifier: Modifier = Modifier, transitionSpec: AnimatedContentTransitionScope<S>.() -> ContentTransform = { fadeIn(tween(AnimationDuration)) togetherWith fadeOut(tween(AnimationDuration)) }, contentAlignment: Alignment = Alignment.TopStart, content: @Composable AnimatedVisibilityScope.(targetState: S) -> Unit)

fun Card(modifier: Modifier = Modifier, title: @Composable () -> Unit = {}, action: @Composable () -> Unit = {}, description: @Composable () -> Unit = {}, contentPadding: PaddingValues = PaddingValues(16.dp), content: @Composable () -> Unit)

Rectangular surface that separates content into sections. For rounded and elevated card see SurfaceCard.

fun Checkbox(checked: Boolean, onCheckedChange: () -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, isError: Boolean = false, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

fun CheckboxField(checked: Boolean, onCheckedChange: () -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, isError: Boolean = false, contentPadding: PaddingValues = PaddingValues(horizontal = 16.dp, vertical = 12.dp), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, description: @Composable () -> Unit? = null, label: @Composable ColumnScope.() -> Unit)

fun ChoiceTile(selected: Boolean, onSelect: () -> Unit, modifier: Modifier = Modifier, isError: Boolean = false, icon: @Composable () -> Unit = {}, title: @Composable RowScope.() -> Unit = {}, description: @Composable () -> Unit = {}, footer: @Composable () -> Unit = {}, content: @Composable () -> Unit = {}, largeHeading: Boolean = true, showRadio: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

CircularProgressIndicator

fun CircularProgressIndicator(modifier: Modifier = Modifier, color: Color = CircularProgressIndicatorDefaults.circularColor, strokeWidth: Dp = CircularProgressIndicatorDefaults.circularStrokeWidth)

Indeterminate circular progress indicator.

fun ClickableField(value: String, onClick: () -> Unit, modifier: Modifier = Modifier, label: @Composable () -> Unit? = null, error: @Composable () -> Unit? = null, info: @Composable () -> Unit? = null, placeholder: @Composable () -> Unit? = null, leadingIcon: @Composable () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, singleLine: Boolean = true, maxLines: Int = if (singleLine) 1 else Int.MAX_VALUE, minLines: Int = 1, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

fun Collapse(expanded: Boolean, onExpandChange: (Boolean) -> Unit, title: @Composable () -> Unit, content: @Composable () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, withSeparator: Boolean = true)

Hides long or complex information under a block that can be hidden.

fun CountryFlag(countryCode: String, contentDescription: String?, modifier: Modifier = Modifier)

Implementation of Orbit CountryFlag

fun Coupon(code: String, onCopied: () -> Unit?, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Simple component used for highlighting coupons / promo codes.

fun Dialog(onDismissRequest: () -> Unit, title: @Composable () -> Unit, text: @Composable () -> Unit, buttons: @Composable ColumnScope.() -> Unit, modifier: Modifier = Modifier, illustration: @Composable () -> Unit = {}, properties: DialogProperties = DialogProperties())

Draws an Orbit-themed modal dialog with multiple actions.

fun Dialog(onDismissRequest: () -> Unit, title: @Composable () -> Unit, text: @Composable () -> Unit, confirmButton: @Composable () -> Unit, modifier: Modifier = Modifier, dismissButton: @Composable () -> Unit = {}, illustration: @Composable () -> Unit = {}, properties: DialogProperties = DialogProperties())

Draws an Orbit-themed modal dialog with either one or two actions.

fun EmptyState(illustration: Painter, title: String, modifier: Modifier = Modifier, description: String? = null, action: @Composable () -> Unit? = null)

fun EmptyState(illustration: @Composable () -> Unit, title: @Composable () -> Unit, modifier: Modifier = Modifier, description: @Composable () -> Unit? = null, action: @Composable () -> Unit? = null)

fun Icon(bitmap: ImageBitmap, contentDescription: String?, modifier: Modifier = Modifier, emphasis: ContentEmphasis = LocalContentEmphasis.current, tint: Color = LocalContentColor.current.applyEmphasis(emphasis))

fun Icon(painter: Painter, contentDescription: String?, modifier: Modifier = Modifier, emphasis: ContentEmphasis = LocalContentEmphasis.current, tint: Color = LocalContentColor.current.applyEmphasis(emphasis))

fun Icon(imageVector: ImageVector, contentDescription: String?, modifier: Modifier = Modifier, emphasis: ContentEmphasis = LocalContentEmphasis.current, tint: Color = LocalContentColor.current.applyEmphasis(emphasis))

Orbit Icon.

fun IconButton(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, rippleRadius: Dp = RippleRadius, minimumInteractiveComponentEnforcement: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)

fun InlineLoading(modifier: Modifier = Modifier, circleSize: Dp = 8.dp, circleDistance: Dp = 6.dp)

fun KeyValue(key: @Composable () -> Unit, value: @Composable () -> Unit, modifier: Modifier = Modifier)

fun KeyValue(key: String, value: String, modifier: Modifier = Modifier)

fun KeyValueLarge(key: @Composable () -> Unit, value: @Composable () -> Unit, modifier: Modifier = Modifier)

fun KeyValueLarge(key: String, value: String, modifier: Modifier = Modifier)

LinearIndeterminateProgressIndicator

fun LinearIndeterminateProgressIndicator(modifier: Modifier = Modifier, color: Color = OrbitTheme.colors.primary.strong, backgroundColor: Color = OrbitTheme.colors.surface.normal)

Linear indeterminate progress indicator.

LinearProgressIndicator

fun LinearProgressIndicator(@FloatRange(from = 0.0, to = 1.0) progress: Float, modifier: Modifier = Modifier, color: Color = OrbitTheme.colors.primary.strong, backgroundColor: Color = OrbitTheme.colors.surface.normal, progressAnimationSpec: AnimationSpec<Float> = SpringSpec( dampingRatio = Spring.DampingRatioNoBouncy, stiffness = Spring.StiffnessVeryLow, // The default threshold is 0.01, or 1% of the overall progress range, which is quite // large and noticeable. We purposefully choose a smaller threshold. visibilityThreshold = 1 / 1000f, ))

Linear progress indicator.

fun List(modifier: Modifier = Modifier, contentColor: Color = OrbitTheme.colors.content.normal, iconContentDescription: String? = null, iconTint: Color = Color.Unspecified, icon: Painter = Icons.CircleSmall, verticalArrangement: Arrangement.Vertical = Arrangement.spacedBy(4.dp, Alignment.Top), content: @Composable ListScope.() -> Unit)

Displays a simple list of items with customisable icons. Modify via passing a custom modifier.

fun ListChoice(modifier: Modifier = Modifier, icon: @Composable () -> Unit = {}, description: @Composable () -> Unit = {}, trailingIcon: @Composable () -> Unit = {}, withSeparator: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, title: @Composable () -> Unit)

fun ListChoice(onClick: () -> Unit, modifier: Modifier = Modifier, icon: @Composable () -> Unit = {}, description: @Composable () -> Unit = {}, trailingIcon: @Composable () -> Unit = {}, withSeparator: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, title: @Composable () -> Unit)

List choice component.

fun ListScope.ListItem(modifier: Modifier = Modifier, iconTint: Color = this.iconTint, icon: @Composable () -> Unit = { Icon( painter = this.icon, contentDescription = this.iconContentDescription, ) }, content: @Composable () -> Unit)

A single list item with customizable icon.

fun ListLarge(modifier: Modifier = Modifier, contentColor: Color = OrbitTheme.colors.content.normal, iconContentDescription: String? = null, iconTint: Color = Color.Unspecified, icon: Painter = Icons.CircleSmall, verticalArrangement: Arrangement.Vertical = Arrangement.spacedBy(4.dp, Alignment.Top), content: @Composable ListScope.() -> Unit)

Displays a simple list of items with customisable icons using a larger font. Modify via passing a custom modifier.

PasswordStrengthIndicator

fun PasswordStrengthIndicator(value: Float, color: Color, label: @Composable () -> Unit, modifier: Modifier = Modifier)

PasswordTextField

fun PasswordTextField(value: String, onValueChange: (String) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, readOnly: Boolean = false, strengthContent: @Composable () -> Unit? = null, label: @Composable () -> Unit? = null, error: @Composable () -> Unit? = null, info: @Composable () -> Unit? = null, placeholder: @Composable () -> Unit? = null, leadingIcon: @Composable () -> Unit? = null, onLeadingIconClick: () -> Unit? = null, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, keyboardActions: KeyboardActions = KeyboardActions.Default, singleLine: Boolean = true, maxLines: Int = if (singleLine) 1 else Int.MAX_VALUE, minLines: Int = 1, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

fun PillButtonContainerScope.PillButton(onClick: () -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, icon: @Composable () -> Unit = {}, content: @Composable () -> Unit = {})

An elevated pill-shaped button that displays given content and (optionally) an icon.

PillButtonContainer

fun PillButtonContainer(button: @Composable PillButtonContainerScope.() -> Unit, buttonVisible: Boolean, modifier: Modifier = Modifier, content: @Composable () -> Unit)

A host Composable for the PillButton Composable.

fun Radio(selected: Boolean, onClick: () -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, isError: Boolean = false, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

fun RadioField(selected: Boolean, onClick: () -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, isError: Boolean = false, contentPadding: PaddingValues = PaddingValues(horizontal = 16.dp, vertical = 12.dp), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, description: @Composable () -> Unit? = null, label: @Composable ColumnScope.() -> Unit)

fun RangeSlider(value: ClosedFloatingPointRange<Float>, onValueChange: (ClosedFloatingPointRange<Float>) -> Unit, valueLabel: @Composable (ClosedFloatingPointRange<Float>) -> Unit, startLabel: @Composable () -> Unit, endLabel: @Composable () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, valueRange: ClosedFloatingPointRange<Float> = 0f..1f, @IntRange(from = 0) steps: Int = 0, onValueChangeFinished: () -> Unit? = null, enableSystemGestureExclusion: Boolean = true, startInteractionSource: MutableInteractionSource = remember { MutableInteractionSource() }, endInteractionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Slider component for a single float value.

rememberToastHostState

fun rememberToastHostState(onActionClick: (String) -> Unit = {}, onDismiss: (String) -> Unit = {}): ToastHostState

rememberTopAppBarState

fun rememberTopAppBarState(initialOffsetLimit: Float = -Float.MAX_VALUE, initialOffset: Float = 0.0f, initialContentOffset: Float = 0.0f): TopAppBarState

Creates a TopAppBarState that is remembered across compositions.

fun Scaffold(modifier: Modifier = Modifier, topBar: @Composable () -> Unit = {}, action: @Composable () -> Unit = {}, backgroundColor: Color = OrbitTheme.colors.surface.main, contentColor: Color = contentColorFor(backgroundColor), actionLayout: @Composable () -> Unit = { ScaffoldAction( backgroundColor = backgroundColor, content = action, ) }, toastHostState: ToastHostState = rememberToastHostState(), toastHost: @Composable (ToastHostState) -> Unit = { ToastHost(it) }, contentWindowInsets: WindowInsets = WindowInsets.ime, content: @Composable (contentPadding: PaddingValues) -> Unit)

Scaffold helps layouting basic screen widgets, such as TopAppBar, action and the content.

fun ScaffoldAction(modifier: Modifier = Modifier, backgroundColor: Color = OrbitTheme.colors.surface.main, contentWindowInsets: WindowInsets = WindowInsets.systemBars, fadeHeight: Dp = DefaultActionFadeHeight, content: @Composable () -> Unit)

Draws action if there is any action's content. Adds additional padding and background to this action.

ScrollableTabRow

fun ScrollableTabRow(selectedTabIndex: Int, modifier: Modifier = Modifier, edgePadding: Dp = ScrollableTabRowPadding, indicator: @Composable (tabPositions: List<TabPosition>) -> Unit = { tabPositions -> TabIndicator( Modifier.tabIndicatorOffset(tabPositions[selectedTabIndex]), ) }, divider: @Composable () -> Unit = { Separator() }, tabs: @Composable () -> Unit)

SeatExtraLegroom

fun SeatExtraLegroom(selected: Boolean, label: @Composable () -> Unit, price: @Composable () -> Unit, onClick: () -> Unit, modifier: Modifier = Modifier)

SeatLegendExtraLegroom

fun SeatLegendExtraLegroom(modifier: Modifier = Modifier, content: @Composable RowScope.() -> Unit)

SeatLegendStandard

fun SeatLegendStandard(modifier: Modifier = Modifier, content: @Composable RowScope.() -> Unit)

SeatLegendUnavailable

fun SeatLegendUnavailable(modifier: Modifier = Modifier, content: @Composable RowScope.() -> Unit)

fun SeatStandard(selected: Boolean, label: @Composable () -> Unit, price: @Composable () -> Unit, onClick: () -> Unit, modifier: Modifier = Modifier)

SeatUnavailable

fun SeatUnavailable(contentDescription: String?, modifier: Modifier = Modifier)

SegmentedSwitch

fun SegmentedSwitch(onOptionClick: (selectedIndex: Int) -> Unit, options: List<@Composable () -> Unit>, selectedIndex: Int?, modifier: Modifier = Modifier, label: @Composable () -> Unit = {}, error: @Composable () -> Unit? = null, info: @Composable () -> Unit? = null)

A segmented switch displaying multiple options.

fun SegmentedSwitch(onOptionClick: (selectedIndex: Int) -> Unit, optionOne: @Composable () -> Unit, optionTwo: @Composable () -> Unit, selectedIndex: Int?, modifier: Modifier = Modifier, label: @Composable () -> Unit = {}, error: @Composable () -> Unit? = null, info: @Composable () -> Unit? = null)

A segmented switch displaying two options.

fun <T> SelectField(value: String, options: List<T>, onOptionSelect: (T) -> Unit, modifier: Modifier = Modifier, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, label: @Composable () -> Unit? = null, error: @Composable () -> Unit? = null, info: @Composable () -> Unit? = null, placeholder: @Composable () -> Unit? = null, leadingIcon: @Composable () -> Unit? = null, singleLine: Boolean = true, maxLines: Int = if (singleLine) 1 else Int.MAX_VALUE, minLines: Int = 1, optionContent: @Composable RowScope.(option: T) -> Unit)

fun Separator(modifier: Modifier = Modifier, color: Color = OrbitTheme.colors.surface.normal, thickness: Dp = 1.dp, startIndent: Dp = 0.dp)

fun Slider(value: Float, onValueChange: (Float) -> Unit, valueLabel: @Composable (Float) -> Unit, startLabel: @Composable () -> Unit, endLabel: @Composable () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, valueRange: ClosedFloatingPointRange<Float> = 0f..1f, @IntRange(from = 0) steps: Int = 0, onValueChangeFinished: () -> Unit? = null, enableSystemGestureExclusion: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Slider component for a single float value.

fun Stepper(value: Int, onValueChange: (Int) -> Unit, modifier: Modifier = Modifier, active: Boolean = value > 0, minValue: Int = 0, maxValue: Int = Int.MAX_VALUE)

fun Stepper(value: Int, active: Boolean, onValueChange: (Int) -> Unit, modifier: Modifier = Modifier, addContentDescription: String = stringResource(id = R.string.orbit_cd_stepper_add), removeContentDescription: String = stringResource(id = R.string.orbit_cd_stepper_remove), valueValidator: (Int) -> Boolean? = null)

fun Surface(modifier: Modifier = Modifier, shape: Shape = RectangleShape, color: Color = OrbitTheme.colors.surface.main, contentColor: Color = contentColorFor(color), border: BorderStroke? = null, elevation: Dp = OrbitTheme.elevations.None, content: @Composable () -> Unit)

fun Surface(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = RectangleShape, color: Color = OrbitTheme.colors.surface.main, contentColor: Color = contentColorFor(color), border: BorderStroke? = null, elevation: Dp = OrbitTheme.elevations.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)

fun Surface(selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = RectangleShape, color: Color = OrbitTheme.colors.surface.main, contentColor: Color = contentColorFor(color), border: BorderStroke? = null, elevation: Dp = OrbitTheme.elevations.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)

fun Surface(checked: Boolean, onCheckedChange: (Boolean) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = RectangleShape, color: Color = OrbitTheme.colors.surface.main, contentColor: Color = contentColorFor(color), border: BorderStroke? = null, elevation: Dp = OrbitTheme.elevations.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)

fun SurfaceCard(modifier: Modifier = Modifier, shape: Shape = OrbitTheme.shapes.normal, backgroundColor: Color = OrbitTheme.colors.surface.main, contentColor: Color = contentColorFor(backgroundColor), border: BorderStroke? = null, elevation: Dp = OrbitTheme.elevations.Level1, content: @Composable () -> Unit)

fun SurfaceCard(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = OrbitTheme.shapes.normal, backgroundColor: Color = OrbitTheme.colors.surface.main, contentColor: Color = contentColorFor(backgroundColor), border: BorderStroke? = null, elevation: Dp = OrbitTheme.elevations.Level1, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)

fun SurfaceCard(selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = OrbitTheme.shapes.normal, backgroundColor: Color = OrbitTheme.colors.surface.main, contentColor: Color = contentColorFor(backgroundColor), border: BorderStroke? = null, elevation: Dp = OrbitTheme.elevations.Level1, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)

fun Switch(checked: Boolean, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

fun Switch(checked: Boolean, onCheckedChange: (Boolean) -> Unit?, icon: Painter?, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

fun Tab(selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, text: @Composable () -> Unit)

fun TabIndicator(modifier: Modifier = Modifier, color: Color = OrbitTheme.colors.primary.normal)

fun TabRow(selectedTabIndex: Int, modifier: Modifier = Modifier, indicator: @Composable (tabPositions: List<TabPosition>) -> Unit = { tabPositions -> TabIndicator( Modifier.tabIndicatorOffset(tabPositions[selectedTabIndex]), ) }, divider: @Composable () -> Unit = { Separator() }, tabs: @Composable () -> Unit)

fun Tag(modifier: Modifier = Modifier, selected: Boolean = false, active: Boolean = false, onSelect: () -> Unit? = null, onRemove: () -> Unit? = null, removeContentDescription: String = stringResource(R.string.orbit_cd_tag_remove), content: @Composable RowScope.() -> Unit)

fun Text(text: String, modifier: Modifier = Modifier, color: Color = Color.Unspecified, emphasis: ContentEmphasis = LocalContentEmphasis.current, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textDecoration: TextDecoration? = null, textAlign: TextAlign = TextAlign.Unspecified, lineHeight: TextUnit = TextUnit.Unspecified, overflow: TextOverflow = TextOverflow.Clip, softWrap: Boolean = true, maxLines: Int = Int.MAX_VALUE, minLines: Int = 1, onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextStyle = LocalTextStyle.current)

fun Text(text: AnnotatedString, modifier: Modifier = Modifier, color: Color = Color.Unspecified, emphasis: ContentEmphasis = LocalContentEmphasis.current, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textDecoration: TextDecoration? = null, textAlign: TextAlign = TextAlign.Unspecified, lineHeight: TextUnit = TextUnit.Unspecified, overflow: TextOverflow = TextOverflow.Clip, softWrap: Boolean = true, maxLines: Int = Int.MAX_VALUE, minLines: Int = 1, inlineContent: Map<String, InlineTextContent> = mapOf(), onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextStyle = LocalTextStyle.current)

fun TextField(value: String, onValueChange: (String) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, readOnly: Boolean = false, label: @Composable () -> Unit? = null, error: @Composable () -> Unit? = null, info: @Composable () -> Unit? = null, placeholder: @Composable () -> Unit? = null, leadingIcon: @Composable () -> Unit? = null, onLeadingIconClick: () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, onTrailingIconClick: () -> Unit? = null, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, keyboardActions: KeyboardActions = KeyboardActions.Default, singleLine: Boolean = true, maxLines: Int = if (singleLine) 1 else Int.MAX_VALUE, minLines: Int = 1, visualTransformation: VisualTransformation = VisualTransformation.None, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

TextFiled control allowing a text single-line or multi-line input.

fun Tile(onClick: () -> Unit, modifier: Modifier = Modifier, trailingContent: @Composable RowScope.() -> Unit = { Icon(Icons.ChevronForward, null) }, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)

fun Tile(title: @Composable () -> Unit, onClick: () -> Unit, modifier: Modifier = Modifier, icon: @Composable () -> Unit = {}, description: @Composable () -> Unit = {}, trailingContent: @Composable RowScope.() -> Unit = { Icon(Icons.ChevronForward, null) }, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Elevated tile that represents an actionable item.

fun TileGroupScope.Tile(onClick: () -> Unit, modifier: Modifier = Modifier, trailingContent: @Composable RowScope.() -> Unit = { Icon(Icons.ChevronForward, null) }, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)

fun TileGroupScope.Tile(title: @Composable () -> Unit, onClick: () -> Unit, modifier: Modifier = Modifier, icon: @Composable () -> Unit = {}, description: @Composable () -> Unit = {}, trailingContent: @Composable RowScope.() -> Unit = { Icon(Icons.ChevronForward, null) }, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

A tile placeable within elevated TileGroup that represents an actionable item.

fun TileGroup(modifier: Modifier = Modifier, separatorStartIndent: Dp = 16.dp, content: @Composable TileGroupScope.() -> Unit)

Elevated tile group that represents a group of actionable items. Specifically designed to hold a group of TileGroupScope.Tiles.

fun Timeline(modifier: Modifier = Modifier, content: @Composable TimelineScope.() -> Unit)

Timeline container.

fun TimelineScope.TimelineItem(status: TimelineItemStatus, modifier: Modifier = Modifier, description: @Composable () -> Unit = {}, title: @Composable () -> Unit)

Timeline item.

fun Toast(toastData: ToastData)

fun ToastHost(hostState: ToastHostState, modifier: Modifier = Modifier, toast: @Composable (ToastData) -> Unit = { Toast(it) })

fun TopAppBar(title: @Composable () -> Unit, modifier: Modifier = Modifier, navigationIcon: @Composable () -> Unit = {}, actions: @Composable RowScope.() -> Unit = {}, extraContent: @Composable () -> Unit = {}, elevation: Dp = TopAppBarElevation, scrollBehavior: TopAppBarScrollBehavior? = null)

fun TopAppBar(title: @Composable () -> Unit, onNavigateUp: () -> Unit, modifier: Modifier = Modifier, navigationIcon: Painter = TopAppBarIcons.Back, actions: @Composable RowScope.() -> Unit = {}, extraContent: @Composable () -> Unit = {}, elevation: Dp = TopAppBarElevation, scrollBehavior: TopAppBarScrollBehavior? = null)

fun TopAppBarLarge(title: @Composable () -> Unit, modifier: Modifier = Modifier, navigationIcon: @Composable () -> Unit = {}, largeTitle: @Composable () -> Unit = title, actions: @Composable RowScope.() -> Unit = {}, extraContent: @Composable () -> Unit = {}, largeElevated: Boolean = true, elevation: Dp = TopAppBarElevation, scrollBehavior: TopAppBarScrollBehavior? = null)

fun TopAppBarLarge(title: @Composable () -> Unit, onNavigateUp: () -> Unit, modifier: Modifier = Modifier, largeTitle: @Composable () -> Unit = title, navigationIcon: Painter = TopAppBarIcons.Back, actions: @Composable RowScope.() -> Unit = {}, extraContent: @Composable () -> Unit = {}, largeElevated: Boolean = true, elevation: Dp = TopAppBarElevation, scrollBehavior: TopAppBarScrollBehavior? = null)