value class RevealValue


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.

See also
RevealDirection

Summary

Public companion properties

RevealValue

The default first value which generally represents the state where the revealable actions have not been revealed yet.

RevealValue

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.

RevealValue

The value which represents the state in which all the actions are revealed and the top content is not being swiped.

RevealValue

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.

RevealValue

The value which represents the state in which all the actions are revealed and the top content is not being swiped.

Public properties

Int

Public companion properties

Covered

Added in 1.2.0
val CoveredRevealValue

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.

LeftRevealed

Added in 1.5.0-alpha10
val LeftRevealedRevealValue

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

Added in 1.5.0-alpha10
val LeftRevealingRevealValue

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.

RightRevealed

Added in 1.5.0-alpha10
val RightRevealedRevealValue

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.

RightRevealing

Added in 1.5.0-alpha10
val RightRevealingRevealValue

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.

Public properties

value

Added in 1.2.0
val valueInt