decompose-router/io.github.xxfast.decompose.router

Package-level declarations

Types

RouterContext

class RouterContext(delegate: ComponentContext) : ComponentContext

Properties

key

actual val KClass<*>.key: String

expect val KClass<*>.key: String

actual val KClass<*>.key: String

LocalRouterContext

val LocalRouterContext: ProvidableCompositionLocal<RouterContext>

Compositional local for RouterContext.

Functions

defaultRouterContext

@Composable

fun defaultRouterContext(backDispatcher: BackDispatcher = BackDispatcher(), lifecycleRegistry: LifecycleRegistry = LifecycleRegistry(), windowState: WindowState = rememberWindowState()): RouterContext

fun defaultRouterContext(): RouterContext

defaultRouterContext

fun ComponentActivity.defaultRouterContext(): RouterContext

fun Fragment.defaultRouterContext(onBackPressedDispatcher: OnBackPressedDispatcher?): RouterContext

destroy

fun RouterContext.destroy()

getOrCreate

inline fun <T : Any> RouterContext.getOrCreate(key: Any, factory: () -> T): T

pause

fun RouterContext.pause()

rememberOnRoute

@Composable

inline fun <T : @Serializable Any> rememberOnRoute(key: Any = T::class, noinline block: @DisallowComposableCalls RouterContext.() -> T): T

@Composable

fun <T : Any> ~~rememberOnRoute~~(type: KClass<T>, key: Any = type.key, block: @DisallowComposableCalls RouterContext.() -> T): T

Scopes instance of T to the current route

resume

fun RouterContext.resume()

state

inline fun <T : @Serializable Any> RouterContext.state(initial: T, key: String = T::class.key, serializer: KSerializer<T> = T::class.serializer(), noinline supplier: () -> T): T

stop

fun RouterContext.stop()