equinox-compose/com.tecknobit.equinoxcompose.session.screens/EquinoxScreen

EquinoxScreen

abstract class EquinoxScreen<V : EquinoxViewModel>(val loggerEnabled: Boolean = true, val viewModel: V) : EquinoxNoModelScreen

The EquinoxScreen class is useful to create a screen with a lifecycle management similar to the Android's activities. This screen supports to attach the related androidx.lifecycle.ViewModel and operate with it

Related documentation: EquinoxScreens.md

Author

N7ghtm4r3 - Tecknobit

Parameters

generic type used to allow the use of own viewmodel in custom screens

Constructors

EquinoxScreen

constructor(loggerEnabled: Boolean = true, viewModel: V)

Properties

loggerEnabled

private val loggerEnabled: Boolean = true

Whether enabled the logging to log the events occurred in the ShowContent composable, it is suggested to disable it in production

viewModel

protected open val viewModel: V

Support viewmodel to automatically manage the retriever suspension or restarting with the lifecycle events of the screen

Functions

ArrangeScreenContent

@Composable

protected abstract fun ArrangeScreenContent()

Method used to arrange the content of the screen to display

CollectStates

@Composable

protected abstract fun CollectStates()

Method used to collect or instantiate the states of the screen

CollectStatesAfterLoading

@Composable

protected open fun CollectStatesAfterLoading()

Method used to collect or instantiate the states of the screen after a loading required to correctly assign an initial value to the states. For example in your custom screen:

LifecycleManager

@Composable

protected fun LifecycleManager(lifecycleOwner: LifecycleOwner = LocalLifecycleOwner.current)

Method used to manage the lifecycle of the composable where this Method has been invoked

logScreenEvent

protected fun logScreenEvent(event: Lifecycle.Event)

protected fun logScreenEvent(event: String)

Method used to log the event occurred in the current screen

onAny

protected open fun onAny()

Method invoked when in the ShowContent composable has occurred any of the possible events

onCreate