Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Subclass AppCompatActivity directly #35

Merged
merged 1 commit into from
May 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
package dev.hotwire.core.navigation.activities

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import dev.hotwire.core.navigation.session.SessionConfiguration
import dev.hotwire.core.navigation.session.SessionNavHostFragment

/**
* Interface that should be implemented by any Activity using Turbo. Ensures that the
* Activity provides a [HotwireActivityDelegate] so the framework can initialize the
* [SessionNavHostFragment] hosted in your Activity's layout resource.
* Activity that should be implemented by any Activity using Hotwire.
*/
interface HotwireActivity {
val delegate: HotwireActivityDelegate
val appCompatActivity: AppCompatActivity
fun sessionConfigurations(): List<SessionConfiguration>
abstract class HotwireActivity : AppCompatActivity() {
lateinit var delegate: HotwireActivityDelegate
private set

abstract fun sessionConfigurations(): List<SessionConfiguration>

override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
delegate = HotwireActivityDelegate(this)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import dev.hotwire.core.turbo.visit.VisitOptions
*/
@Suppress("unused", "MemberVisibilityCanBePrivate")
class HotwireActivityDelegate(val activity: HotwireActivity) {
private val appCompatActivity = activity.appCompatActivity
private val navHostFragments = mutableMapOf<Int, SessionNavHostFragment>()

private val onBackPressedCallback = object : OnBackPressedCallback(enabled = true) {
Expand All @@ -41,9 +40,9 @@ class HotwireActivityDelegate(val activity: HotwireActivity) {
* handles Fragment navigation with the back button.
*/
init {
appCompatActivity.lifecycle.addObserver(HotwireActivityObserver())
appCompatActivity.onBackPressedDispatcher.addCallback(
owner = appCompatActivity,
activity.lifecycle.addObserver(HotwireActivityObserver())
activity.onBackPressedDispatcher.addCallback(
owner = activity,
onBackPressedCallback = onBackPressedCallback
)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class BrowserRoute : Router.Route {
val intent = Intent(Intent.ACTION_VIEW, location.toUri())

try {
activity.appCompatActivity.startActivity(intent)
activity.startActivity(intent)
} catch (e: ActivityNotFoundException) {
logError("BrowserRoute", e)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class BrowserTabRoute : Router.Route {
sessionConfiguration: SessionConfiguration,
activity: HotwireActivity
) {
val color = activity.appCompatActivity.colorFromThemeAttr(R.attr.colorSurface)
val color = activity.colorFromThemeAttr(R.attr.colorSurface)
val colorParams = CustomTabColorSchemeParams.Builder()
.setToolbarColor(color)
.setNavigationBarColor(color)
Expand All @@ -37,6 +37,6 @@ class BrowserTabRoute : Router.Route {
.setUrlBarHidingEnabled(false)
.setDefaultColorSchemeParams(colorParams)
.build()
.launchUrl(activity.appCompatActivity, location.toUri())
.launchUrl(activity, location.toUri())
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ open class SessionNavHostFragment : NavHostFragment() {
internal fun createNewSession() {
session = Session(
sessionName = sessionConfiguration.name,
activity = activity.appCompatActivity,
webView = onCreateWebView(activity.appCompatActivity)
activity = activity,
webView = onCreateWebView(activity)
)
onSessionCreated()
}
Expand Down
7 changes: 1 addition & 6 deletions demo/src/main/kotlin/dev/hotwire/demo/main/MainActivity.kt
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
package dev.hotwire.demo.main

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import dev.hotwire.core.navigation.activities.HotwireActivity
import dev.hotwire.core.navigation.activities.HotwireActivityDelegate
import dev.hotwire.core.navigation.session.SessionConfiguration
import dev.hotwire.demo.R
import dev.hotwire.demo.Urls

class MainActivity : AppCompatActivity(), HotwireActivity {
override val delegate by lazy { HotwireActivityDelegate(this) }
override val appCompatActivity = this

class MainActivity : HotwireActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
Expand Down
11 changes: 4 additions & 7 deletions docs/QUICK-START.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ Android Jetpack provides a [`FragmentContainerView`](https://developer.android.c

Refer to the demo [`activity_main.xml`](../demo/src/main/res/layout/activity_main.xml) for an example.

### Implement the HotwireActivity interface
### Implement the HotwireActivity abstract class

A Hotwire `Activity` is straightforward and needs to implement the [`HotwireActivity`](../core/src/main/kotlin/dev/hotwire/core/turbo/activities/HotwireActivity.kt) interface in order to provide a [`HotwireActivityDelegate`](../core/src/main/kotlin/dev/hotwire/core/turbo/delegates/HotwireActivityDelegate.kt) and `Session` configuration information.
A Hotwire `Activity` is straightforward and needs to subclass the [`HotwireActivity`](../core/src/main/kotlin/dev/hotwire/core/turbo/activities/HotwireActivity.kt) class in order to provide `Session` configuration information.

Your Activity should extend Android Jetpack's [`AppCompatActivity`](https://developer.android.com/reference/androidx/appcompat/app/AppCompatActivity).
`HotwireActivity` extends Android Jetpack's [`AppCompatActivity`](https://developer.android.com/reference/androidx/appcompat/app/AppCompatActivity).

You'll need to provide at least one `SessionConfiguration` instance (one for each `SessionNavHostFragment` that exists in our Activity layout). This includes:
- The `name` of the `Session` (this is arbitrary and helpful for debugging purposes, but each must be unique in your app)
Expand All @@ -62,10 +62,7 @@ In its simplest form, your Activity will look like:

**`MainActivity.kt`:**
```kotlin
class MainActivity : AppCompatActivity(), HotwireActivity {
override val delegate by lazy { HotwireActivityDelegate(this) }
override val appCompatActivity = this

class MainActivity : HotwireActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
Expand Down
Loading