commonMain.com.arkivanov.decompose.router.pages.PagesNavigator.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of decompose Show documentation

Kotlin Multiplatform lifecycle-aware business logic components

There is a newer version: 3.2.0-beta01

package com.arkivanov.decompose.router.pages

interface PagesNavigator {

    /**
     * Transforms the current [Pages] state into a new one.
     *
     * During the navigation process, the Child Pages navigation model compares the new [Pages] state
     * with the previous one. The navigation model ensures that all removed components are destroyed,
     * and updates lifecycles of the existing components to match the new state.
     *
     * The navigation is usually performed synchronously, which means that by the time
     * the `navigate` method returns, the navigation is finished and all component lifecycles are
     * moved into required states. However, the navigation is performed asynchronously in case of
     * recursive invocations - e.g. `selectNext` is called from `onResume` lifecycle callback of a
     * component being shown. All recursive invocations are queued and performed one by one once
     * the current navigation is finished.
     *
     * Should be called on the main thread.
     *
     * @param transformer transforms the current [Pages] state to a new one.
     * @param onComplete called when the navigation is finished (either synchronously or asynchronously).
     */
    fun navigate(
        transformer: (Pages) -> Pages,
        onComplete: (newPages: Pages, oldPages: Pages) -> Unit,
    )
}