RemoteIconButtonDefaults

public object RemoteIconButtonDefaults

Contains the default values used by RemoteIconButton.

Properties

shape

public val shape: RemoteRoundedCornerShape

Recommended RemoteShape for RemoteIconButton.

DisabledImageOpacity

public val DisabledImageOpacity: RemoteFloat

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

SmallIconSize

public 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.

DefaultIconSize

public 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.

LargeIconSize

public 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

public val SmallButtonSize: RemoteDp

The recommended size for a small button.

DefaultButtonSize

public val DefaultButtonSize: RemoteDp

The default size applied for buttons.

LargeButtonSize

public val LargeButtonSize: RemoteDp

The recommended size for a large button.

ExtraSmallButtonSize

public val ExtraSmallButtonSize: RemoteDp

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

Functions

iconButtonColors

@Composable
public fun iconButtonColors(): RemoteIconButtonColors

Returns a iconButtonColors for a text 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

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

Returns a RemoteIconButtonColors for a text 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.

Parameters

iconSizeFor

public 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