Releases: airbnb/mavericks
2.2.0
2.1.0
- Initial release of
mavericks-compose:2.1.0-alpha01. - Upgraded to Kotlin 1.4.30.
- Removed
@RestrictToannotations in favor of just@InternalMavericksApi. The Kotlin opt-in annotations work more reliably than the Android lint rules and there is no need for both. - Created initial release of mavericks-compose (use version 2.1.0-alpha01 for the mavericks-compose artifact)
- Fixed a change in
androidx-lifecycle2.2.0 that would have required any unit tests that use Mavericks to also use robolectric.
Breaking Changes
- ActivityViewModelContext and MavericksViewModelFactory now uses ComponentActivity instead of FragmentActivity to improve Compose interop. ComponentActivity is the super class of FragmentActivity so you may need to replace FragmentActivity with ComponentActivity if you using ActivityViewModelContext.
2.0.0
Mavericks 2.0 is a ground up rewrite for coroutines. Check out the documentation for 2.0 to find out what is new and how to upgrade.
Breaking Changes
- All
mvrxartifact names are nowmavericks. - If you are using RxJava, you will need to use
mavericks-rxjava2to maintain backwards compatibility. New Mavericks users who just use coroutines can just usemavericks. - If your MavericksView/Fragment does not use any ViewModels, invalidate() will NOT be called in onStart(). In MvRx 1.x, invalidate would be called even if MvRx was not used at all. If you would like to maintain the original behavior, call
postInvalidate()from onStart in your base Fragment class - MavericksViewModel and BaseMvRxViewModel (from mavericks-rxjava2) no longer extends Jetpack ViewModel. However,
viewModelScopeandonCleared()still exist to match the existing API - The order of nested with and set states has changed slightly. It now matches the original intention.
If you had code like:
withState {
// W1
withState {
// W2
}
setState {
// S1
setState {
// S2
setState {
// S3
}
}
}
}Previously, setState would only be prioritized at that nesting level so it would run:
[W1, S1, W2, S2, S3]
Now, it will run:
[W1, S1, S2, S3, W2]
- viewModelScope is now a property on MavericksViewModel and BaseMvRxViewModel (from mavericks-rxjava2), not the Jetpack extension function for ViewModel. Functionally, this is the same but the previous viewModelScope import will now be unused
- If you had been using any restricted internal mavericks library functions your build may break as they have been renamed (you shouldn't be doing this, but in case you are...)
Other Changes
- Make MavericksViewModel extension functions protected (#488)
- Add MavericksViewModel.awaitState (#487) to access current ViewModel state via a suspend function
- Mark all @RestrictTo APIs with @InternalMavericksApi (#480)
- Api additions to the mocking framework (#475) (#477)
- Migrated CoroutinesStateStore to SharedFlow (#469)
- Launcher and mock speed optimizations (#468)
- FragmentViewModelContext now allows for custom ViewModelStoreOwner and/or SavedStateRegistry that are different from the fragment ones in FragmentViewModelContext. (#443)
- Add mavericks-navigation artifact to support AndroidX Navigation destination ViewModels
navGraphViewModel(R.id.my_graph)(#443)
2.0.0-beta3
Changes since beta 2
Make MavericksViewModel extension functions protected (#488)
Add MavericksViewModel.awaitState (#487) to access current ViewModel state via a suspend function
Mark all @RestrictTo APIs with @InternalMavericksApi (#480)
Api additions to the mocking framework (#475) (#477)
Migrated CoroutinesStateStore to SharedFlow (#469)
Launcher and mock speed optimizations (#468)
2.0.0-beta2
Coroutine api tweaks (#464)
Fix mocking docs (#465)
Never complete ViewModel.stateFlow (#460)
Tweaks and additions to the mocking framework (#461)
Allow configurable StateStore CoroutineContext (#454)
[2.0] Cleaned up and obfuscated some @RestrictTo APIs (#453)
Breaking
- If you had been using any restricted internal mvrx library functions your build may break as they have been renamed (you shouldn't be doing this, but in case you are...)
MockableMavericks.initializefunction signature has changed
2.0.0-beta1
- The
mvrxartifact no longer has a dependency on RxJava, and the ViewModel and StateStore are now implemented with Kotlin Coroutines - You can continue accessing the previous RxJava ViewModel extensions by using the
mvrx-rxjava2artifact - To reflect the underlying removal of RxJava from the MvRx implementation we are renaming the implementation to Mavericks
- New documentation for the rewrite is available at https://airbnb.io/MvRx/#/
- A
mvrx-mockingartifact now provides built in support for mocking viewmodels, states, and full screens - The order of nested with and set states has changed slightly. It now matches the original intention.
If you had code like:
withState {
// W1
withState {
// W2
}
setState {
// S1
setState {
// S2
setState {
// S3
}
}
}
}Previously, setState would only be prioritized at that nesting level so it would run:
[W1, S1, W2, S2, S3]
Now, it will run:
[W1, S1, S2, S3, W2]
- If your MvRxView/Fragment does not use any ViewModels, invalidate() will NOT be called in onStart(). In MvRx 1.x, invalidate would be called even if MvRx was not used at all. If you would like to maintain the original behavior, call
postInvalidate()from onStart in your base Fragment class. - BaseMvRxViewModel no longer extends Jetpack ViewModel
- viewModelScope is now a property on BaseMvRxViewModel, not the Jetpack extension function for ViewModel. Functionally, this is the same but the previous viewModelScope import will now be unused.
1.5.1
1.5.0
1.4.0
2.0.0 Alpha 2
Fixes an issue in alpha 1 where the mvrx-launcher artifact wasn't actually present.