ViewCompositionStrategy
interface ViewCompositionStrategy
androidx.compose.ui.platform.ViewCompositionStrategy |
A strategy for managing the underlying Composition of Compose UI Views such as ComposeView and AbstractComposeView. See AbstractComposeView.setViewCompositionStrategy.
Compose views involve ongoing work and registering the composition with external event sources. These registrations can cause the composition to remain live and ineligible for garbage collection for long after the host View may have been abandoned. These resources and registrations can be released manually at any time by calling AbstractComposeView.disposeComposition and a new composition will be created automatically when needed. A ViewCompositionStrategy defines a strategy for disposing the composition automatically at an appropriate time.
By default, Compose UI views are configured to DisposeOnDetachedFromWindow. The composition
will be disposed automatically when the view is detached from a window. For use cases that
involve frequent remove/add operations such as children of a RecyclerView
it may be more
appropriate to allow the composition to persist across removals for efficiency.
Summary
Nested classes | |
---|---|
ViewCompositionStrategy that disposes the composition whenever the view becomes detached from a window. |
|
ViewCompositionStrategy that disposes the composition when lifecycle is destroyed. |
|
ViewCompositionStrategy that disposes the composition when the ViewTreeLifecycleOwner of the next window the view is attached to is destroyed. |
Public methods | |
---|---|
abstract () -> Unit |
installFor(view: AbstractComposeView) Install this strategy for view and return a function that will uninstall it later. |
Public methods
installFor
abstract fun installFor(view: AbstractComposeView): () -> Unit
Install this strategy for view and return a function that will uninstall it later. This function should not be called directly; it is called by AbstractComposeView.setViewCompositionStrategy after uninstalling the previous strategy.