SwipeToRevealDefaults

@ExperimentalWearMaterialApi
public object SwipeToRevealDefaults

Defaults for Material SwipeToReveal.

Properties

CardActionShape

public val CardActionShape: RoundedCornerShape

Recommended shape for SwipeToReveal actions when used with Card.

Delete

public val Delete: ImageVector

ImageVector for delete icon, often used for the primary action.

MoreOptions

public val MoreOptions: ImageVector

ImageVector for more options icon, often used for the secondary action.

RevealingRatio

public val RevealingRatio: Float

Default ratio of the content displayed when in RevealValue.RightRevealing state, i.e. all the actions are revealed and the top content is not being swiped. For example, a value of 0.7 means that 70% of the width is used to place the actions.

PositionalThreshold

public val PositionalThreshold: (totalDistance: Float) -> Float

Default position threshold that needs to be swiped in order to transition to the next state. Used in conjunction with RevealingRatio; for example, a threshold of 0.5 with a revealing ratio of 0.7 means that the user needs to swipe at least 35% (0.5 * 0.7) of the component width to go from RevealValue.Covered to RevealValue.RightRevealing and at least 85% (0.7 + 0.5 * (1 - 0.7)) of the component width to go from RevealValue.RightRevealing to RevealValue.RightRevealed.

Functions

actionColors

actionColors

@Composable
public fun actionColors(
    primaryActionBackgroundColor: Color = MaterialTheme.colors.error,
    primaryActionContentColor: Color = MaterialTheme.colors.onError,
    secondaryActionBackgroundColor: Color = MaterialTheme.colors.surface,
    secondaryActionContentColor: Color = MaterialTheme.colors.onSurface,
    undoActionBackgroundColor: Color = MaterialTheme.colors.surface,
    undoActionContentColor: Color = MaterialTheme.colors.onSurface,
): SwipeToRevealActionColors

The recommended colors used to display the contents of the primary, secondary and undo actions in SwipeToReveal.

Parameters

createRevealAnchors

createRevealAnchors

@SuppressWarnings("PrimitiveInCollection")
public fun createRevealAnchors(
    coveredAnchor: Float = 0f,
    revealingAnchor: Float = RevealingRatio,
    revealedAnchor: Float = 1f,
    revealDirection: RevealDirection = RevealDirection.RightToLeft,
): Map<RevealValue, Float>

Creates the required anchors to which the top content can be swiped, to reveal the actions. Each value should be in the range [0..1], where 0 represents right most end and 1 represents the full width of the top content starting from right and ending on left.

Parameters