README.md

todo-swift-mvvm-live

This version of the app is called todo-swift-mvvm-live, and it uses Swift data model and some Architecture Components like ViewModel, LiveData, and other lifecycle-aware classes. It's based on the todo-mvvm-databinding sample, which uses the Data Binding Library to display data and bind UI elements to actions.

How to compile (Only macOS)

First of all, preapre development enviroment according to https://github.com/readdle/swift-android-toolchain#prepare-environment

Set swift android toolchain path for Android Studio

at local.properties:

ndk.dir=<PATH_TO_NDK>
swift-android.dir=<PATH_TO_SWIFT_ANDROID_TOOLCHAIN>

or add to your .profile:

launchctl setenv ANDROID_NDK_HOME <PATH_TO_NDK>
launchctl setenv SWIFT_ANDROID_HOME <PATH_TO_SWIFT_ANDROID_TOOLCHAIN>

Then build with Android Studio or just gradlew

./gradlew clean assembleDebug

What you need

Before exploring this sample, you should familiarize yourself with the following topics:

• The project README
• The todo-mvp sample
• The todo-mvvm-databinding sample
• The MVVM architecture

Implementing the app

Although the parent sample already used ViewModels, as it was following an MVVM architecture, the Architecture Components have different restrictions by design.

In the MVVM architecture, Views react to changes in the ViewModel without being explicitly called. However, the MVVM architecture presents some challenges when working with some Android components.

Live events

A new SingleLiveEvent class is created, which extends MutableLiveData so it's lifecycle-aware. It's used for communication between ViewModels and UI views (activities and fragments).

Instead of holding data, it dispatches data once. This is important to prevent events being fired after a rotation, for example.

A convenient use for this is navigation. There is no reference to the View from a ViewModel so the communication between them must happen via a subscription. ViewModels expose events like openTaskEvent and views subscribe to them. For example:

private void subscribeToNavigationChanges(TaskDetailViewModel viewModel) {
    // The activity observes the navigation commands in the ViewModel
    viewModel.getEditTaskCommand().observe(this, new Observer<Void>() {
        @Override
        public void onChanged(@Nullable Void _) {
            TaskDetailActivity.this.onStartEditTask();
        }
    });
    viewModel.getDeleteTaskCommand().observe(this, new Observer<Void>() {
        @Override
        public void onChanged(@Nullable Void _) {
            TaskDetailActivity.this.onTaskDeleted();
        }
    });
}

Snackbar

To show a Snackbar, you must use a static call to pass a view object:

Snackbar.make(View coordinatorLayout, String text, int length).show();

A ViewModel, however, doesn't have the necessary reference to the view hierarchy. Instead, you can manually subscribe the snackbar to a Snackbar event. In this case the subscription is made to a SnackbarMessage which extends a SingleLiveEvent and takes a string resource ID (an integer). There's only one snackbar and there should only be one active observer at a time. Messages are only shown once.

TasksAdapter

There is no TaskItemViewModel in this branch for each particular item in the list, so tasks in the list only communicate with the list's ViewModel.

Using ViewModels in bindings with the Data Binding Library

ViewModels are used to show data of a particular screen, but they don't handle user actions. For that it's much more convenient to create user actions listeners or even presenters that hold no state during configuration changes and hence are easy to recreate. See TaskItemUserActionsListener for an example.

Repository does not use LiveData

For simplicity and similarity with the parent branch, the repository does not use LiveData to expose its data.