• Home
• com.slack.circuit
• circuit-foundation
• 0.22.0
• source code
• CircuitCompositionLocals.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.com.slack.circuit.foundation.CircuitCompositionLocals.kt Maven / Gradle / Ivy

// Copyright (C) 2022 Slack Technologies, LLC
// SPDX-License-Identifier: Apache-2.0
package com.slack.circuit.foundation

import androidx.compose.runtime.Composable
import androidx.compose.runtime.CompositionLocal
import androidx.compose.runtime.CompositionLocalProvider
import androidx.compose.runtime.ProvidableCompositionLocal
import androidx.compose.runtime.compositionLocalOf
import androidx.compose.runtime.staticCompositionLocalOf
import com.slack.circuit.retained.LocalRetainedStateRegistry
import com.slack.circuit.retained.RetainedStateRegistry
import com.slack.circuit.retained.continuityRetainedStateRegistry
import com.slack.circuit.runtime.CircuitContext

/**
 * Provides the given [circuit] as a [CompositionLocal] to all composables within [content]. Also
 * adds any other composition locals that Circuit needs.
 */
@Composable
public fun CircuitCompositionLocals(
  circuit: Circuit,
  retainedStateRegistry: RetainedStateRegistry = continuityRetainedStateRegistry(),
  content: @Composable () -> Unit,
) {
  CompositionLocalProvider(
    LocalCircuit provides circuit,
    LocalRetainedStateRegistry provides retainedStateRegistry,
  ) {
    content()
  }
}

internal val LocalCircuitContext = compositionLocalOf { null }

/** CompositionLocal with a current [Circuit] instance. */
public val LocalCircuit: ProvidableCompositionLocal = staticCompositionLocalOf { null }