RemoteIconButtonDefaults
object RemoteIconButtonDefaults
Contains the default values used by RemoteIconButton.
Summary
Public functions |
|
|---|---|
RemoteIconButtonColors |
Returns a |
RemoteIconButtonColors |
@ComposableReturns a |
RemoteDp |
iconSizeFor(buttonSize: RemoteDp)Recommended icon size for a given icon button size. |
Public properties |
|
|---|---|
RemoteDp |
The default size applied for buttons. |
RemoteDp |
The default size of an icon when used inside an icon button of size DefaultButtonSize. |
RemoteFloat |
Recommended alpha to apply to an IconButton with Image content with disabled |
RemoteDp |
The recommended background size of an extra small, compact button. |
RemoteDp |
The recommended size for a large button. |
RemoteDp |
The size of an icon when used inside an icon button with size |
RemoteDp |
The recommended size for a small button. |
RemoteDp |
The recommended size of an icon when used inside an icon button with size |
RemoteRoundedCornerShape |
Recommended |
Public functions
iconButtonColors
@Composable
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
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 | |
|---|---|
containerColor: RemoteColor = RemoteColor(Color.Transparent) |
the background color of this text button when enabled |
contentColor: RemoteColor? = null |
the content color of this text button when enabled |
disabledContainerColor: RemoteColor = RemoteColor(Color.Transparent) |
the background color of this text button when not enabled |
disabledContentColor: RemoteColor? = null |
the content color of this text button when not enabled |
iconSizeFor
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 |
Public properties
DefaultButtonSize
val DefaultButtonSize: RemoteDp
The default size applied for buttons.
DefaultIconSize
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
val DisabledImageOpacity: RemoteFloat
Recommended alpha to apply to an IconButton with Image content with disabled
ExtraSmallButtonSize
val ExtraSmallButtonSize: RemoteDp
The recommended background size of an extra small, compact button.
LargeButtonSize
val LargeButtonSize: RemoteDp
The recommended size for a large button.
LargeIconSize
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
val SmallButtonSize: RemoteDp
The recommended size for a small button.
SmallIconSize
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
val shape: RemoteRoundedCornerShape
Recommended RemoteShape for RemoteIconButton.