commonMain.com.tunjid.treenav.compose.PanedNavigationState.kt Maven / Gradle / Ivy

Go to download

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

A collection of utility composable functions

There is a newer version: 0.0.14

package com.tunjid.treenav.compose

import com.tunjid.treenav.Node

/**
 * State providing details about data in each pane [Pane] it hosts.
 */
interface PanedNavigationState {

    /**
     * The current [Destination] in this [pane].
     * @param pane the [Pane] to query.
     */
    fun destinationFor(
        pane: Pane,
    ): Destination?

    /**
     * Adaptations involving this [pane] after the last navigation state change.
     * @param pane the affected [Pane].
     */
    fun adaptationsIn(
        pane: Pane,
    ): Set
}

/**
 * A description of the process that the layout undertook to adapt to the present
 * pane in its new configuration.
 */
sealed class Adaptation {

    /**
     * Destinations remained the same in the pane
     */
    data object Same : Adaptation()

    /**
     * Destinations were changed in the pane
     */
    data object Change : Adaptation()

    /**
     * Destinations were swapped in between panes
     */
    data class Swap(
        val from: Pane,
        val to: Pane?,
    ) : Adaptation()

    /**
     * Checks if a [Swap] [Adaptation] involved [pane].
     */
    operator fun  Swap.contains(pane: Pane?): Boolean = pane == from || pane == to

}