secure-vault-compose/io.github.alimsrepo.secure.vault.compose

Package-level declarations

Types

sealed interface VaultState

Lifecycle of a process-wide SecureVault, surfaced as state your Compose UI is expected to render explicitly.

Properties

val LocalSecureVault: ProvidableCompositionLocal<<Error class: unknown class>>

CompositionLocal that exposes the currently-installed SecureVault to any composable in the tree below a ProvideSecureVault call.

Functions

ProvideSecureVault

@Composable

fun ProvideSecureVault(vault: <Error class: unknown class>, content: @Composable () -> Unit)

Provides vault to the composition rooted at content via LocalSecureVault.

rememberSecureValue

@Composable

fun rememberSecureValue(key: String, default: String = ""): MutableState<String>

Two-way binding between a Compose MutableState and a single SecureVault key.

@Composable

fun rememberSecureValue(vault: <Error class: unknown class>, key: String, default: String = ""): MutableState<String>

Overload that accepts an explicit vault instead of resolving it from LocalSecureVault. Useful for tests and for screens that bridge multiple namespaces.

rememberSecureVault

@Composable

fun rememberSecureVault(config: <Error class: unknown class>): State<VaultState>

Returns the lifecycle VaultState of a process-wide SecureVault for the given config.

@Composable

fun rememberSecureVault(namespace: String, accessibility: <Error class: unknown class> = Accessibility.AfterFirstUnlock): State<VaultState>

Convenience overload — equivalent to rememberSecureVault(VaultConfig(namespace, accessibility)).