circuitx/gesture-navigation/com.slack.circuitx.gesturenavigation

Package-level declarations

Types

interface GestureNavigationEventListener

Observes the back gesture lifecycle so side effects (e.g. analytics) can be wired into gesture navigation. This is purely observational, it does not drive navigation, the Navigator still owns the pop.

Functions

GestureNavigationDecorationFactory

actual fun GestureNavigationDecorationFactory(fallback: AnimatedNavDecorator.Factory, listener: GestureNavigationEventListener): AnimatedNavDecorator.Factory

Returns a AnimatedNavDecorator.Factory implementation which support navigation through appropriate gestures on certain platforms.

expect fun GestureNavigationDecorationFactory(fallback: AnimatedNavDecorator.Factory = NavigatorDefaults.DefaultDecoratorFactory, listener: GestureNavigationEventListener = GestureNavigationEventListener.NoOp): AnimatedNavDecorator.Factory

Returns a AnimatedNavDecorator.Factory implementation which support navigation through appropriate gestures on certain platforms.

actual fun GestureNavigationDecorationFactory(fallback: AnimatedNavDecorator.Factory, listener: GestureNavigationEventListener): AnimatedNavDecorator.Factory

A factory that creates an IOSPredictiveBackNavDecorator for iOS predictive back navigation.

actual fun GestureNavigationDecorationFactory(fallback: AnimatedNavDecorator.Factory, listener: GestureNavigationEventListener): AnimatedNavDecorator.Factory

Returns a AnimatedNavDecorator.Factory implementation which support navigation through appropriate gestures on certain platforms.

actual fun GestureNavigationDecorationFactory(fallback: AnimatedNavDecorator.Factory, listener: GestureNavigationEventListener): AnimatedNavDecorator.Factory

Returns a AnimatedNavDecorator.Factory implementation which support navigation through appropriate gestures on certain platforms.