Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
class DisclosureState(expanded: Boolean = false)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class RadioGroupState(selectedOption: String? = null)
Link copied to clipboard
class SliderState(initialValue: Float, valueRange: ClosedFloatingPointRange<Float>, steps: Int)
Link copied to clipboard
class TabGroupScope(val state: TabGroupState)
Link copied to clipboard
class TabGroupState(initialTab: TabKey, tabs: List<TabKey>)
Link copied to clipboard
typealias TabKey = String

A unique identifier for a tab in a TabGroup.

Functions

Link copied to clipboard
fun Button(onClick: () -> Unit, 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, modifier: Modifier = Modifier, role: Role = Role.Button, indication: Indication? = LocalIndication.current, interactionSource: MutableInteractionSource? = null, horizontalArrangement: Arrangement.Horizontal = Arrangement.Center, verticalAlignment: Alignment.Vertical = Alignment.CenterVertically, content: @Composable RowScope.() -> Unit)

An accessible clickable component used to create buttons with the styling of your choice.

Link copied to clipboard
fun Checkbox(checked: Boolean, modifier: Modifier = Modifier, backgroundColor: Color = Color.Transparent, contentColor: Color = LocalContentColor.current, enabled: Boolean = true, onCheckedChange: (Boolean) -> Unit? = null, shape: Shape = RectangleShape, borderColor: Color = Color.Unspecified, borderWidth: Dp = 1.dp, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, indication: Indication? = LocalIndication.current, contentDescription: String? = null, checkIcon: @Composable () -> Unit)

A foundational component used to build checkboxes.

Link copied to clipboard
fun Disclosure(state: DisclosureState = rememberDisclosureState(), modifier: Modifier = Modifier, content: @Composable DisclosureScope.() -> Unit)

A foundational component used to build disclosure widgets.

Link copied to clipboard
fun DisclosureScope.DisclosureHeading(modifier: Modifier = Modifier, 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, indication: Indication = LocalIndication.current, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, verticalAlignment: Alignment.Vertical = Alignment.CenterVertically, horizontalArrangement: Arrangement.Horizontal = Arrangement.Start, content: @Composable () -> Unit)

A heading component that can be clicked to expand or collapse the DisclosurePanel.

fun DisclosureScope.DisclosureHeading(onClick: () -> Unit, modifier: Modifier = Modifier, 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, indication: Indication = LocalIndication.current, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, verticalAlignment: Alignment.Vertical = Alignment.CenterVertically, horizontalArrangement: Arrangement.Horizontal = Arrangement.Start, content: @Composable () -> Unit)
Link copied to clipboard
fun DisclosureScope.DisclosurePanel(modifier: Modifier = Modifier, enter: EnterTransition = AppearInstantly, exit: ExitTransition = DisappearInstantly, content: @Composable () -> Unit)

A panel component that is shown when the Disclosure is expanded.

Link copied to clipboard
expect fun Modal(onKeyEvent: (KeyEvent) -> Boolean = { false }, content: @Composable () -> Unit)
actual fun Modal(onKeyEvent: (KeyEvent) -> Boolean, content: () -> Unit)
actual fun Modal(onKeyEvent: (KeyEvent) -> Boolean, content: () -> Unit)
actual fun Modal(onKeyEvent: (KeyEvent) -> Boolean, content: () -> Unit)
Link copied to clipboard
fun ProgressIndicatorScope.ProgressBar(shape: Shape = RectangleShape, color: Color = LocalContentColor.current)

A progress bar component that automatically fills the width of its parent based on the progress value.

Link copied to clipboard
fun ProgressIndicator(modifier: Modifier = Modifier, shape: Shape = RectangleShape, backgroundColor: Color = Color.Unspecified, contentColor: Color = LocalContentColor.current, content: @Composable () -> Unit)
fun ProgressIndicator(@FloatRange(from = 0.0, to = 1.0) progress: Float, modifier: Modifier = Modifier, shape: Shape = RectangleShape, backgroundColor: Color = Color.Unspecified, contentColor: Color = LocalContentColor.current, content: @Composable ProgressIndicatorScope.() -> Unit)

A foundational component used to build progress indicators.

Link copied to clipboard
fun Radio(selected: Boolean, onSelectedChange: (Boolean) -> Unit, modifier: Modifier = Modifier, backgroundColor: Color = Color.Unspecified, contentColor: Color = Color.Unspecified, selectedColor: Color = Color.Unspecified, enabled: Boolean = true, shape: Shape = RectangleShape, borderColor: Color = Color.Unspecified, borderWidth: Dp = Dp.Unspecified, contentPadding: PaddingValues = NoPadding, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, indication: Indication? = LocalIndication.current, horizontalArrangement: Arrangement.Horizontal = Arrangement.Start, verticalAlignment: Alignment.Vertical = Alignment.Top, content: @Composable RowScope.() -> Unit)

A stateless version of Radio component.

Link copied to clipboard
fun RadioGroupScope.Radio(value: String, modifier: Modifier = Modifier, backgroundColor: Color = Color.Unspecified, contentColor: Color = Color.Unspecified, selectedColor: Color = Color.Unspecified, enabled: Boolean = true, shape: Shape = RectangleShape, borderColor: Color = Color.Unspecified, borderWidth: Dp = Dp.Unspecified, contentPadding: PaddingValues = NoPadding, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, indication: Indication? = LocalIndication.current, horizontalArrangement: Arrangement.Horizontal = Arrangement.Start, verticalAlignment: Alignment.Vertical = Alignment.Top, content: @Composable RowScope.() -> Unit)

A radio button component that can be selected within a RadioGroup.

Link copied to clipboard
fun RadioGroup(state: RadioGroupState, contentDescription: String?, modifier: Modifier = Modifier, content: @Composable RadioGroupScope.() -> Unit)

A foundational component used to build radio groups.

Link copied to clipboard

Creates a DisclosureState that can be used to manually control a Disclosure.

Link copied to clipboard

Creates a RadioGroupState that can be used to manually control a RadioGroup.

Link copied to clipboard
fun rememberSliderState(initialValue: Float = 0.0f, valueRange: ClosedFloatingPointRange<Float> = 0f..1f, @IntRange(from = 0) steps: Int = 0): SliderState

Creates a SliderState that is remembered across compositions.

Link copied to clipboard

Creates a TabGroupState.

Link copied to clipboard
fun Slider(state: SliderState, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, valueRange: ClosedFloatingPointRange<Float> = 0f..1f, orientation: Orientation = Orientation.Horizontal, track: @Composable () -> Unit, thumb: @Composable () -> Unit)

A foundational component used to build sliders.

Link copied to clipboard
fun TabGroupScope.Tab(key: TabKey, modifier: Modifier = Modifier, enabled: Boolean = true, indication: Indication = LocalIndication.current, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)

A single tab in a TabList.

Link copied to clipboard
fun TabGroup(state: TabGroupState, modifier: Modifier = Modifier, content: @Composable TabGroupScope.() -> Unit)

A foundational component used to build tabbed interfaces.

Link copied to clipboard
fun TabGroupScope.TabList(modifier: Modifier = Modifier, shape: Shape = RectangleShape, backgroundColor: Color = Color.Unspecified, orientation: Orientation = Orientation.Horizontal, activateOnFocus: Boolean = true, content: @Composable RowScope.() -> Unit)

A container holding all Tabs that can be selected withing a TabGroup.

Link copied to clipboard

The content panel for a tab.

Link copied to clipboard
fun Text(text: AnnotatedString, modifier: Modifier = Modifier, style: TextStyle = LocalTextStyle.current, textAlign: TextAlign = TextAlign.Unspecified, fontSize: TextUnit = style.fontSize, letterSpacing: TextUnit = style.letterSpacing, fontWeight: FontWeight? = style.fontWeight, color: Color = Color.Unspecified, lineHeight: TextUnit = TextUnit.Unspecified, fontFamily: FontFamily? = style.fontFamily, singleLine: Boolean = false, minLines: Int = 1, maxLines: Int = if (singleLine) 1 else Int.MAX_VALUE, overflow: TextOverflow = TextOverflow.Clip)
fun Text(text: String, modifier: Modifier = Modifier, style: TextStyle = LocalTextStyle.current, textAlign: TextAlign = TextAlign.Unspecified, lineHeight: TextUnit = TextUnit.Unspecified, fontSize: TextUnit = style.fontSize, letterSpacing: TextUnit = style.letterSpacing, fontWeight: FontWeight? = style.fontWeight, color: Color = Color.Unspecified, fontFamily: FontFamily? = style.fontFamily, singleLine: Boolean = false, minLines: Int = 1, maxLines: Int = if (singleLine) 1 else Int.MAX_VALUE, overflow: TextOverflow = TextOverflow.Clip)

A themable composable that displays text.

Link copied to clipboard
fun TextField(value: String, onValueChange: (String) -> Unit, editable: Boolean = true, modifier: Modifier = Modifier, contentPadding: PaddingValues = NoPadding, leadingIcon: @Composable () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, placeholder: String = "", contentColor: Color = LocalContentColor.current, disabledColor: Color = contentColor.copy(0.66f), backgroundColor: Color = Color.Unspecified, borderWidth: Dp = 1.dp, borderColor: Color = Color.Unspecified, shape: Shape = RectangleShape, textStyle: TextStyle = LocalTextStyle.current, textAlign: TextAlign = TextAlign.Unspecified, fontSize: TextUnit = TextUnit.Unspecified, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, singleLine: Boolean = false, minLines: Int = 1, maxLines: Int = if (singleLine) 1 else Int.MAX_VALUE, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, keyboardActions: KeyboardActions = KeyboardActions.Default, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, spacing: Dp = 8.dp, visualTransformation: VisualTransformation = VisualTransformation.None, verticalAlignment: Alignment.Vertical = Alignment.CenterVertically)

A foundational component used to build text fields.

Link copied to clipboard
fun Thumb(modifier: Modifier = Modifier, shape: Shape = RectangleShape, color: Color = Color.Unspecified)

A simple "Thumb" component. Intended to be used in Sliders and ToggleSwitchs but it is not tied to them.

Link copied to clipboard
fun ToggleSwitch(toggled: Boolean, modifier: Modifier = Modifier, onToggled: (Boolean) -> Unit? = null, enabled: Boolean = true, shape: Shape = RectangleShape, backgroundColor: Color = Color.Unspecified, contentPadding: PaddingValues = NoPadding, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, indication: Indication = LocalIndication.current, thumb: @Composable () -> Unit)

A foundational component used to build toggle switches.

Link copied to clipboard
suspend fun AwaitPointerEventScope.waitRelease(pass: PointerEventPass = PointerEventPass.Main): PointerInputChange?