architecture-compose/com.splendo.kaluga.architecture.compose.navigation

Package-level declarations

Types

BottomSheetComposableNavSpec

sealed class BottomSheetComposableNavSpec

The specification for navigating from a ModalBottomSheetLayout

BottomSheetContentBuilder

typealias BottomSheetContentBuilder = NavGraphBuilder.(bottomSheetNavigationState: StateFlow<BottomSheetNavigatorState?>) -> Unit

BottomSheetContentNavHostComposableNavigator

class BottomSheetContentNavHostComposableNavigator<Action : NavigationAction<*>>(bottomSheetNavigator: StateFlow<BottomSheetNavigatorState?>, resultHandlers: List<NavHostResultHandler<*, *>> = emptyList(), parentRouteController: RouteController? = null, navigationMapper: @Composable (Action) -> ComposableNavSpec) : ProvidingNavHostComposableNavigator<Action, BottomSheetNavigatorState>

A ProvidingNavHostComposableNavigator that navigates for the BottomSheetNavigatorState.contentNavHostController of a flow of BottomSheetNavigatorState

BottomSheetContentRouteController

class BottomSheetContentRouteController(provider: StateFlow<BottomSheetNavigatorState?>, parentRouteController: RouteController? = null) : ProvidingNavHostRouteController<BottomSheetNavigatorState>

ProvidingNavHostRouteController where the NavHostController is provided by the content of a BottomSheetNavigatorState

BottomSheetLaunchedNavigation

data class BottomSheetLaunchedNavigation(val launchedNavigation: ComposableNavSpec.LaunchedNavigation) : BottomSheetComposableNavSpec

A BottomSheetComposableNavSpec that executes a ComposableNavSpec.LaunchedNavigation when navigating.

BottomSheetNavigator

sealed class BottomSheetNavigator<Action : NavigationAction<*>> : Navigator<Action> , ComposableLifecycleSubscribable

A Navigator managed by a BottomSheetRouteController.

BottomSheetNavigatorState

data class BottomSheetNavigatorState(val contentNavHostController: NavHostController, val sheetContentNavHostController: NavHostController, val sheetState: ModalBottomSheetState)

The State of a BottomSheetNavigator

BottomSheetRoute

sealed class BottomSheetRoute : BottomSheetComposableNavSpec

A BottomSheetComposableNavSpec for navigating using a Route

BottomSheetRouteController

class BottomSheetRouteController(contentRouteController: RouteController, sheetContentRouteController: BottomSheetSheetContentRouteController)

A controller that handles the BottomSheetRoute for a ModalBottomSheetLayout

BottomSheetSheetContentNavHostComposableNavigator

class BottomSheetSheetContentNavHostComposableNavigator<Action : NavigationAction<*>>(bottomSheetNavigator: StateFlow<BottomSheetNavigatorState?>, resultHandlers: List<NavHostResultHandler<*, *>> = emptyList(), navigationMapper: @Composable (Action) -> ComposableNavSpec) : ComposableNavigator<Action>

A ComposableNavigator that navigates for the sheet content of a flow of BottomSheetNavigatorState

BottomSheetSheetContentRouteController

class BottomSheetSheetContentRouteController(bottomSheetNavigatorState: StateFlow<BottomSheetNavigatorState?>, coroutineScope: StateFlow<CoroutineScope?>) : RouteController

RouteController for the sheet content of a BottomSheetNavigatorState

ComposableNavigator

sealed class ComposableNavigator<Action : NavigationAction<*>> : Navigator<Action> , ComposableLifecycleSubscribable

A Navigator managed by a RouteController

ComposableNavSpec

sealed class ComposableNavSpec

Spec for navigating with a ComposableNavigator

LaunchedComposableNavigator

class LaunchedComposableNavigator<Action : NavigationAction<*>>(navigationMapper: @Composable (Action) -> ComposableNavSpec.LaunchedNavigation) : ComposableNavigator<Action>

A ComposableNavigator that only supports ComposableNavSpec.LaunchedNavigation navigation.

ModalBottomSheetNavigator

class ModalBottomSheetNavigator<Action : NavigationAction<*>>(bottomSheetNavigatorState: StateFlow<BottomSheetNavigatorState?>, contentResultHandlers: List<NavHostResultHandler<*, *>> = emptyList(), sheetContentResultHandlers: List<NavHostResultHandler<*, *>> = emptyList(), navigationMapper: @Composable (Action) -> BottomSheetComposableNavSpec) : BottomSheetNavigator<Action>

A BottomSheetNavigator that is managed by a ModalBottomSheetLayout. Must have a ModalBottomSheetLayout set up higher in the View-hierarchy.

NavHostComposableNavigator

class NavHostComposableNavigator<Action : NavigationAction<*>>(navHostController: StateFlow<NavHostController?>, resultHandlers: List<NavHostResultHandler<*, *>> = emptyList(), parentRouteController: RouteController? = null, navigationMapper: @Composable (Action) -> ComposableNavSpec) : ProvidingNavHostComposableNavigator<Action, NavHostController>

A ProvidingNavHostComposableNavigator that navigates for a flow of NavHostController

NavHostRouteController

class NavHostRouteController(provider: StateFlow<NavHostController?>, parentRouteController: RouteController? = null) : ProvidingNavHostRouteController<NavHostController>

Simple ProvidingNavHostRouteController where the provider is a flow of NavHostController

ProvidingNavHostComposableNavigator

sealed class ProvidingNavHostComposableNavigator<Action : NavigationAction<*>, Provider> : ComposableNavigator<Action>

A ComposableNavigator that is managed by a NavHost. Must have a NavHost set up higher up in the View-hierarchy.

ProvidingNavHostRouteController

sealed class ProvidingNavHostRouteController<Provider> : RouteController

Abstract RouteController that navigates on a NavHostController provided by a Provider

RootModalBottomSheetNavigator

class RootModalBottomSheetNavigator<Action : NavigationAction<*>>(navigationMapper: @Composable (Action) -> BottomSheetComposableNavSpec, initialSheetValue: ModalBottomSheetValue = ModalBottomSheetValue.Hidden, parentRouteController: RouteController? = null, contentRootResultHandlers: List<NavHostResultHandler<*, *>> = emptyList(), contentBuilder: BottomSheetContentBuilder, sheetContentBuilder: BottomSheetContentBuilder) : BottomSheetNavigator<Action>

A BottomSheetNavigator that creates and manages a ModalBottomSheetLayout. This should be on top of any ModalBottomSheetNavigator in the View-hierarchy

RootNavHostComposableNavigator

class RootNavHostComposableNavigator<Action : NavigationAction<*>>(navigationMapper: @Composable (Action) -> ComposableNavSpec, parentRouteController: RouteController? = null, rootResultHandlers: List<NavHostResultHandler<*, *>> = emptyList(), contentBuilder: RouteContentBuilder) : ComposableNavigator<Action>

A ComposableNavigator that creates and manages a NavHost. This should be on top of any NavHostComposableNavigator in the View-hierarchy

sealed class Route : ComposableNavSpec

Route for navigating within a RouteController.

RouteContentBuilder

typealias RouteContentBuilder = NavGraphBuilder.(StateFlow<NavHostController?>) -> Unit

RouteController

interface RouteController

Controller for navigating to a Route

Properties

val NavigationBundleSpecRow<*>.argumentKey: String

Key to be used to indicate an argument in a route that is associated with a NavigationBundleSpecRow

val <SpecRow : NavigationBundleSpecRow<*>, Action : NavigationAction<SpecRow>> Action.back: Route.Back

Creates a Route.Back from Action

bottomSheetComposable

val ComposableNavSpec.LaunchedNavigation.bottomSheetComposable: BottomSheetLaunchedNavigation

Converts a ComposableNavSpec.LaunchedNavigation to a BottomSheetLaunchedNavigation

bottomSheetContent

val Route.bottomSheetContent: BottomSheetRoute.Content

Converts a Route to a BottomSheetRoute.Content route

bottomSheetSheetContent

val Route.bottomSheetSheetContent: BottomSheetRoute.SheetContent

Converts a Route to a BottomSheetRoute.SheetContent route

val <SpecRow : NavigationBundleSpecRow<*>, Action : NavigationAction<SpecRow>> Action.fromRoot: Route.FromRoute<SpecRow, Action>

Creates a Route.FromRoute that navigates to the Root view from Action

val <SpecRow : NavigationBundleSpecRow<*>, Action : NavigationAction<SpecRow>> Action.next: Route.NextRoute<SpecRow, Action>

Creates a Route.NextRoute from Action

val <SpecRow : NavigationBundleSpecRow<*>, Action : NavigationAction<SpecRow>> Action.popTo: Route.PopTo<SpecRow, Action>

Creates a Route.PopTo from Action

val <SpecRow : NavigationBundleSpecRow<*>, Action : NavigationAction<SpecRow>> Action.popToIncluding: Route.PopToIncluding<SpecRow, Action>

Creates a Route.PopToIncluding from Action

val <SpecRow : NavigationBundleSpecRow<*>, Action : NavigationAction<SpecRow>> Action.replace: Route.Replace<SpecRow, Action>

Creates a Route.Replace from Action

Functions

fun ActivityLifecycleSubscribable.bind(): ActivityLifecycleSubscribable

Binds an ActivityLifecycleSubscribable to the lifecycle of the androidx.appcompat.app.AppCompatActivity associated with the current LocalContext

fun NavigationAction<*>.CloseActivity(resultCode: Int?): ComposableNavSpec.CloseActivity

Creates a ComposableNavSpec.CloseActivity for a given result code.

@JvmName(name = "singleValueUnitComposable")

inline fun <Action : SingleValueNavigationAction<Unit>> NavGraphBuilder.composable(noinline content: @Composable () -> Unit)

@JvmName(name = "singleValueDateComposable")

inline fun <Action : SingleValueNavigationAction<KalugaDate>> NavGraphBuilder.composable(noinline content: @Composable (KalugaDate) -> Unit)

@JvmName(name = "singleValueBooleanComposable")

inline fun <Action : SingleValueNavigationAction<Boolean>> NavGraphBuilder.composable(noinline content: @Composable (Boolean) -> Unit)

@JvmName(name = "singleValueBooleanArrayComposable")

inline fun <Action : SingleValueNavigationAction<BooleanArray>> NavGraphBuilder.composable(noinline content: @Composable (BooleanArray) -> Unit)

@JvmName(name = "singleValueByteComposable")

inline fun <Action : SingleValueNavigationAction<Byte>> NavGraphBuilder.composable(noinline content: @Composable (Byte) -> Unit)

@JvmName(name = "singleValueByteArrayComposable")

inline fun <Action : SingleValueNavigationAction<ByteArray>> NavGraphBuilder.composable(noinline content: @Composable (ByteArray) -> Unit)

@JvmName(name = "singleValueCharComposable")

inline fun <Action : SingleValueNavigationAction<Char>> NavGraphBuilder.composable(noinline content: @Composable (Char) -> Unit)

@JvmName(name = "singleValueCharArrayComposable")

inline fun <Action : SingleValueNavigationAction<CharArray>> NavGraphBuilder.composable(noinline content: @Composable (CharArray) -> Unit)

@JvmName(name = "singleValueCharSequenceComposable")

inline fun <Action : SingleValueNavigationAction<CharSequence>> NavGraphBuilder.composable(noinline content: @Composable (CharSequence) -> Unit)

@JvmName(name = "singleValueDoubleComposable")

inline fun <Action : SingleValueNavigationAction<Double>> NavGraphBuilder.composable(noinline content: @Composable (Double) -> Unit)

@JvmName(name = "singleValueDoubleArrayComposable")

inline fun <Action : SingleValueNavigationAction<DoubleArray>> NavGraphBuilder.composable(noinline content: @Composable (DoubleArray) -> Unit)

@JvmName(name = "singleValueFloatComposable")

inline fun <Action : SingleValueNavigationAction<Float>> NavGraphBuilder.composable(noinline content: @Composable (Float) -> Unit)

@JvmName(name = "singleValueFloatArrayComposable")

inline fun <Action : SingleValueNavigationAction<FloatArray>> NavGraphBuilder.composable(noinline content: @Composable (FloatArray) -> Unit)

@JvmName(name = "singleValueIntComposable")

inline fun <Action : SingleValueNavigationAction<Int>> NavGraphBuilder.composable(noinline content: @Composable (Int) -> Unit)

@JvmName(name = "singleValueIntArrayComposable")

inline fun <Action : SingleValueNavigationAction<IntArray>> NavGraphBuilder.composable(noinline content: @Composable (IntArray) -> Unit)

@JvmName(name = "singleValueLongComposable")

inline fun <Action : SingleValueNavigationAction<Long>> NavGraphBuilder.composable(noinline content: @Composable (Long) -> Unit)

@JvmName(name = "singleValueLongArrayComposable")

inline fun <Action : SingleValueNavigationAction<LongArray>> NavGraphBuilder.composable(noinline content: @Composable (LongArray) -> Unit)

@JvmName(name = "singleValueShortComposable")

inline fun <Action : SingleValueNavigationAction<Short>> NavGraphBuilder.composable(noinline content: @Composable (Short) -> Unit)

@JvmName(name = "singleValueShortArrayComposable")

inline fun <Action : SingleValueNavigationAction<ShortArray>> NavGraphBuilder.composable(noinline content: @Composable (ShortArray) -> Unit)

@JvmName(name = "singleValueStringComposable")

inline fun <Action : SingleValueNavigationAction<String>> NavGraphBuilder.composable(noinline content: @Composable (String) -> Unit)

@JvmName(name = "singleValueDateArrayComposable")

inline fun <Action : SingleValueNavigationAction<List<KalugaDate>>> NavGraphBuilder.composable(noinline content: @Composable (List<KalugaDate>) -> Unit)

@JvmName(name = "singleValueStringArrayComposable")

inline fun <Action : SingleValueNavigationAction<List<String>>> NavGraphBuilder.composable(noinline content: @Composable (List<String>) -> Unit)

inline fun <Value, Action : SingleValueNavigationAction<Value>> NavGraphBuilder.composable(serializer: KSerializer<Value>, noinline content: @Composable (Value) -> Unit)

inline fun <Value, Action : SingleValueNavigationAction<Value>> NavGraphBuilder.composable(type: NavigationBundleSpecType<Value>, noinline content: @Composable (Value) -> Unit)

inline fun <SpecType : NavigationBundleSpecRow<*>, Action : NavigationAction<SpecType>> NavGraphBuilder.composable(spec: NavigationBundleSpec<SpecType>, noinline content: @Composable (NavigationBundle<SpecType>) -> Unit)

fun <SpecType : NavigationBundleSpecRow<*>, Action : NavigationAction<SpecType>> NavGraphBuilder.composable(actionClass: KClass<Action>, spec: NavigationBundleSpec<SpecType>, content: @Composable (NavigationBundle<SpecType>) -> Unit)

fun <Value, Action : SingleValueNavigationAction<Value>> NavGraphBuilder.composable(actionClass: KClass<Action>, type: NavigationBundleSpecType<Value>, content: @Composable (Value) -> Unit)

Adds a Composable for an Action to the NavGraphBuilder

fun <SpecRow : NavigationBundleSpecRow<*>, Action : NavigationAction<SpecRow>> Action.from(route: String): Route.FromRoute<SpecRow, Action>

Creates a Route.FromRoute from Action

HardwareBackButtonNavigation

fun HardwareBackButtonNavigation(onBackButtonClickHandler: suspend () -> Unit)

Adds a handler for a hardware back button

inline fun <ViewModel : BaseLifecycleViewModel, Input, Output> SingleValueNavigationAction<Input>.Launcher(activityResultContract: ActivityResultContract<Input, Output>, noinline onResult: ViewModel.(Output) -> Unit): ComposableNavSpec.Launcher<ViewModel, Input, Output>

Creates a ComposableNavSpec.Launcher that takes the SingleValueNavigationAction.value as the input of its ActivityResultContract.

inline fun <Activity : Activity, ViewModel : BaseLifecycleViewModel, Output> NavigationAction<*>.Launcher(activityResultContract: ActivityResultContract<Intent, Output>, flags: Set<IntentFlag> = emptySet(), noinline onResult: ViewModel.(Output) -> Unit): ComposableNavSpec.Launcher<ViewModel, Intent, Output>

Creates a ComposableNavSpec.Launcher to launch an Activity with the NavigationAction.bundle.

inline fun <SpecRow : NavigationBundleSpecRow<*>, Action : NavigationAction<SpecRow>> route(spec: NavigationBundleSpec<SpecRow>): String

fun <SpecRow : NavigationBundleSpecRow<*>, Action : NavigationAction<SpecRow>> route(actionClass: KClass<Action>, spec: NavigationBundleSpec<SpecRow>): String

Creates a route string associated with a NavigationAction class given its NavigationBundleSpec. The route created by this method will create placeholders for all properties of the spec

fun <SpecRow : NavigationBundleSpecRow<*>> NavigationAction<SpecRow>.route(): String

Creates a route string for a NavigationAction. The route created by this method will will in all arguments of the action into the route.

fun SetupNavHost(navHostController: NavHostController, startDestination: String, builder: NavGraphBuilder.() -> Unit)

Creates a a NavHost for a given NavHostController

fun SetupNavHost(navHostController: StateFlow<NavHostController?>, rootView: @Composable () -> Unit = { Spacer(modifier = Modifier.fillMaxWidth()) }, builder: RouteContentBuilder)

Creates a a NavHost for a given NavHostController flow

fun SetupNavHost(bottomSheetNavigatorState: StateFlow<BottomSheetNavigatorState?>, navHostController: BottomSheetNavigatorState.() -> NavHostController, rootView: @Composable () -> Unit = { Spacer(modifier = Modifier.fillMaxWidth()) }, builder: BottomSheetContentBuilder)

Creates a a NavHost for a given BottomSheetNavigatorState flow

inline fun <Activity : Activity> NavigationAction<*>.ShowActivity(flags: Set<IntentFlag> = emptySet()): ComposableNavSpec.IntentLauncher

Creates a ComposableNavSpec.IntentLauncher to show a given Activity