Skip to content

Commit 4b28cdf

Browse files
committed
Common-flow viewmodel docs
Refs: #11
1 parent 8f09afb commit 4b28cdf

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1224,6 +1224,22 @@ Check the [example](examples/di) that shows the use of this flow:
12241224
- The [app](examples/di/app) module has two build variants to support each.
12251225
- The concrete sub-flow is provided with the late DI binding using `Hilt`
12261226

1227+
Additionally, there is another artefact that could make the bridge between conventional view
1228+
and state-machine easier:
1229+
1230+
```groovy
1231+
dependencies {
1232+
// Common view-model bridge
1233+
implementation "com.motorro.commonstatemachine:commonflow-viewmodel:x.x.x"
1234+
}
1235+
```
1236+
The library contains common `ViewModel` implementation that hosts common-flow and works with
1237+
Activities, Fragments and Compose compositions.
1238+
1239+
The [CommonFlowComposition](commonflow/viewmodel/src/commonMain/kotlin/com/motorro/commonstatemachine/flow/viewmodel/CommonFlowComposition.kt)
1240+
is a basic scaffold to quickly introduce common-flow state-machine flow to the conventional view or composable.
1241+
1242+
Take a look at the [books](examples/books) project to see how it works.
12271243

12281244
## Running state-machines in parallel (composition)
12291245

0 commit comments

Comments
 (0)