style/io.daio.wild.style

Package-level declarations

Types

@Immutable

data class Alpha(val alpha: Float = 1.0f, val focusedAlpha: Float = alpha, val hoveredAlpha: Float = alpha, val pressedAlpha: Float = alpha, val selectedAlpha: Float = alpha, val disabledAlpha: Float = DEFAULT_DISABLED_ALPHA, val focusedSelectedAlpha: Float = focusedAlpha, val pressedSelectedAlpha: Float = pressedAlpha, val hoveredSelectedAlpha: Float = hoveredAlpha, val focusedDisabledAlpha: Float = disabledAlpha, val pressedDisabledAlpha: Float = disabledAlpha, val hoveredDisabledAlpha: Float = disabledAlpha)

AlphaDefaults

object AlphaDefaults

Contains default Alpha presets for common interaction patterns.

Border

@Immutable

data class Border(val borderStroke: BorderStroke = BorderStroke(0.dp, Color.Unspecified), val inset: Dp = 0.dp, val shape: Shape = BorderDefaults.BorderDefaultShape)

BorderDefaults

object BorderDefaults

Contains default values and factory functions for Border.

Borders

@Immutable

data class Borders(val border: Border = BorderDefaults.None, val focusedBorder: Border = border, val hoveredBorder: Border = focusedBorder, val pressedBorder: Border = focusedBorder, val selectedBorder: Border = border, val disabledBorder: Border = border, val focusedSelectedBorder: Border = focusedBorder, val pressedSelectedBorder: Border = pressedBorder, val hoveredSelectedBorder: Border = hoveredBorder, val focusedDisabledBorder: Border = disabledBorder, val pressedDisabledBorder: Border = disabledBorder, val hoveredDisabledBorder: Border = disabledBorder)

Colors

@Immutable

data class Colors(val backgroundColor: Color, val focusedBackgroundColor: Color = backgroundColor, val pressedBackgroundColor: Color = focusedBackgroundColor, val hoveredBackgroundColor: Color = focusedBackgroundColor, val selectedBackgroundColor: Color = backgroundColor, val disabledBackgroundColor: Color = backgroundColor.copy(alpha = DEFAULT_DISABLED_ALPHA), val focusedSelectedBackgroundColor: Color = focusedBackgroundColor, val pressedSelectedBackgroundColor: Color = pressedBackgroundColor, val hoveredSelectedBackgroundColor: Color = hoveredBackgroundColor, val focusedDisabledBackgroundColor: Color = disabledBackgroundColor, val pressedDisabledBackgroundColor: Color = disabledBackgroundColor, val hoveredDisabledBackgroundColor: Color = disabledBackgroundColor, val contentColor: Color, val focusedContentColor: Color = contentColor, val hoveredContentColor: Color = focusedContentColor, val pressedContentColor: Color = focusedContentColor, val selectedContentColor: Color = contentColor, val focusedSelectedContentColor: Color = focusedContentColor, val pressedSelectedContentColor: Color = pressedContentColor, val hoveredSelectedContentColor: Color = hoveredContentColor, val disabledContentColor: Color = contentColor.copy(alpha = DEFAULT_DISABLED_ALPHA), val focusedDisabledContentColor: Color = disabledContentColor, val pressedDisabledContentColor: Color = disabledContentColor, val hoveredDisabledContentColor: Color = focusedDisabledContentColor)

ExpandedRoundedCornerShape

@Immutable

data class ExpandedRoundedCornerShape(val topStart: CornerSize, val topEnd: CornerSize, val bottomEnd: CornerSize, val bottomStart: CornerSize, val cornerExpansion: Dp) : Shape

A shape describing a rectangle with rounded corners, where each corner radius is expanded by an additional amount specified by cornerExpansion.

Scale

@Immutable

data class Scale(val scale: Float = 1.0f, val focusedScale: Float = scale, val hoveredScale: Float = focusedScale, val pressedScale: Float = focusedScale, val selectedScale: Float = scale, val disabledScale: Float = scale, val focusedSelectedScale: Float = focusedScale, val pressedSelectedScale: Float = pressedScale, val hoveredSelectedScale: Float = hoveredScale, val focusedDisabledScale: Float = disabledScale, val pressedDisabledScale: Float = disabledScale, val hoveredDisabledScale: Float = disabledScale)

ScaleDefaults

object ScaleDefaults

Contains default Scale presets for common interaction patterns.

Shapes

@Immutable

data class Shapes(val shape: Shape = RectangleShape, val focusedShape: Shape = shape, val hoveredShape: Shape = focusedShape, val pressedShape: Shape = focusedShape, val selectedShape: Shape = shape, val disabledShape: Shape = shape, val focusedSelectedShape: Shape = focusedShape, val pressedSelectedShape: Shape = pressedShape, val hoveredSelectedShape: Shape = hoveredShape, val focusedDisabledShape: Shape = disabledShape, val pressedDisabledShape: Shape = disabledShape, val hoveredDisabledShape: Shape = disabledShape)

Style

@Immutable

data class Style(val colors: Colors, val borders: Borders, val scale: Scale, val shapes: Shapes, val alpha: Alpha)

Style class for components.

StyleDefaults

object StyleDefaults

StyleScope

interface StyleScope : InteractionState

A scope used to define the style properties of the element.

StyleScopeDslMarker

@DslMarker

annotation class StyleScopeDslMarker

Properties

DEFAULT_DISABLED_ALPHA

const val DEFAULT_DISABLED_ALPHA: Float = 0.6f

Default alpha value for disabled states.

Functions

animateInteractionScaleAsState

@Composable

fun animateInteractionScaleAsState(targetScale: Float, pressed: Boolean, focused: Boolean, hovered: Boolean, label: String = "interaction-scale", visibilityThreshold: Float = 0.01f, finishedListener: (Float) -> Unit? = null, animationSpecProvider: (pressed: Boolean, focused: Boolean, hovered: Boolean) -> AnimationSpec<Float> = { press, focus, hover -> defaultScaleAnimationSpec(pressed = press, focused = focus, hovered = hover) }): State<Float>

Fire-and-forget animation function for Float. Using animateFloatAsState on the provided targetScale updating based on the current Interaction provided on the interactionSource.

Border

@Stable

fun Border(width: Dp = 0.dp, color: Color = Color.Unspecified, inset: Dp = 0.dp, shape: Shape = BorderDefaults.BorderDefaultShape): Border

clickable

fun Modifier.clickable(enabled: Boolean = true, interactionSource: MutableInteractionSource? = null, style: Style? = null, role: Role? = null, onLongClick: () -> Unit? = null, onDoubleClick: () -> Unit? = null, onClick: () -> Unit): Modifier

Interop Modifier.clickable to apply the correct clickable modifier based on the requirement for hardware input. For example if a Tv device is detected it adds support for hardware clicks from remote controls. This has the added support for Style, applying interactionStyle to update the component based on the current InteractionSource state.

experimentalClickable

fun Modifier.experimentalClickable(enabled: Boolean = true, interactionSource: MutableInteractionSource? = null, style: Style? = null, role: Role? = null, onLongClick: () -> Unit? = null, onDoubleClick: () -> Unit? = null, onClick: () -> Unit): Modifier

fun Modifier.experimentalClickable(enabled: Boolean = true, interactionSource: MutableInteractionSource? = null, style: StyleScope.() -> Unit? = null, role: Role? = null, onLongClick: () -> Unit? = null, onDoubleClick: () -> Unit? = null, onClick: () -> Unit): Modifier

Interop Modifier.clickable to apply the correct clickable modifier based on the requirement for hardware input. For example if a Tv device is detected it adds support for hardware clicks from remote controls. This has the added support for Style, applying experimentalInteractionStyle to update the component based on the current InteractionSource state.

experimentalInteractable

fun Modifier.experimentalInteractable(enabled: Boolean = true, selected: Boolean? = null, style: Style? = null, interactionSource: MutableInteractionSource? = null, role: Role? = null, onLongClick: () -> Unit? = null, onDoubleClick: () -> Unit? = null, onClick: () -> Unit): Modifier

fun Modifier.experimentalInteractable(enabled: Boolean = true, selected: Boolean? = null, style: StyleScope.() -> Unit? = null, interactionSource: MutableInteractionSource? = null, role: Role? = null, onLongClick: () -> Unit? = null, onDoubleClick: () -> Unit? = null, onClick: () -> Unit): Modifier

Interop Modifier to support either Modifier.selectable or Modifier.clickable, applying the correct modifier based on the requirement for hardware input. For example if a Tv device is detected it adds support for hardware clicks from remote controls. This has the added support for Style, applying experimentalInteractionStyle to update the component based on the current InteractionSource state.

experimentalInteractionStyle

fun Modifier.experimentalInteractionStyle(interactionSource: InteractionSource?, enabled: Boolean = true, selected: Boolean = false, style: Style): Modifier

fun Modifier.experimentalInteractionStyle(interactionSource: InteractionSource?, enabled: Boolean = true, selected: Boolean = false, block: StyleScope.() -> Unit): Modifier

Sets a Style on the element that reacts to interactions from the provided interactionSource.

experimentalSelectable

fun Modifier.experimentalSelectable(selected: Boolean, enabled: Boolean = true, interactionSource: MutableInteractionSource? = null, style: Style? = null, role: Role? = null, onLongClick: () -> Unit? = null, onDoubleClick: () -> Unit? = null, onClick: () -> Unit): Modifier

fun Modifier.experimentalSelectable(selected: Boolean, enabled: Boolean = true, interactionSource: MutableInteractionSource? = null, style: StyleScope.() -> Unit? = null, role: Role? = null, onLongClick: () -> Unit? = null, onDoubleClick: () -> Unit? = null, onClick: () -> Unit): Modifier

Interop Modifier.selectable to apply the correct selectable modifier based on the requirement for hardware input. For example if a Tv device is detected it adds support for hardware clicks from remote controls. This has the added support for Style, applying experimentalInteractionStyle to update

interactable

fun Modifier.interactable(enabled: Boolean = true, selected: Boolean? = null, style: Style? = null, interactionSource: MutableInteractionSource? = null, role: Role? = null, onLongClick: () -> Unit? = null, onDoubleClick: () -> Unit? = null, onClick: () -> Unit): Modifier

interactionStyle

fun Modifier.interactionStyle(interactionSource: InteractionSource?, enabled: Boolean = true, selected: Boolean = false, style: Style): Modifier

fun Modifier.interactionStyle(interactionSource: InteractionSource?, enabled: Boolean = true, selected: Boolean = false, block: StyleScope.() -> Unit): Modifier

Sets a Style on the element that reacts to interactions from the provided interactionSource.

isRoundedCornerShape

fun Shape.isRoundedCornerShape(): Boolean

Checks if this Shape is a RoundedCornerShape.

selectable

fun Modifier.selectable(selected: Boolean, enabled: Boolean = true, interactionSource: MutableInteractionSource? = null, style: Style? = null, role: Role? = null, onLongClick: () -> Unit? = null, onDoubleClick: () -> Unit? = null, onClick: () -> Unit): Modifier

toExpandedCornerShape

fun RoundedCornerShape.toExpandedCornerShape(cornerExpansion: Dp): ExpandedRoundedCornerShape

Converts a RoundedCornerShape to an ExpandedRoundedCornerShape by applying the specified cornerExpansion to all corners.

toExpandedCornerShapeOrSelf

fun Shape.toExpandedCornerShapeOrSelf(cornerExpansion: Dp): Shape

Converts this Shape to an ExpandedRoundedCornerShape if it is a RoundedCornerShape, otherwise returns the shape unchanged.