compose-material/com.google.android.horologist.compose.material

Package-level declarations

Types

Link copied to clipboard
sealed class ButtonSize
Link copied to clipboard
Link copied to clipboard
object ToggleButtonDefaults

Contains the default values used by ToggleButton.

Link copied to clipboard

Functions

Link copied to clipboard
@Composable
fun AlertContent(modifier: Modifier = Modifier, onCancel: () -> Unit? = null, onOk: () -> Unit? = null, icon: @Composable () -> Unit? = null, title: String? = null, message: String? = null, okButtonContentDescription: String = stringResource(android.R.string.ok), cancelButtonContentDescription: String = stringResource(android.R.string.cancel), state: ScalingLazyColumnState = rememberColumnState( ScalingLazyColumnDefaults.responsive( additionalPaddingAtBottom = 0.dp, ), ), showPositionIndicator: Boolean = true, content: ScalingLazyListScope.() -> Unit? = null)
Link copied to clipboard
@Composable
fun AlertDialog(showDialog: Boolean, onDismiss: () -> Unit, modifier: Modifier = Modifier, icon: @Composable () -> Unit? = null, title: String? = null, message: String? = null, state: ScalingLazyColumnState = rememberColumnState( ScalingLazyColumnDefaults.responsive(), ), content: ScalingLazyListScope.() -> Unit? = null)
@Composable
fun AlertDialog(showDialog: Boolean, onCancel: () -> Unit, onOk: () -> Unit, modifier: Modifier = Modifier, icon: @Composable () -> Unit? = null, title: String? = null, message: String? = null, okButtonContentDescription: String = stringResource(android.R.string.ok), cancelButtonContentDescription: String = stringResource(android.R.string.cancel), state: ScalingLazyColumnState = rememberColumnState( ScalingLazyColumnDefaults.responsive(), ), content: ScalingLazyListScope.() -> Unit? = null)

This component is an alternative to AlertContent, providing the following:

Link copied to clipboard
@Composable
fun AnimatedLabel(label: String?, content: @Composable AnimatedContentScope.(targetState: String) -> Unit)

This composable provides an animated label that smoothly transitions between different text values. It uses animations for appearance, disappearance, and content changes.

Link copied to clipboard
@Composable
fun Button(imageVector: ImageVector, contentDescription: String, onClick: () -> Unit, modifier: Modifier = Modifier, onLongClick: () -> Unit? = null, colors: ButtonColors = ButtonDefaults.primaryButtonColors(), buttonSize: ButtonSize = ButtonSize.Default, enabled: Boolean = true)
@Composable
fun Button(@DrawableRes id: Int, contentDescription: String, onClick: () -> Unit, modifier: Modifier = Modifier, onLongClick: () -> Unit? = null, colors: ButtonColors = ButtonDefaults.primaryButtonColors(), buttonSize: ButtonSize = ButtonSize.Default, enabled: Boolean = true)

This component is an alternative to Button, providing the following:

Link copied to clipboard
@Composable
fun Card(onClick: () -> Unit, modifier: Modifier = Modifier, onLongClick: () -> Unit? = null, backgroundPainter: Painter = CardDefaults.cardBackgroundPainter(), contentColor: Color = MaterialTheme.colors.onSurfaceVariant, enabled: Boolean = true, contentPadding: PaddingValues = CardDefaults.ContentPadding, shape: Shape = MaterialTheme.shapes.large, role: Role? = null, content: @Composable ColumnScope.() -> Unit)

This component is an alternative to Card, adding support for long and double-clicks.

Link copied to clipboard
Link copied to clipboard
@Composable
fun Chip(@StringRes labelId: Int, onClick: () -> Unit, modifier: Modifier = Modifier, onLongClick: () -> Unit? = null, @StringRes secondaryLabel: Int? = null, icon: Paintable? = null, largeIcon: Boolean = false, colors: ChipColors = ChipDefaults.primaryChipColors(), enabled: Boolean = true)
@Composable
fun Chip(label: String, onClick: () -> Unit, modifier: Modifier = Modifier, onLongClick: () -> Unit? = null, secondaryLabel: String? = null, icon: @Composable BoxScope.() -> Unit? = null, largeIcon: Boolean = false, colors: ChipColors = ChipDefaults.primaryChipColors(), enabled: Boolean = true)
@Composable
fun Chip(label: String, onClick: () -> Unit, modifier: Modifier = Modifier, onLongClick: () -> Unit? = null, secondaryLabel: String? = null, iconRtlMode: Any? = null, icon: Paintable? = null, largeIcon: Boolean = false, colors: ChipColors = ChipDefaults.primaryChipColors(), enabled: Boolean = true)

This component is an alternative to Chip, providing the following:

@Composable
fun Chip(onClick: () -> Unit, colors: ChipColors, border: ChipBorder, modifier: Modifier = Modifier, onLongClick: () -> Unit? = null, enabled: Boolean = true, contentPadding: PaddingValues = ChipDefaults.ContentPadding, shape: Shape = MaterialTheme.shapes.large, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, role: Role = Role.Button, content: @Composable BoxScope.() -> Unit)
@Composable
fun Chip(label: @Composable RowScope.() -> Unit, onClick: () -> Unit, modifier: Modifier = Modifier, onLongClick: () -> Unit? = null, secondaryLabel: @Composable RowScope.() -> Unit? = null, icon: @Composable BoxScope.() -> Unit? = null, colors: ChipColors = ChipDefaults.primaryChipColors(), enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, contentPadding: PaddingValues = ChipDefaults.ContentPadding, shape: Shape = MaterialTheme.shapes.large, border: ChipBorder = ChipDefaults.chipBorder())

Temporary copy of Wear Compose Material Chip with support for onLongClick.

Link copied to clipboard
@Composable
fun ChipIconWithProgress(modifier: Modifier = Modifier, icon: Paintable? = null, largeIcon: Boolean = false, progressIndicatorColor: Color = MaterialTheme.colors.primary, progressTrackColor: Color = MaterialTheme.colors.onSurface.copy(alpha = 0.10f))

A default icon implementation to be used with a Chip that accepts an icon as slot. This implementation displays an icon with a circular progress indicator around it. The progress indicator is in an indeterminate state and spins indefinitely.

@Composable
fun ChipIconWithProgress(progress: Float, modifier: Modifier = Modifier, icon: Paintable? = null, largeIcon: Boolean = false, progressIndicatorColor: Color = MaterialTheme.colors.primary, progressTrackColor: Color = MaterialTheme.colors.onSurface.copy(alpha = 0.10f))

A default icon implementation to be used with a Chip that accepts an icon as slot. This implementation displays an icon with a circular progress indicator around it. The progress indicator express the proportion of completion of an ongoing task.

Link copied to clipboard
@Composable
fun CompactChip(icon: Paintable, contentDescription: String, onClick: () -> Unit, modifier: Modifier = Modifier, colors: ChipColors = ChipDefaults.primaryChipColors(), enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, border: ChipBorder = ChipDefaults.chipBorder())
@Composable
fun CompactChip(@StringRes labelId: Int, onClick: () -> Unit, modifier: Modifier = Modifier, icon: Paintable? = null, colors: ChipColors = ChipDefaults.primaryChipColors(), enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, border: ChipBorder = ChipDefaults.chipBorder())
@Composable
fun CompactChip(label: String, onClick: () -> Unit, modifier: Modifier = Modifier, icon: Paintable? = null, colors: ChipColors = ChipDefaults.primaryChipColors(), enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, border: ChipBorder = ChipDefaults.chipBorder())

This component is an alternative to CompactChip, providing the following:

Link copied to clipboard
@Composable
fun Confirmation(showDialog: Boolean, onTimeout: () -> Unit, modifier: Modifier = Modifier, icon: @Composable () -> Unit? = null, title: String? = null, durationMillis: Long = DialogDefaults.ShortDurationMillis, columnState: ScalingLazyColumnState = rememberColumnState( ScalingLazyColumnDefaults.responsive( verticalArrangement = confirmationVerticalArrangement(), additionalPaddingAtBottom = 0.dp, ), ))

This component is an alternative to ConfirmationContent, providing the following:

@Composable
fun Confirmation(onTimeout: () -> Unit, modifier: Modifier = Modifier, icon: @Composable ColumnScope.() -> Unit? = null, scrollState: ScalingLazyListState = rememberScalingLazyListState(), durationMillis: Long = DialogDefaults.ShortDurationMillis, backgroundColor: Color = MaterialTheme.colors.background, contentColor: Color = contentColorFor(backgroundColor), iconColor: Color = contentColor, verticalArrangement: Arrangement.Vertical = confirmationVerticalArrangement(), contentPadding: PaddingValues = DialogDefaults.ContentPadding, content: @Composable ColumnScope.() -> Unit)

A wrapper for Confirmation component, that calculates the value passed to durationMillis for accessibility.

Link copied to clipboard
@Composable
fun ConfirmationContent(icon: @Composable () -> Unit? = null, title: String? = null, columnState: ScalingLazyColumnState = rememberColumnState( ScalingLazyColumnDefaults.responsive( verticalArrangement = confirmationVerticalArrangement(), additionalPaddingAtBottom = 0.dp, ), ), showPositionIndicator: Boolean = true)
Link copied to clipboard
@Composable
fun Icon(paintable: PaintableIcon, contentDescription: String?, modifier: Modifier = Modifier, tint: Color = LocalContentColor.current.copy(alpha = LocalContentAlpha.current))

This component is an alternative to Icon, providing the following:

Link copied to clipboard
@Composable
fun NonScrollableAlertContent(onCancel: () -> Unit? = null, onOk: () -> Unit? = null, icon: @Composable () -> Unit? = null, title: String? = null, message: String? = null, okButtonContentDescription: String = stringResource(android.R.string.ok), cancelButtonContentDescription: String = stringResource(android.R.string.cancel), content: ScalingLazyListScope.() -> Unit? = null)
Link copied to clipboard
@Composable
fun OutlinedChip(@StringRes labelId: Int, onClick: () -> Unit, modifier: Modifier = Modifier, @StringRes secondaryLabel: Int? = null, icon: Paintable? = null, largeIcon: Boolean = false, colors: ChipColors = ChipDefaults.outlinedChipColors(), enabled: Boolean = true)
@Composable
fun OutlinedChip(label: String, onClick: () -> Unit, modifier: Modifier = Modifier, secondaryLabel: String? = null, icon: @Composable BoxScope.() -> Unit? = null, largeIcon: Boolean = false, colors: ChipColors = ChipDefaults.outlinedChipColors(), enabled: Boolean = true)
@Composable
fun OutlinedChip(label: String, onClick: () -> Unit, modifier: Modifier = Modifier, secondaryLabel: String? = null, iconRtlMode: Any? = null, icon: Paintable? = null, largeIcon: Boolean = false, colors: ChipColors = ChipDefaults.outlinedChipColors(), enabled: Boolean = true)

This component is an alternative to OutlinedChip, providing the following:

Link copied to clipboard
@Composable
fun OutlinedCompactChip(icon: Paintable, contentDescription: String, onClick: () -> Unit, modifier: Modifier = Modifier, colors: ChipColors = ChipDefaults.outlinedChipColors(), enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, border: ChipBorder = ChipDefaults.outlinedChipBorder())
@Composable
fun OutlinedCompactChip(@StringRes labelId: Int, onClick: () -> Unit, modifier: Modifier = Modifier, icon: Paintable? = null, colors: ChipColors = ChipDefaults.outlinedChipColors(), enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, border: ChipBorder = ChipDefaults.outlinedChipBorder())
@Composable
fun OutlinedCompactChip(label: String, onClick: () -> Unit, modifier: Modifier = Modifier, icon: Paintable? = null, colors: ChipColors = ChipDefaults.outlinedChipColors(), enabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, border: ChipBorder = ChipDefaults.outlinedChipBorder())

This component is an alternative to OutlinedCompactChip, providing the following:

Link copied to clipboard
@Composable
fun ResponsiveButton(icon: ImageVector, contentDescription: String, onClick: () -> Unit, buttonWidth: Dp, colors: ChipColors = ChipDefaults.primaryChipColors())
Link copied to clipboard
@Composable
fun responsiveButtonWidth(buttonCount: Int): Pair<Dp, Dp>
Link copied to clipboard
@Composable
fun ResponsiveDialogContent(modifier: Modifier = Modifier, icon: @Composable () -> Unit? = null, title: @Composable () -> Unit? = null, message: @Composable () -> Unit? = null, onOk: () -> Unit? = null, onCancel: () -> Unit? = null, okButtonContentDescription: String = stringResource(android.R.string.ok), cancelButtonContentDescription: String = stringResource(android.R.string.cancel), state: ScalingLazyColumnState = rememberResponsiveColumnState( contentPadding = ScalingLazyColumnDefaults.padding( first = ScalingLazyColumnDefaults.ItemType.Dialog, last = ScalingLazyColumnDefaults.ItemType.Dialog, ), ), showPositionIndicator: Boolean = true, content: ScalingLazyListScope.() -> Unit? = null)
Link copied to clipboard
@Composable
fun ResponsiveListHeader(modifier: Modifier = Modifier, backgroundColor: Color = Color.Transparent, contentColor: Color = MaterialTheme.colors.onSurfaceVariant, contentPadding: PaddingValues = ListHeaderDefaults.itemPadding(), content: @Composable RowScope.() -> Unit)
Link copied to clipboard
@Composable
fun SecondaryTitle(@StringRes textId: Int, modifier: Modifier = Modifier, icon: ImageVector? = null, iconSize: Dp = 24.dp)
@Composable
fun SecondaryTitle(text: String, modifier: Modifier = Modifier, icon: ImageVector? = null, iconTint: Color = MaterialTheme.colors.onBackground, iconSize: Dp = 24.dp)

A secondary title heading to group and identify items with optional icon.

Link copied to clipboard
@Composable
fun SplitToggleChip(checked: Boolean, onCheckedChanged: (Boolean) -> Unit, label: String, onClick: () -> Unit, toggleControl: ToggleChipToggleControl, modifier: Modifier = Modifier, secondaryLabel: String? = null, colors: SplitToggleChipColors = ToggleChipDefaults.splitToggleChipColors(), enabled: Boolean = true, checkedInteractionSource: MutableInteractionSource = remember { MutableInteractionSource() }, clickInteractionSource: MutableInteractionSource = remember { MutableInteractionSource() })

This component is an alternative to SplitToggleChip, providing the following:

Link copied to clipboard
@Composable
fun Stepper(value: Int, onValueChange: (Int) -> Unit, valueProgression: IntProgression, modifier: Modifier = Modifier, decreaseIcon: @Composable () -> Unit = { Icon( StepperDefaults.Decrease.asPaintable(), stringResource(R.string.horologist_stepper_decrease_content_description), ) }, increaseIcon: @Composable () -> Unit = { Icon( StepperDefaults.Increase.asPaintable(), stringResource(R.string.horologist_stepper_increase_content_description), ) }, backgroundColor: Color = MaterialTheme.colors.background, contentColor: Color = contentColorFor(backgroundColor), iconColor: Color = contentColor, enableRangeSemantics: Boolean = true, content: @Composable BoxScope.() -> Unit)
@Composable
fun Stepper(value: Float, onValueChange: (Float) -> Unit, steps: Int, modifier: Modifier = Modifier, decreaseIcon: @Composable () -> Unit = { Icon( StepperDefaults.Decrease.asPaintable(), stringResource(R.string.horologist_stepper_decrease_content_description), ) }, increaseIcon: @Composable () -> Unit = { Icon( StepperDefaults.Increase.asPaintable(), stringResource(R.string.horologist_stepper_increase_content_description), ) }, valueRange: ClosedFloatingPointRange<Float> = 0f..(steps + 1).toFloat(), backgroundColor: Color = MaterialTheme.colors.background, contentColor: Color = contentColorFor(backgroundColor), iconColor: Color = contentColor, enableRangeSemantics: Boolean = true, content: @Composable BoxScope.() -> Unit)

Wrapper for androidx.wear.compose.material.Stepper with default RSB scroll support.

Link copied to clipboard
@Composable
fun Title(@StringRes textId: Int, modifier: Modifier = Modifier)
@Composable
fun Title(text: String, modifier: Modifier = Modifier)

A primary title heading to group and identify items.

Link copied to clipboard
@Composable
fun ToggleButton(text: String, onCheckedChanged: (Boolean) -> Unit, modifier: Modifier = Modifier, checked: Boolean = true, enabled: Boolean = true, colors: ToggleButtonColors = ToggleButtonDefaults.toggleButtonColors(), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, shape: Shape = CircleShape, role: Role = ToggleButtonDefaults.DefaultRole, smallSize: Boolean = false)

This component is an alternative to ToggleButton, providing the following:

@Composable
fun ToggleButton(checkedIcon: PaintableIcon, notCheckedIcon: PaintableIcon, contentDescription: String, onCheckedChanged: (Boolean) -> Unit, modifier: Modifier = Modifier, checked: Boolean = true, enabled: Boolean = true, colors: ToggleButtonColors = ToggleButtonDefaults.toggleButtonColors(), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, shape: Shape = CircleShape, role: Role = ToggleButtonDefaults.DefaultRole, smallSize: Boolean = false)

§ This component is an alternative to ToggleButton, providing the following:

Link copied to clipboard
@Composable
fun ToggleChip(checked: Boolean, onCheckedChanged: (Boolean) -> Unit, label: String, toggleControl: ToggleChipToggleControl, modifier: Modifier = Modifier, icon: PaintableIcon? = null, secondaryLabel: String? = null, colors: ToggleChipColors = ToggleChipDefaults.toggleChipColors(), enabled: Boolean = true, interactionSource: MutableInteractionSource? = null, iconTint: Color = Color.Unspecified)

This component is an alternative to ToggleChip, providing the following: