commonMain.com.svenjacobs.reveal.effect.RevealOverlayEffect.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of reveal-core Show documentation

Lightweight, simple reveal effect for Compose Multiplatform

The newest version!

package com.svenjacobs.reveal.effect

import androidx.compose.animation.core.AnimationSpec
import androidx.compose.runtime.Composable
import androidx.compose.runtime.State
import androidx.compose.ui.Modifier
import com.svenjacobs.reveal.ActualRevealable
import com.svenjacobs.reveal.Key
import com.svenjacobs.reveal.RevealOverlayScope
import com.svenjacobs.reveal.RevealState

/**
 * Overlay effect which renders the background and reveal effect.
 */
public interface RevealOverlayEffect {

	@Composable
	public fun Overlay(
		revealState: RevealState,
		currentRevealable: State,
		previousRevealable: State,
		modifier: Modifier,
		content: @Composable RevealOverlayScope.(key: Key) -> Unit,
	)

	/**
	 * Animation spec for the animated alpha of the overlay when this effect is shown or hidden.
	 */
	public val alphaAnimationSpec: AnimationSpec
}