Presents a given UiState.

Events (if any) should be a part of the UiState itself as an eventSink: (Event) -> Unit property.

If a given Presenter only ever emits the same state, you can define a single value-less object type for the state.

See also

for more thorough documentation.


Link copied to clipboard
fun interface Factory

A factory that produces presenters for a given Screen. Circuit instances use the created presenter and connects it to a given Ui for the same Screen.


Link copied to clipboard
abstract fun present(): UiState

The primary Composable entry point to present a UiState. In production, a Navigator is used to automatically connect this with a corresponding Ui to render the state returned by this function.