RevealValue

public class RevealValue private constructor(public val value: Int)

Different values that determine the state of the SwipeToReveal composable, reflected in RevealState.currentValue. RevealValue.Covered is considered the default state where none of the actions are revealed yet.

SwipeToReveal direction is not localised, with the default being RevealDirection.RightToLeft, and RevealValue.RightRevealing and RevealValue.RightRevealed correspond to the actions getting revealed from the right side of the screen. In case swipe direction is set to RevealDirection.Both, actions can also get revealed from the left side of the screen, and in that case RevealValue.LeftRevealing and RevealValue.LeftRevealed are used.

Members

Companion

public companion object

Properties

LeftRevealed

public val LeftRevealed: RevealValue = RevealValue(-2)

The value which represents the state in which the whole revealable content is fully revealed, and they are displayed on the left side of the screen. This also represents the state in which one of the actions has been triggered/performed.

This is only used when the swipe direction is set to RevealDirection.Both, and the user swipes from the left side of the screen.

LeftRevealing

public val LeftRevealing: RevealValue = RevealValue(-1)

The value which represents the state in which all the actions are revealed and the top content is not being swiped. In this state, none of the actions have been triggered or performed yet, and they are displayed on the left side of the screen.

This is only used when the swipe direction is set to RevealDirection.Both, and the user swipes from the left side of the screen.

Covered

public val Covered: RevealValue = RevealValue(0)

The default first value which generally represents the state where the revealable actions have not been revealed yet. In this state, none of the actions have been triggered or performed yet.

RightRevealing

public val RightRevealing: RevealValue = RevealValue(1)

The value which represents the state in which all the actions are revealed and the top content is not being swiped. In this state, none of the actions have been triggered or performed yet, and they are displayed on the right side of the screen.

RightRevealed

public val RightRevealed: RevealValue = RevealValue(2)

The value which represents the state in which the whole revealable content is fully revealed, and the actions are revealed on the right side of the screen. This also represents the state in which one of the actions has been triggered/performed.