RevealValue
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 SwipeDirection.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 SwipeDirection.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 | |
|---|---|
SwipeDirection |
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 |
This property is deprecated. Use RightRevealed instead. |
RevealValue |
This property is deprecated. Use RightRevealing instead. |
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 companion properties
Covered
val Covered: RevealValue
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
val LeftRevealed: 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. 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 SwipeDirection.Both, and the user swipes from the left side of the screen.
LeftRevealing
val LeftRevealing: RevealValue
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 SwipeDirection.Both, and the user swipes from the left side of the screen.
Revealed
val Revealed: RevealValue
The value which represents the state in which the whole revealable content is fully revealed. This also represents the state in which one of the actions has been triggered/performed.
Use RightRevealed instead.
Revealing
val Revealing: RevealValue
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.
Use RightRevealing instead.
RightRevealed
val RightRevealed: 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. This also represents the state in which one of the actions has been triggered/performed.
RightRevealing
val RightRevealing: RevealValue
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.