androidx.savedstate

inline fun savedState(
    initialState: Map<String, Any?> = emptyMap(),
    builderAction: SavedStateWriter.() -> Unit = {}
): SavedState

Builds a new SavedState with the specified initialState, given as a Map of String keys and Any value.

Allows further modification of the state using the builderAction.

IMPORTANT: The SavedStateWriter passed as a receiver to the builderAction is valid only inside that function. Using it outside of the function may produce an unspecified behavior.

inline fun savedState(initialState: SavedState, builderAction: SavedStateWriter.() -> Unit = {}): SavedState

Builds a new SavedState with the specified initialState, given as a SavedState instance.

Allows further modification of the state using the builderAction.

IMPORTANT: The SavedStateWriter passed as a receiver to the builderAction is valid only inside that function. Using it outside of the function may produce an unspecified behavior.

fun View.findViewTreeSavedStateRegistryOwner(): SavedStateRegistryOwner?

Retrieve the SavedStateRegistryOwner responsible for managing the saved state for this View. This may be used to save or restore the state associated with the view.

The returned SavedStateRegistryOwner is managing all the Views within the Fragment or Activity this View is added to.

inline fun <T : Any?> SavedState.read(block: SavedStateReader.() -> T): T

Calls the specified function block with a SavedStateReader value as its receiver and returns the block value.

IMPORTANT: The SavedStateReader passed as a receiver to the block is valid only inside that function. Using it outside of the function may produce an unspecified behavior.

fun View.setViewTreeSavedStateRegistryOwner(
    owner: SavedStateRegistryOwner?
): Unit

Set the SavedStateRegistryOwner responsible for managing the saved state for this View Calls to get from this view or descendants will return owner.

This is is automatically set for you in the common cases of using fragments or ComponentActivity.

This should only be called by constructs such as activities or fragments that manage a view tree and their saved state through a SavedStateRegistryOwner. Callers should only set a SavedStateRegistryOwner that will be stable. The associated SavedStateRegistry should be cleared if the view tree is removed and is not guaranteed to later become reattached to a window.

inline fun <T : Any?> SavedState.write(block: SavedStateWriter.() -> T): T

Calls the specified function block with a SavedStateWriter value as its receiver and returns the block value.

IMPORTANT: The SavedStateWriter passed as a receiver to the block is valid only inside that function. Using it outside of the function may produce an unspecified behavior.