Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class DialogProperties(val dismissOnBackPress: Boolean = true, val dismissOnClickOutside: Boolean = true)

Properties that can be used to configure the behavior of a Dialog.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class MenuState(expanded: Boolean = false)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class ModalSheetProperties(val dismissOnBackPress: Boolean = true, val dismissOnClickOutside: Boolean = true)

Properties that control the behavior of a ModalBottomSheet.

Link copied to clipboard
Link copied to clipboard

Scope for the content of a ScrollArea.

Link copied to clipboard
interface ScrollAreaState

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

Link copied to clipboard

Scope for the scrollbars of a ScrollArea.

Link copied to clipboard
class SheetDetent(val identifier: String, val calculateDetentHeight: (containerHeight: Dp, sheetHeight: Dp) -> Dp)

A detent represents a stopping point for a bottom sheet.

Link copied to clipboard
sealed class ThumbVisibility

Properties

Link copied to clipboard
val DoNothing: () -> Unit
Link copied to clipboard
Link copied to clipboard

The maximum scroll offset of the scrollable content.

Functions

Link copied to clipboard
fun BottomSheet(state: BottomSheetState, modifier: Modifier = Modifier, enabled: Boolean = true, content: @Composable BottomSheetScope.() -> Unit)

A foundational component used to build bottom sheets.

Link copied to clipboard
fun Dialog(state: DialogState, properties: DialogProperties = DialogProperties(), onDismiss: () -> Unit = DoNothing, content: @Composable DialogScope.() -> Unit)

A stackable, renderless, highly performant foundational component to build dialogs with.

Link copied to clipboard
fun DialogScope.DialogPanel(modifier: Modifier = Modifier, enter: EnterTransition = AppearInstantly, exit: ExitTransition = DisappearInstantly, content: @Composable () -> Unit)

A container component that renders the dialog's panel and its contents.

Link copied to clipboard
fun BottomSheetScope.DragIndication(modifier: Modifier = Modifier, indication: Indication = rememberFocusRingIndication( ringColor = Color.Blue, ringWidth = 4.dp, paddingValues = PaddingValues(horizontal = 8.dp, vertical = 14.dp), cornerRadius = 8.dp ), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, onClickLabel: String? = "Toggle sheet")

A drag indication that can be used to control the bottom sheet.

Link copied to clipboard
fun ScrollAreaScope.HorizontalScrollbar(modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, reverseLayout2: Boolean = false, thumb: @Composable ScrollbarScope.() -> Unit)
Link copied to clipboard
fun HorizontalSeparator(color: Color, modifier: Modifier = Modifier, thickness: Dp = Dp.Hairline)

Creates a horizontal separator line.

Link copied to clipboard
fun Icon(imageBitmap: ImageBitmap, contentDescription: String?, modifier: Modifier = Modifier, tint: Color = LocalContentColor.current)
fun Icon(painter: Painter, contentDescription: String?, modifier: Modifier = Modifier, tint: Color = LocalContentColor.current)
fun Icon(imageVector: ImageVector, contentDescription: String?, modifier: Modifier = Modifier, tint: Color = LocalContentColor.current)

A foundational component used to display icons.

Link copied to clipboard
fun Menu(state: MenuState, modifier: Modifier = Modifier, content: @Composable MenuScope.() -> Unit)

fun Menu(modifier: Modifier = Modifier, state: MenuState = rememberMenuState(), ______deprecated: Unit, contents: @Composable MenuScope.() -> Unit)

An unstyled component for Compose Multiplatform that can be used to implement Dropdown Menus with the styling of your choice. Fully accessible, supports keyboard navigation and open/close animations.

Link copied to clipboard
fun MenuScope.MenuButton(modifier: Modifier = Modifier, mutableInteractionSource: MutableInteractionSource = remember { MutableInteractionSource() }, indication: Indication = LocalIndication.current, enabled: Boolean = true, shape: Shape = RectangleShape, backgroundColor: Color = Color.Unspecified, contentColor: Color = LocalContentColor.current, contentPadding: PaddingValues = NoPadding, borderColor: Color = Color.Unspecified, borderWidth: Dp = 0.dp, horizontalArrangement: Arrangement.Horizontal = Arrangement.Center, verticalAlignment: Alignment.Vertical = Alignment.CenterVertically, contents: @Composable () -> Unit)

A button component that triggers the menu's expanded state when clicked.

Link copied to clipboard
fun MenuScope.MenuContent(modifier: Modifier = Modifier, enter: EnterTransition = AppearInstantly, exit: ExitTransition = DisappearInstantly, alignment: Alignment.Horizontal = Alignment.Start, contents: @Composable () -> Unit)

The content container for the menu items. This composable handles the positioning and animation of the menu content when it is expanded.

Link copied to clipboard
fun MenuScope.MenuItem(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, indication: Indication = LocalIndication.current, contentPadding: PaddingValues = NoPadding, shape: Shape = RectangleShape, horizontalArrangement: Arrangement.Horizontal = Arrangement.Start, verticalAlignment: Alignment.Vertical = Alignment.CenterVertically, contents: @Composable RowScope.() -> Unit)

A menu item that can be clicked to perform an action and dismiss the menu.

Link copied to clipboard
fun ModalBottomSheet(state: ModalBottomSheetState, properties: ModalSheetProperties = ModalSheetProperties(), onDismiss: () -> Unit = DoNothing, content: @Composable ModalBottomSheetScope.() -> Unit)

A foundational component used to build modal bottom sheets.

Link copied to clipboard
fun rememberBottomSheetState(initialDetent: SheetDetent, detents: List<SheetDetent> = listOf(SheetDetent.Hidden, SheetDetent.FullyExpanded), animationSpec: AnimationSpec<Float> = tween(), confirmDetentChange: (SheetDetent) -> Boolean = { true }, decayAnimationSpec: DecayAnimationSpec<Float> = rememberSplineBasedDecay(), velocityThreshold: () -> Dp = { 125.dp }, positionalThreshold: (totalDistance: Dp) -> Dp = { 56.dp }): BottomSheetState
Link copied to clipboard
fun rememberDialogState(visible: Boolean = false, ____deprecated_constructor: Unit = Unit): DialogState

Creates a DialogState that can be used to control the visibility of a Dialog.

Link copied to clipboard
fun rememberFocusRingIndication(ringColor: Color = Color.Unspecified, ringWidth: Dp = Dp.Unspecified, paddingValues: PaddingValues = PaddingValues(), cornerRadius: Dp): Indication
Link copied to clipboard
Link copied to clipboard
fun rememberModalBottomSheetState(initialDetent: SheetDetent, detents: List<SheetDetent> = listOf(SheetDetent.Hidden, SheetDetent.FullyExpanded), animationSpec: AnimationSpec<Float> = tween(), velocityThreshold: () -> Dp = { 125.dp }, positionalThreshold: (totalDistance: Dp) -> Dp = { 56.dp }, confirmDetentChange: (SheetDetent) -> Boolean = { true }, decayAnimationSpec: DecayAnimationSpec<Float> = rememberSplineBasedDecay()): ModalBottomSheetState

Creates a ModalBottomSheetState that is remembered across compositions.

Link copied to clipboard
fun DialogScope.Scrim(modifier: Modifier = Modifier, scrimColor: Color = Color.Black.copy(0.6f), enter: EnterTransition = AppearInstantly, exit: ExitTransition = DisappearInstantly)

A component that renders a scrim behind the dialog panel.

fun ModalBottomSheetScope.Scrim(modifier: Modifier = Modifier, scrimColor: Color = Color.Black.copy(0.6f), enter: EnterTransition = AppearInstantly, exit: ExitTransition = DisappearInstantly)

A scrim is used to darken the content behind the sheet in order to signify that the rest of the screen is not interactive.

Link copied to clipboard
fun ScrollArea(state: ScrollAreaState, modifier: Modifier = Modifier, content: @Composable ScrollAreaScope.() -> Unit)
fun ScrollArea(state: ScrollAreaState, modifier: Modifier = Modifier, overscrollEffect: OverscrollEffect? = ScrollableDefaults.overscrollEffect(), overscrollEffectSides: List<OverscrollSides> = listOf( OverscrollSides.Vertical, OverscrollSides.Horizontal ), content: @Composable ScrollAreaScope.() -> Unit)

A foundational component used to build scrollable areas in Compose Multiplatform. The scroll area consists of a content area and optional scrollbars.

Link copied to clipboard
fun ColumnScope.Separator(modifier: Modifier = Modifier, color: Color = LocalContentColor.current, thickness: Dp = Dp.Hairline)

Creates a horizontal separator line within a ColumnScope.

fun RowScope.Separator(modifier: Modifier = Modifier, color: Color = LocalContentColor.current, thickness: Dp = Dp.Hairline)

Creates a vertical separator line within a RowScope.

Link copied to clipboard
fun ModalBottomSheetScope.Sheet(modifier: Modifier = Modifier, enabled: Boolean = true, content: @Composable BottomSheetScope.() -> Unit)

The main content area of the modal bottom sheet.

Link copied to clipboard
fun ScrollbarScope.Thumb(modifier: Modifier = Modifier, thumbVisibility: ThumbVisibility = ThumbVisibility.AlwaysVisible, enabled: Boolean = true)
Link copied to clipboard
fun ScrollAreaScope.VerticalScrollbar(modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, reverseLayout: Boolean = false, thumb: @Composable ScrollbarScope.() -> Unit)
Link copied to clipboard
fun VerticalSeparator(color: Color, modifier: Modifier = Modifier, thickness: Dp = Dp.Hairline)

Creates a vertical separator line.