• Home
• com.slack.circuit
• circuit-overlay-jvm
• 0.22.2
• source code
• OverlayState.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.overlay.OverlayState.kt Maven / Gradle / Ivy

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

import androidx.compose.runtime.ProvidableCompositionLocal
import androidx.compose.runtime.compositionLocalOf
import com.slack.circuit.overlay.OverlayState.UNAVAILABLE

/** A [ProvidableCompositionLocal] to expose the current [OverlayState] in the composition tree. */
public val LocalOverlayState: ProvidableCompositionLocal = compositionLocalOf {
  UNAVAILABLE
}

/** Represents the current state of the available [OverlayHost]. */
public enum class OverlayState {
  /** Indicates that overlays are not available. */
  UNAVAILABLE,

  /** Indicates that overlays are available but no overlay is currently showing. */
  HIDDEN,

  /** Indicates that an overlay is currently showing. */
  SHOWING,
}