ganfra
9 months ago
19 changed files with 192 additions and 185 deletions
@ -1,57 +0,0 @@ |
|||||||
/* |
|
||||||
* Copyright (c) 2023 New Vector Ltd |
|
||||||
* |
|
||||||
* 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. |
|
||||||
*/ |
|
||||||
|
|
||||||
package io.element.android.libraries.architecture |
|
||||||
|
|
||||||
import androidx.compose.runtime.Stable |
|
||||||
import com.bumble.appyx.core.children.ChildEntry |
|
||||||
import com.bumble.appyx.core.modality.BuildContext |
|
||||||
import com.bumble.appyx.core.navigation.model.combined.plus |
|
||||||
import com.bumble.appyx.core.navigation.model.permanent.PermanentNavModel |
|
||||||
import com.bumble.appyx.core.node.Node |
|
||||||
import com.bumble.appyx.core.node.ParentNode |
|
||||||
import com.bumble.appyx.core.plugin.Plugin |
|
||||||
import com.bumble.appyx.navmodel.backstack.BackStack |
|
||||||
|
|
||||||
/** |
|
||||||
* This class is just an helper for configuring a backstack directly in the constructor. |
|
||||||
* With this we can more easily use constructor injection without having a secondary constructor to create the [BackStack] instance. |
|
||||||
* Can be used instead of [ParentNode] in flow nodes. |
|
||||||
*/ |
|
||||||
@Stable |
|
||||||
abstract class BackstackNode<NavTarget : Any>( |
|
||||||
val backstack: BackStack<NavTarget>, |
|
||||||
buildContext: BuildContext, |
|
||||||
plugins: List<Plugin>, |
|
||||||
val permanentNavModel: PermanentNavModel<NavTarget> = PermanentNavModel(emptySet(), null), |
|
||||||
childKeepMode: ChildEntry.KeepMode = ChildEntry.KeepMode.KEEP, |
|
||||||
) : ParentNode<NavTarget>( |
|
||||||
navModel = backstack + permanentNavModel, |
|
||||||
buildContext = buildContext, |
|
||||||
plugins = plugins, |
|
||||||
childKeepMode = childKeepMode, |
|
||||||
) { |
|
||||||
override fun onBuilt() { |
|
||||||
super.onBuilt() |
|
||||||
lifecycle.logLifecycle(this::class.java.simpleName) |
|
||||||
whenChildAttached<Node> { _, child -> |
|
||||||
// BackstackNode will be logged by their parent. |
|
||||||
if (child !is BackstackNode<*>) { |
|
||||||
child.lifecycle.logLifecycle(child::class.java.simpleName) |
|
||||||
} |
|
||||||
} |
|
||||||
} |
|
||||||
} |
|
||||||
@ -0,0 +1,106 @@ |
|||||||
|
/* |
||||||
|
* Copyright (c) 2023 New Vector Ltd |
||||||
|
* |
||||||
|
* 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. |
||||||
|
*/ |
||||||
|
|
||||||
|
package io.element.android.libraries.architecture |
||||||
|
|
||||||
|
import androidx.compose.animation.core.Spring |
||||||
|
import androidx.compose.animation.core.spring |
||||||
|
import androidx.compose.foundation.layout.Box |
||||||
|
import androidx.compose.foundation.layout.BoxScope |
||||||
|
import androidx.compose.runtime.Composable |
||||||
|
import androidx.compose.runtime.Stable |
||||||
|
import androidx.compose.ui.Modifier |
||||||
|
import com.bumble.appyx.core.children.ChildEntry |
||||||
|
import com.bumble.appyx.core.composable.Children |
||||||
|
import com.bumble.appyx.core.modality.BuildContext |
||||||
|
import com.bumble.appyx.core.navigation.model.combined.plus |
||||||
|
import com.bumble.appyx.core.navigation.model.permanent.PermanentNavModel |
||||||
|
import com.bumble.appyx.core.navigation.transition.TransitionHandler |
||||||
|
import com.bumble.appyx.core.node.Node |
||||||
|
import com.bumble.appyx.core.node.ParentNode |
||||||
|
import com.bumble.appyx.core.plugin.Plugin |
||||||
|
import com.bumble.appyx.navmodel.backstack.BackStack |
||||||
|
import com.bumble.appyx.navmodel.backstack.transitionhandler.rememberBackstackFader |
||||||
|
import com.bumble.appyx.navmodel.backstack.transitionhandler.rememberBackstackSlider |
||||||
|
import io.element.android.libraries.architecture.overlay.Overlay |
||||||
|
|
||||||
|
/** |
||||||
|
* This class is a [ParentNode] that contains a [BackStack] and an [Overlay]. It is used to represent a flow in the app. |
||||||
|
* Should be used instead of [ParentNode] in flow nodes. |
||||||
|
*/ |
||||||
|
@Stable |
||||||
|
abstract class BaseFlowNode<NavTarget : Any>( |
||||||
|
val backstack: BackStack<NavTarget>, |
||||||
|
buildContext: BuildContext, |
||||||
|
plugins: List<Plugin>, |
||||||
|
val overlay: Overlay<NavTarget> = Overlay(null), |
||||||
|
val permanentNavModel: PermanentNavModel<NavTarget> = PermanentNavModel(emptySet(), null), |
||||||
|
childKeepMode: ChildEntry.KeepMode = ChildEntry.KeepMode.KEEP, |
||||||
|
) : ParentNode<NavTarget>( |
||||||
|
navModel = overlay + backstack + permanentNavModel, |
||||||
|
buildContext = buildContext, |
||||||
|
plugins = plugins, |
||||||
|
childKeepMode = childKeepMode, |
||||||
|
) { |
||||||
|
override fun onBuilt() { |
||||||
|
super.onBuilt() |
||||||
|
lifecycle.logLifecycle(this::class.java.simpleName) |
||||||
|
whenChildAttached<Node> { _, child -> |
||||||
|
// BackstackNode will be logged by their parent. |
||||||
|
if (child !is BaseFlowNode<*>) { |
||||||
|
child.lifecycle.logLifecycle(child::class.java.simpleName) |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
@Composable |
||||||
|
inline fun <reified NavTarget : Any> BaseFlowNode<NavTarget>.BackstackView( |
||||||
|
modifier: Modifier = Modifier, |
||||||
|
transitionHandler: TransitionHandler<NavTarget, BackStack.State> = rememberBackstackSlider( |
||||||
|
transitionSpec = { spring(stiffness = Spring.StiffnessMediumLow) }, |
||||||
|
), |
||||||
|
) { |
||||||
|
Children( |
||||||
|
modifier = modifier, |
||||||
|
navModel = backstack, |
||||||
|
transitionHandler = transitionHandler, |
||||||
|
) |
||||||
|
} |
||||||
|
|
||||||
|
@Composable |
||||||
|
inline fun <reified NavTarget : Any> BaseFlowNode<NavTarget>.OverlayView( |
||||||
|
modifier: Modifier = Modifier, |
||||||
|
transitionHandler: TransitionHandler<NavTarget, BackStack.State> = rememberBackstackFader(), |
||||||
|
) { |
||||||
|
Children( |
||||||
|
modifier = modifier, |
||||||
|
navModel = overlay, |
||||||
|
transitionHandler = transitionHandler, |
||||||
|
) |
||||||
|
} |
||||||
|
|
||||||
|
@Composable |
||||||
|
inline fun <reified NavTarget : Any> BaseFlowNode<NavTarget>.BackstackWithOverlayBox( |
||||||
|
modifier: Modifier = Modifier, |
||||||
|
content: @Composable BoxScope.() -> Unit = {}, |
||||||
|
) { |
||||||
|
Box(modifier = modifier) { |
||||||
|
BackstackView() |
||||||
|
OverlayView() |
||||||
|
content() |
||||||
|
} |
||||||
|
} |
||||||
Loading…
Reference in new issue