createRevealAnchors

Function

Android

Deprecated The SwipeToReveal component from the latest material library should be used instead. This will be removed in a future release of this library.

@ExperimentalWearFoundationApi
@SuppressWarnings("PrimitiveInCollection")
public fun createRevealAnchors(
    coveredAnchor: Float = 0f,
    revealingAnchor: Float = SwipeToRevealDefaults.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

coveredAnchorAnchor for the RevealValue.Covered value
revealingAnchorAnchor for the RevealValue.LeftRevealing or RevealValue.RightRevealing value
revealedAnchorAnchor for the RevealValue.LeftRevealed or RevealValue.RightRevealed value
revealDirectionThe direction in which the content can be swiped. It's strongly advised to keep the default RevealDirection.RightToLeft in order to preserve compatibility with the system wide swipe to dismiss gesture.