Version: 0.12.0

Configuration

Gradle

The simple way to apply Tangle is to just apply the gradle plugin. It will automatically add the dependencies and perform some basic validation of your module's configuration.

You can also just add dependencies yourself, without applying the plugin.

Note that Tangle is specifically for Android and has Android-specific dependencies, so it should only be added to Android modules.

Kotlin Plugin
Groovy Plugin
Kotlin Dependencies
Groovy Dependencies

// settings.gradle.kts

pluginManagement {
  repositories {
    gradlePluginPortal()
  }
}

// top-level build.gradle.kts

plugins {
  id("com.rickbusarow.tangle") version "0.12.0"
}

// any Android module's build.gradle.kts

plugins {
  id("android-library") // or application, etc.
  kotlin("android")
  id("com.squareup.anvil")
  id("com.rickbusarow.tangle")
}

// optional
tangle {
  fragmentsEnabled = true // default is true
  workEnabled = true // default is true

  viewModelOptions {
    enabled = true // default is true
    activitiesEnabled = true // default is true
    composeEnabled = true // default is false
    fragmentsEnabled = true // default is true
  }
}

// settings.gradle

pluginManagement {
  repositories {
    gradlePluginPortal()
  }
}

// top-level build.gradle

plugins {
  id "com.rickbusarow.tangle" version "0.12.0"
}

// any Android module's build.gradle

plugins {
  id 'android-library' // or application, etc.
  kotlin("android")
  id 'com.squareup.anvil'
  id 'com.rickbusarow.tangle'
}

// optional
tangle {
  fragmentsEnabled = true // default is true
  workEnabled = true // default is true

  viewModelOptions {
    enabled = true // default is true
    activitiesEnabled = true // default is true
    composeEnabled = true // default is false
    fragmentsEnabled = true // default is true
  }
}

// any Android module's build.gradle.kts

plugins {
  id("android-library") // or application, etc.
  kotlin("android")
  id("com.squareup.anvil")
}

dependencies {

  // Fragments
  api("com.rickbusarow.tangle:tangle-fragment-api:0.12.0")
  anvil("com.rickbusarow.tangle:tangle-fragment-compiler:0.12.0")

  // ViewModels
  api("com.rickbusarow.tangle:tangle-viewmodel-api:0.12.0")
  anvil("com.rickbusarow.tangle:tangle-viewmodel-compiler:0.12.0")

  // optional Activity ViewModel support
  implementation("com.rickbusarow.tangle:tangle-viewmodel-activity:0.12.0")

  // optional Compose ViewModel support
  implementation("com.rickbusarow.tangle:tangle-viewmodel-compose:0.12.0")

  // optional Fragment ViewModel support
  implementation("com.rickbusarow.tangle:tangle-viewmodel-fragment:0.12.0")

  // WorkManager
  api("com.rickbusarow.tangle:tangle-work-api:0.12.0")
  anvil("com.rickbusarow.tangle:tangle-work-compiler:0.12.0")
}

// any Android module's build.gradle

plugins {
  id 'android-library' // or application, etc.
  kotlin("android")
  id 'com.squareup.anvil'
}

dependencies {

  // Fragments
  api 'com.rickbusarow.tangle:tangle-fragment-api:0.12.0'
  anvil 'com.rickbusarow.tangle:tangle-fragment-compiler:0.12.0'

  // ViewModels
  api 'com.rickbusarow.tangle:tangle-viewmodel-api:0.12.0'
  anvil 'com.rickbusarow.tangle:tangle-viewmodel-compiler:0.12.0'

  // optional Activity ViewModel support
  implementation 'com.rickbusarow.tangle:tangle-viewmodel-activity:0.12.0'

  // optional Compose ViewModel support
  implementation 'com.rickbusarow.tangle:tangle-viewmodel-compose:0.12.0'

  // optional Fragment ViewModel support
  implementation 'com.rickbusarow.tangle:tangle-viewmodel-fragment:0.12.0'

  // WorkManager
  api 'com.rickbusarow.tangle:tangle-work-api:0.12.0'
  anvil 'com.rickbusarow.tangle:tangle-work-compiler:0.12.0'
}

Setting up the Tangle graph

In order to connect Tangle to your application-scoped Dagger component, call TangleGraph.init(...) immediately after creating the component.

import android.app.Application
import tangle.inject.TangleGraph

class MyApplication : Application() {

  override fun onCreate() {
    super.onCreate()

    val myAppComponent = DaggerMyAppComponent.factory()
      .create(this)

    TangleGraph.init(myAppComponent)
  }
}

Next steps

Tangle is now able to generate its code and hook in to Dagger.

Check out these features to start using Tangle in your project:

Gradle​

Setting up the Tangle graph​

Next steps​

Gradle

Setting up the Tangle graph

Next steps