navigation/com.hoc081098.solivagant.navigation

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalSolivagantApi

Marks declarations that are still experimental in solivagant API, which means that the design of the corresponding declarations has open issues which may (or may not) lead to their changes in the future. Roughly speaking, there is a chance that those declarations will be deprecated in the near future or the semantics of their behavior may change in some way that may break some code.

LifecycleOwnerComposeUIViewControllerDelegate

sealed interface LifecycleOwnerComposeUIViewControllerDelegate : ComposeUIViewControllerDelegate, LifecycleOwner

Represents both a ComposeUIViewControllerDelegate and a LifecycleOwner.

NavHostDefaults

object NavHostDefaults

Defaults used in NavHost

NavHostTransitionAnimations

@Stable

class NavHostTransitionAnimations

Represents set of callbacks to define transition animations for destinations in NavHost

SavedStateSupport

@MainThread

class SavedStateSupport : SavedStateHandleFactory, SaveableStateRegistry, ViewModelStoreOwner

A class helps to support saved state in Compose.

StackValidationMode

@Immutable

sealed interface StackValidationMode

Stack validation mode.

Functions

AppLifecycleOwner

fun AppLifecycleOwner(): LifecycleOwner

bindTo

fun LifecycleOwnerComposeUIViewControllerDelegate.bindTo(savedStateSupport: SavedStateSupport)

Bind LifecycleOwnerComposeUIViewControllerDelegate to SavedStateSupport. When SavedStateSupport.clear is called, we move the lifecycle to Lifecycle.State.DESTROYED.

ClearOnDispose

@Composable

fun SavedStateSupport.ClearOnDispose()

Clear this SavedStateSupport when the @Composable exits the composition.

LifecycleControllerEffect

@Composable

fun LifecycleControllerEffect(lifecycleRegistry: LifecycleRegistry, windowState: WindowState)

LifecycleOwnerComposeUIViewControllerDelegate

fun LifecycleOwnerComposeUIViewControllerDelegate(): LifecycleOwnerComposeUIViewControllerDelegate

fun LifecycleOwnerComposeUIViewControllerDelegate(hostLifecycleOwner: LifecycleOwner): LifecycleOwnerComposeUIViewControllerDelegate

NavHost

@Composable

fun NavHost(startRoute: NavRoot, destinations: ImmutableSet<NavDestination>, modifier: Modifier = Modifier, navEventNavigator: NavEventNavigator? = null, destinationChangedCallback: (BaseRoute) -> Unit? = null, transitionAnimations: NavHostTransitionAnimations = NavHostDefaults.transitionAnimations(), stackValidationMode: StackValidationMode = NavHostDefaults.stackValidationMode())

Create a new NavHost containing all given destinations. startRoute will be used as the start destination of the graph. Use com.hoc081098.solivagant.navigation.NavEventNavigator and NavigationSetup to change what is shown in NavHost.

ProvideCompositionLocals

@Composable

fun SavedStateSupport.ProvideCompositionLocals(vararg others: ProvidedValue<*>, content: @Composable () -> Unit)

Provides this as LocalViewModelStoreOwner, LocalSaveableStateRegistry and LocalSavedStateHandleFactory to the content, along with other ProvidedValues.

rememberCloseableOnRoute

@Composable

inline fun <T : Closeable> rememberCloseableOnRoute(route: BaseRoute, noinline factory: () -> T): T

@Composable

fun <T : Closeable> rememberCloseableOnRoute(route: BaseRoute, type: KClass<T>, factory: () -> T): T

Remember a Closeable on the route.

rememberWindowLifecycleOwner

@ExperimentalSolivagantApi

@Composable

fun rememberWindowLifecycleOwner(): LifecycleOwner?