RemoteIconButtonDefaults

Artifact: androidx.wear.compose.remote:remote-material3

object RemoteIconButtonDefaults

Contains the default values used by RemoteIconButton.

Summary

Public functions
`RemoteIconButtonColors`	`@Composable filledIconButtonColors()` Returns a `RemoteIconButtonColors` with the colors for a filled `RemoteIconButton` - by default, a colored background with a contrasting icon color.
`RemoteIconButtonColors`	`@Composable filledIconButtonColors( containerColor: RemoteColor?, contentColor: RemoteColor?, disabledContainerColor: RemoteColor?, disabledContentColor: RemoteColor? )` Returns a `RemoteIconButtonColors` with the colors for a filled `RemoteIconButton` - by default, a colored background with a contrasting icon color.
`RemoteIconButtonColors`	`@Composable filledTonalIconButtonColors()` Returns a `RemoteIconButtonColors` for a filled tonal `RemoteIconButton` with a muted background and contrasting content color.
`RemoteIconButtonColors`	`@Composable filledTonalIconButtonColors( containerColor: RemoteColor?, contentColor: RemoteColor?, disabledContainerColor: RemoteColor?, disabledContentColor: RemoteColor? )` Returns a `RemoteIconButtonColors` for a filled tonal `RemoteIconButton` with a muted background and contrasting content color.
`RemoteIconButtonColors`	`@Composable filledVariantIconButtonColors()` Returns a `RemoteIconButtonColors` with higher chroma container colors for `RemoteIconButton`.
`RemoteIconButtonColors`	`@Composable filledVariantIconButtonColors( containerColor: RemoteColor?, contentColor: RemoteColor?, disabledContainerColor: RemoteColor?, disabledContentColor: RemoteColor? )` Returns a `RemoteIconButtonColors` with higher chroma container colors for `RemoteIconButton`.
`RemoteIconButtonColors`	`@Composable iconButtonColors()` Returns a `RemoteIconButtonColors` for an icon button - by default, a transparent background with contrasting content color.
`RemoteIconButtonColors`	`@Composable iconButtonColors( containerColor: RemoteColor?, contentColor: RemoteColor?, disabledContainerColor: RemoteColor?, disabledContentColor: RemoteColor? )` Returns a `RemoteIconButtonColors` for an icon button - by default, a transparent background with contrasting content color.
`RemoteDp`	`iconSizeFor(buttonSize: RemoteDp)` Recommended icon size for a given icon button size.
`RemoteIconButtonColors`	`@Composable outlinedIconButtonColors()` Returns a `RemoteIconButtonColors` with a transparent background for outlined `RemoteIconButton`.
`RemoteIconButtonColors`	`@Composable outlinedIconButtonColors( contentColor: RemoteColor?, disabledContentColor: RemoteColor? )` Returns a `RemoteIconButtonColors` with a transparent background for outlined `RemoteIconButton`.

Public properties
`RemoteDp`	`DefaultButtonSize` The default size applied for buttons.
`RemoteDp`	`DefaultIconSize` The default size of an icon when used inside an icon button of size DefaultButtonSize.
`RemoteFloat`	`DisabledImageOpacity` Recommended alpha to apply to an IconButton with Image content with disabled
`RemoteDp`	`ExtraSmallButtonSize` The recommended background size of an extra small, compact button.
`RemoteDp`	`LargeButtonSize` The recommended size for a large button.
`RemoteDp`	`LargeIconSize` The size of an icon when used inside an icon button with size `LargeButtonSize`.
`RemoteDp`	`SmallButtonSize` The recommended size for a small button.
`RemoteDp`	`SmallIconSize` The recommended size of an icon when used inside an icon button with size `SmallButtonSize` or `ExtraSmallButtonSize`.
`RemoteRoundedCornerShape`	`shape` Recommended `RemoteShape` for `RemoteIconButton`.

Public functions

filledIconButtonColors

Added in 1.0.0-alpha12

@Composable
fun filledIconButtonColors(): RemoteIconButtonColors

Returns a RemoteIconButtonColors with the colors for a filled RemoteIconButton - by default, a colored background with a contrasting icon color.

filledIconButtonColors

Added in 1.0.0-alpha12

@Composable
fun filledIconButtonColors(
    containerColor: RemoteColor? = null,
    contentColor: RemoteColor? = null,
    disabledContainerColor: RemoteColor? = null,
    disabledContentColor: RemoteColor? = null
): RemoteIconButtonColors

Returns a RemoteIconButtonColors with the colors for a filled RemoteIconButton - by default, a colored background with a contrasting icon color.

Parameters
`containerColor: RemoteColor? = null`	The background color of this icon button when enabled.
`contentColor: RemoteColor? = null`	The color of this icon when enabled.
`disabledContainerColor: RemoteColor? = null`	The background color of this icon button when not enabled.
`disabledContentColor: RemoteColor? = null`	The color of this icon when not enabled.

filledTonalIconButtonColors

Added in 1.0.0-alpha12

@Composable
fun filledTonalIconButtonColors(): RemoteIconButtonColors

Returns a RemoteIconButtonColors for a filled tonal RemoteIconButton with a muted background and contrasting content color.

filledTonalIconButtonColors

Added in 1.0.0-alpha12

@Composable
fun filledTonalIconButtonColors(
    containerColor: RemoteColor? = null,
    contentColor: RemoteColor? = null,
    disabledContainerColor: RemoteColor? = null,
    disabledContentColor: RemoteColor? = null
): RemoteIconButtonColors

Returns a RemoteIconButtonColors for a filled tonal RemoteIconButton with a muted background and contrasting content color.

Parameters
`containerColor: RemoteColor? = null`	The background color of this icon button when enabled.
`contentColor: RemoteColor? = null`	The color of this icon when enabled.
`disabledContainerColor: RemoteColor? = null`	The background color of this icon button when not enabled.
`disabledContentColor: RemoteColor? = null`	The color of this icon when not enabled.

filledVariantIconButtonColors

Added in 1.0.0-alpha12

@Composable
fun filledVariantIconButtonColors(): RemoteIconButtonColors

Returns a RemoteIconButtonColors with higher chroma container colors for RemoteIconButton.

filledVariantIconButtonColors

Added in 1.0.0-alpha12

@Composable
fun filledVariantIconButtonColors(
    containerColor: RemoteColor? = null,
    contentColor: RemoteColor? = null,
    disabledContainerColor: RemoteColor? = null,
    disabledContentColor: RemoteColor? = null
): RemoteIconButtonColors

Returns a RemoteIconButtonColors with higher chroma container colors for RemoteIconButton.

Parameters
`containerColor: RemoteColor? = null`	The background color of this icon button when enabled.
`contentColor: RemoteColor? = null`	The color of this icon when enabled.
`disabledContainerColor: RemoteColor? = null`	The background color of this icon button when not enabled.
`disabledContentColor: RemoteColor? = null`	The color of this icon when not enabled.

iconButtonColors

Added in 1.0.0-alpha12

@Composable
fun iconButtonColors(): RemoteIconButtonColors

Returns a RemoteIconButtonColors for an icon button - by default, a transparent background with contrasting content color. If the button is disabled then the colors default to RemoteColorScheme.onSurface with suitable alpha values applied.

iconButtonColors

Added in 1.0.0-alpha12

@Composable
fun iconButtonColors(
    containerColor: RemoteColor? = null,
    contentColor: RemoteColor? = null,
    disabledContainerColor: RemoteColor? = null,
    disabledContentColor: RemoteColor? = null
): RemoteIconButtonColors

Parameters
`containerColor: RemoteColor? = null`	the background color of this icon button when enabled
`contentColor: RemoteColor? = null`	the content color of this icon button when enabled
`disabledContainerColor: RemoteColor? = null`	the background color of this icon button when not enabled
`disabledContentColor: RemoteColor? = null`	the content color of this icon button when not enabled

iconSizeFor

Added in 1.0.0-alpha12

fun iconSizeFor(buttonSize: RemoteDp): RemoteDp

Recommended icon size for a given icon button size.

Ensures that the minimum recommended icon size is applied.

Examples: for size LargeButtonSize, returns LargeIconSize, for size ExtraSmallButtonSize returns SmallIconSize.

Parameters
`buttonSize: RemoteDp`	The size of the icon button

outlinedIconButtonColors

Added in 1.0.0-alpha12

@Composable
fun outlinedIconButtonColors(): RemoteIconButtonColors

Returns a RemoteIconButtonColors with a transparent background for outlined RemoteIconButton.

outlinedIconButtonColors

Added in 1.0.0-alpha12

@Composable
fun outlinedIconButtonColors(
    contentColor: RemoteColor? = null,
    disabledContentColor: RemoteColor? = null
): RemoteIconButtonColors

Returns a RemoteIconButtonColors with a transparent background for outlined RemoteIconButton.

Parameters
`contentColor: RemoteColor? = null`	The color of this icon button when enabled.
`disabledContentColor: RemoteColor? = null`	The color of this icon when not enabled.

Public properties

DefaultButtonSize

Added in 1.0.0-alpha12

val DefaultButtonSize: RemoteDp

The default size applied for buttons.

DefaultIconSize

Added in 1.0.0-alpha12

val DefaultIconSize: RemoteDp

The default size of an icon when used inside an icon button of size DefaultButtonSize. Use iconSizeFor to easily determine the icon size.

DisabledImageOpacity

Added in 1.0.0-alpha12

val DisabledImageOpacity: RemoteFloat

Recommended alpha to apply to an IconButton with Image content with disabled

ExtraSmallButtonSize

Added in 1.0.0-alpha12

val ExtraSmallButtonSize: RemoteDp

The recommended background size of an extra small, compact button.

LargeButtonSize

Added in 1.0.0-alpha12

val LargeButtonSize: RemoteDp

The recommended size for a large button.

LargeIconSize

Added in 1.0.0-alpha12

val LargeIconSize: RemoteDp

The size of an icon when used inside an icon button with size LargeButtonSize. Use iconSizeFor to easily determine the icon size.

SmallButtonSize

Added in 1.0.0-alpha12

val SmallButtonSize: RemoteDp

The recommended size for a small button.

SmallIconSize

Added in 1.0.0-alpha12

val SmallIconSize: RemoteDp

The recommended size of an icon when used inside an icon button with size SmallButtonSize or ExtraSmallButtonSize. Use iconSizeFor to easily determine the icon size.

shape

Added in 1.0.0-alpha12

val shape: RemoteRoundedCornerShape

Recommended RemoteShape for RemoteIconButton.