SwipeToRevealCard
Android
@ExperimentalWearMaterialApi
@Composable
public fun SwipeToRevealCard(
primaryAction: @Composable () -> Unit,
revealState: RevealState,
onFullSwipe: () -> Unit,
modifier: Modifier = Modifier,
secondaryAction: @Composable (() -> Unit)? = null,
undoPrimaryAction: @Composable (() -> Unit)? = null,
undoSecondaryAction: @Composable (() -> Unit)? = null,
colors: SwipeToRevealActionColors = SwipeToRevealDefaults.actionColors(),
shape: Shape = SwipeToRevealDefaults.CardActionShape,
content: @Composable () -> Unit,
)Parameters
| primaryAction | A composable to describe the primary action when swiping. The action will be triggered on clicking the action. See SwipeToRevealPrimaryAction. |
| revealState | RevealState of the SwipeToReveal |
| onFullSwipe | A lambda which will be triggered on full swipe from either of the anchors. We recommend to keep this similar to primary action click action. This sets the RevealState.lastActionType to RevealActionType.PrimaryAction. |
| modifier | Modifier to be applied on the composable |
| secondaryAction | A composable to describe the contents of secondary action.The action will be triggered on clicking the action. See SwipeToRevealSecondaryAction |
| undoPrimaryAction | A composable to describe the contents of undo action when the primary action was triggered. See SwipeToRevealUndoAction |
| undoSecondaryAction | A composable to describe the contents of undo action when secondary action was triggered. See SwipeToRevealUndoAction |
| colors | An instance of SwipeToRevealActionColors to describe the colors of actions. See SwipeToRevealDefaults.actionColors. |
| shape | The shape of primary and secondary action composables. Recommended shape for cards is SwipeToRevealDefaults.CardActionShape. |
| content | The initial content shown prior to the swipe-to-reveal gesture. Custom accessibility actions should always be added to the content using androidx.compose.ui.semantics.semantics - examples are shown in the code samples. |
