RemoteTextToggleButtonDefaults

object RemoteTextToggleButtonDefaults


Contains the default values used by RemoteTextToggleButton.

Summary

Public functions

RemoteTextToggleButtonShapes

Creates a RemoteTextToggleButtonShapes with a static shape that animates to pressedShape when pressed.

RemoteTextToggleButtonColors

Creates a RemoteTextToggleButtonColors for a RemoteTextToggleButton - by default, a primary container when checked and a tonal container when unchecked.

RemoteTextToggleButtonColors
@Composable
@RemoteComposable
colors(
    checkedContainerColor: RemoteColor?,
    checkedContentColor: RemoteColor?,
    uncheckedContainerColor: RemoteColor?,
    uncheckedContentColor: RemoteColor?,
    disabledCheckedContainerColor: RemoteColor?,
    disabledCheckedContentColor: RemoteColor?,
    disabledUncheckedContainerColor: RemoteColor?,
    disabledUncheckedContentColor: RemoteColor?
)

Creates a RemoteTextToggleButtonColors for a RemoteTextToggleButton - by default, a primary container when checked and a tonal container when unchecked.

RemoteTextToggleButtonShapes

Creates a RemoteTextToggleButtonShapes with a static shape that doesn't change between the checked and unchecked states.

RemoteTextToggleButtonShapes

Creates a RemoteTextToggleButtonShapes with a static shape that doesn't change between the checked and unchecked states.

RemoteTextToggleButtonShapes

Creates a RemoteTextToggleButtonShapes where the toggle button changes from uncheckedShape to checkedShape when checked, and animates to a shape with smaller corners when pressed.

RemoteTextToggleButtonShapes

Creates a RemoteTextToggleButtonShapes where the toggle button changes from uncheckedShape to checkedShape when checked.

Public properties

RemoteDp

The recommended size for an extra large RemoteTextToggleButton.

RemoteDp

The recommended size for a large RemoteTextToggleButton.

RemoteDp

The default size applied for RemoteTextToggleButton.

RemoteCornerBasedShape

Recommended checked RemoteShape for RemoteTextToggleButton when using variantShapes or variantAnimatedShapes.

RemoteTextStyle

The recommended text style for a RemoteTextToggleButton of size ExtraLargeSize.

RemoteTextStyle

The recommended text style for a RemoteTextToggleButton of size LargeSize.

RemoteCornerBasedShape

Recommended pressed RemoteShape for RemoteTextToggleButton when using animatedShapes.

RemoteRoundedCornerShape

Recommended RemoteShape for RemoteTextToggleButton.

RemoteTextStyle

The default text style applied for RemoteTextToggleButton of size Size.

Public functions

animatedShapes

Added in 1.0.0-alpha16
@Composable
@RemoteComposable
fun animatedShapes(
    shape: RemoteCornerBasedShape = this.shape,
    pressedShape: RemoteCornerBasedShape = this.pressedShape
): RemoteTextToggleButtonShapes

Creates a RemoteTextToggleButtonShapes with a static shape that animates to pressedShape when pressed.

The press animation requires both shapes to be RemoteRoundedCornerShapes. It is driven by touch events on the player, and is not shown by players that don't dispatch them.

Parameters
shape: RemoteCornerBasedShape = this.shape

The shape of the toggle button when not pressed.

pressedShape: RemoteCornerBasedShape = this.pressedShape

The shape of the toggle button when pressed.

Returns
RemoteTextToggleButtonShapes

a RemoteTextToggleButtonShapes with the configured resting and pressed shapes

colors

Added in 1.0.0-alpha16
@Composable
@RemoteComposable
fun colors(): RemoteTextToggleButtonColors

Creates a RemoteTextToggleButtonColors for a RemoteTextToggleButton - by default, a primary container when checked and a tonal container when unchecked.

colors

Added in 1.0.0-alpha16
@Composable
@RemoteComposable
fun colors(
    checkedContainerColor: RemoteColor? = null,
    checkedContentColor: RemoteColor? = null,
    uncheckedContainerColor: RemoteColor? = null,
    uncheckedContentColor: RemoteColor? = null,
    disabledCheckedContainerColor: RemoteColor? = null,
    disabledCheckedContentColor: RemoteColor? = null,
    disabledUncheckedContainerColor: RemoteColor? = null,
    disabledUncheckedContentColor: RemoteColor? = null
): RemoteTextToggleButtonColors

Creates a RemoteTextToggleButtonColors for a RemoteTextToggleButton - by default, a primary container when checked and a tonal container when unchecked.

Parameters
checkedContainerColor: RemoteColor? = null

The container color of this toggle button when enabled and checked, or null to use the theme default.

checkedContentColor: RemoteColor? = null

The content color of this toggle button when enabled and checked, or null to use the theme default.

uncheckedContainerColor: RemoteColor? = null

The container color of this toggle button when enabled and unchecked, or null to use the theme default.

uncheckedContentColor: RemoteColor? = null

The content color of this toggle button when enabled and unchecked, or null to use the theme default.

disabledCheckedContainerColor: RemoteColor? = null

The container color of this toggle button when checked and not enabled, or null to use the theme default.

disabledCheckedContentColor: RemoteColor? = null

The content color of this toggle button when checked and not enabled, or null to use the theme default.

disabledUncheckedContainerColor: RemoteColor? = null

The container color of this toggle button when unchecked and not enabled, or null to use the theme default.

disabledUncheckedContentColor: RemoteColor? = null

The content color of this toggle button when unchecked and not enabled, or null to use the theme default.

shapes

Added in 1.0.0-alpha16
@Composable
@RemoteComposable
fun shapes(): RemoteTextToggleButtonShapes

Creates a RemoteTextToggleButtonShapes with a static shape that doesn't change between the checked and unchecked states.

shapes

Added in 1.0.0-alpha16
@Composable
@RemoteComposable
fun shapes(shape: RemoteShape): RemoteTextToggleButtonShapes

Creates a RemoteTextToggleButtonShapes with a static shape that doesn't change between the checked and unchecked states.

Parameters
shape: RemoteShape

The shape of the toggle button.

variantAnimatedShapes

Added in 1.0.0-alpha16
@Composable
@RemoteComposable
fun variantAnimatedShapes(
    uncheckedShape: RemoteCornerBasedShape = shape,
    checkedShape: RemoteCornerBasedShape = this.checkedShape
): RemoteTextToggleButtonShapes

Creates a RemoteTextToggleButtonShapes where the toggle button changes from uncheckedShape to checkedShape when checked, and animates to a shape with smaller corners when pressed.

Dynamic shape selection and the press animation require both shapes to be RemoteRoundedCornerShapes. The press animation is driven by touch events on the player, and is not shown by players that don't dispatch them.

Parameters
uncheckedShape: RemoteCornerBasedShape = shape

The shape of the toggle button when unchecked.

checkedShape: RemoteCornerBasedShape = this.checkedShape

The shape of the toggle button when checked.

Returns
RemoteTextToggleButtonShapes

a RemoteTextToggleButtonShapes with the configured unchecked, checked and pressed shapes

variantShapes

Added in 1.0.0-alpha16
@Composable
@RemoteComposable
fun variantShapes(
    uncheckedShape: RemoteCornerBasedShape = shape,
    checkedShape: RemoteCornerBasedShape = this.checkedShape
): RemoteTextToggleButtonShapes

Creates a RemoteTextToggleButtonShapes where the toggle button changes from uncheckedShape to checkedShape when checked.

The shape is selected at playback time when RemoteTextToggleButton's checked is not a constant, which requires both shapes to be RemoteRoundedCornerShapes.

Parameters
uncheckedShape: RemoteCornerBasedShape = shape

The shape of the toggle button when unchecked.

checkedShape: RemoteCornerBasedShape = this.checkedShape

The shape of the toggle button when checked.

Returns
RemoteTextToggleButtonShapes

a RemoteTextToggleButtonShapes with the configured unchecked and checked shapes

Public properties

ExtraLargeSize

Added in 1.0.0-alpha16
val ExtraLargeSize: RemoteDp

The recommended size for an extra large RemoteTextToggleButton.

LargeSize

Added in 1.0.0-alpha16
val LargeSize: RemoteDp

The recommended size for a large RemoteTextToggleButton.

Size

Added in 1.0.0-alpha16
val Size: RemoteDp

The default size applied for RemoteTextToggleButton.

extraLargeTextStyle

val extraLargeTextStyle: RemoteTextStyle

The recommended text style for a RemoteTextToggleButton of size ExtraLargeSize.

largeTextStyle

val largeTextStyle: RemoteTextStyle

The recommended text style for a RemoteTextToggleButton of size LargeSize.

pressedShape

val pressedShape: RemoteCornerBasedShape

Recommended pressed RemoteShape for RemoteTextToggleButton when using animatedShapes.

textStyle

val textStyle: RemoteTextStyle

The default text style applied for RemoteTextToggleButton of size Size.