• Home
• com.slack.circuit
• circuitx-gesture-navigation-jvm
• 0.24.0
• source code
• GestureNavigationDecoration.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.com.slack.circuitx.gesturenavigation.GestureNavigationDecoration.kt Maven / Gradle / Ivy

// Copyright (C) 2023 Slack Technologies, LLC
// SPDX-License-Identifier: Apache-2.0
package com.slack.circuitx.gesturenavigation

import com.slack.circuit.backstack.NavDecoration
import com.slack.circuit.foundation.NavigatorDefaults

/**
 * Returns a [NavDecoration] implementation which support navigation through appropriate gestures on
 * certain platforms.
 * * When running on Android 14 (or never) devices, this decoration supports Android's 'predictive
 *   back gesture'.
 * * When running on iOS, this decoration simulates iOS's 'interative pop gesture'.
 * * On other platforms, it defers to `NavigatorDefaults.DefaultDecoration`.
 *
 * @param fallback The [NavDecoration] which should be used when running on platforms which
 *   [GestureNavigationDecoration] does not support.
 * @param onBackInvoked A lambda which will be called when the user has invoked a 'back' gesture.
 *   Typically this should call `Navigator.pop()`.
 */
public expect fun GestureNavigationDecoration(
  fallback: NavDecoration = NavigatorDefaults.DefaultDecoration,
  onBackInvoked: () -> Unit,
): NavDecoration