commonMain.com.eygraber.compose.material3.navigation.ModalBottomSheetNavigatorDestinationBuilder.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of compose-material3-navigation Show documentation
Support using bottom sheets as destinations when using Navigation Compose
There is a newer version: 0.0.5
Show newest version
package com.eygraber.compose.material3.navigation

import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.ModalBottomSheet
import androidx.compose.material3.ModalBottomSheetProperties
import androidx.compose.material3.SheetValue.Expanded
import androidx.compose.material3.SheetValue.Hidden
import androidx.compose.runtime.Composable
import androidx.navigation.NavBackStackEntry
import androidx.navigation.NavDestinationBuilder
import androidx.navigation.NavDestinationDsl
import androidx.navigation.NavType
import kotlin.jvm.JvmSuppressWildcards
import kotlin.reflect.KClass
import kotlin.reflect.KType

@NavDestinationDsl
public class ModalBottomSheetNavigatorDestinationBuilder :
  NavDestinationBuilder {

  private val modalBottomSheetNavigator: ModalBottomSheetNavigator
  @ExperimentalMaterial3Api
  private val modalBottomSheetProperties: ModalBottomSheetProperties
  private val skipPartiallyExpanded: Boolean
  private val content: @Composable (NavBackStackEntry) -> Unit

  /**
   * DSL for constructing a new [ModalBottomSheetNavigator.Destination]
   *
   * @param navigator navigator used to create the destination
   * @param route the destination's unique route
   * @param modalBottomSheetProperties properties that should be passed to
   *   [ModalBottomSheet].
   * @param skipPartiallyExpanded Whether the partially expanded state, if the sheet is tall enough,
   *   should be skipped. If true, the sheet will always expand to the [Expanded] state and move to
   *   the [Hidden] state when hiding the sheet, either programmatically or by user interaction.
   * @param content composable for the destination
   */
  @ExperimentalMaterial3Api
  public constructor(
    navigator: ModalBottomSheetNavigator,
    route: String,
    modalBottomSheetProperties: ModalBottomSheetProperties,
    skipPartiallyExpanded: Boolean,
    content: @Composable (NavBackStackEntry) -> Unit,
  ) : super(navigator, route) {
    this.modalBottomSheetNavigator = navigator
    this.modalBottomSheetProperties = modalBottomSheetProperties
    this.skipPartiallyExpanded = skipPartiallyExpanded
    this.content = content
  }

  /**
   * DSL for constructing a new [ModalBottomSheetNavigator.Destination]
   *
   * @param navigator navigator used to create the destination
   * @param route the destination's unique route from a [KClass]
   * @param typeMap map of destination arguments' kotlin type [KType] to its respective custom
   *   [NavType]. May be empty if [route] does not use custom NavTypes.
   * @param modalBottomSheetProperties properties that should be passed to
   *   [ModalBottomSheet].
   * @param skipPartiallyExpanded Whether the partially expanded state, if the sheet is tall enough,
   *   should be skipped. If true, the sheet will always expand to the [Expanded] state and move to
   *   the [Hidden] state when hiding the sheet, either programmatically or by user interaction.
   * @param content composable for the destination
   */
  @ExperimentalMaterial3Api
  public constructor(
    navigator: ModalBottomSheetNavigator,
    route: KClass<*>,
    typeMap: Map>,
    modalBottomSheetProperties: ModalBottomSheetProperties,
    skipPartiallyExpanded: Boolean,
    content: @Composable (NavBackStackEntry) -> Unit,
  ) : super(navigator, route, typeMap) {
    this.modalBottomSheetNavigator = navigator
    this.modalBottomSheetProperties = modalBottomSheetProperties
    this.skipPartiallyExpanded = skipPartiallyExpanded
    this.content = content
  }

  @ExperimentalMaterial3Api
  override fun instantiateDestination(): ModalBottomSheetNavigator.Destination = ModalBottomSheetNavigator.Destination(
    modalBottomSheetNavigator,
    modalBottomSheetProperties,
    skipPartiallyExpanded,
    content,
  )
}