This library is based on and depends heavily on Assisted Inject

ViewModelInject supports Dagger2 and SavedStateHandle

This is using alpha versions of the Androidx/JetPack libraries. Use at your own risk.

This Library will go 1.0 when Assisted Inject goes 1.0.

Java

class MyViewModel extends ViewModel {
    @ViewModelInject
    MyViewModel(Long foo, @Assisted SavedStateHandle savedStateHandle) {}
}

Kotlin

class MyViewModel
@ViewModelInject constructor(
    foo: Long, @Assisted savedStateHandle: SavedStateHandle
): ViewModel() {}

In order to allow Dagger to use the generated factory, define an assisted dagger module anywhere in the same gradle module:

Java

@ViewModelModule
@Module(includes = ViewModelInject_VMModule.class)
abstract class VMModule {}

Kotlin

@ViewModelModule
@Module(includes = [ViewModelInject_VMModule::class])
abstract class VMModule

The library will generate the ViewModelInject_VMModule for us.

Inside your Activity or Fragment inject one of the following factories:

If you are not using a SavedStateHandle inject the ViewModelFactory

Java

@Inject ViewModelFactory viewModelFactory;

public void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    MyViewModel viewModel = ViewModelProviders.of(this, viewModelFactory)
                                .get(MainViewModel.class);
    // ...
}

Kotlin

@Inject 
lateinit var viewModelFactory: ViewModelFactory

public void onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    val viewModel = ViewModelProviders.of(this, viewModelFactory)
                                .get(MainViewModel::class.java)
    // ...
}

If you are using a SavedStateHandle inject the SavedStateViewModelFactory.Factory

Java

@Inject SavedStateViewModelFactory.Factory viewModelFactoryFactory;

fun onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    MyViewModel viewModel = ViewModelProviders.of(this, viewModelFactoryFactory.create(this, intent.getExtras()))
                                .get(MainViewModel.class);
    // ...
}

Kotlin

@Inject
lateinit var viewModelFactoryFactory: SavedStateViewModelFactory.Factory

fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    val viewModel = ViewModelProviders.of(this, viewModelFactoryFactory.create(this, intent.getExtras()))
                                .get(MainViewModel::class.java)
    // ...
}

The SavedStateViewModelFactory handles both ViewModels with and without a SavedStateHandle. If you are using SavedStateHandles anywhere in your project it is recommended to always use the SavedStateViewModelFactory

implementation 'com.vikingsen.inject:viewmodel-inject:0.3.3'
annotationProcessor 'com.vikingsen.inject:viewmodel-inject-processor:0.3.3' // or `kapt` for Kotlin

For Snapshots include the following repository:

repositories {
    // ...
    maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
}

Copyright 2019 Jordan Hansen

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.