-
Notifications
You must be signed in to change notification settings - Fork 2
/
Navigator.kt
180 lines (159 loc) · 6.96 KB
/
Navigator.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
/*
* Copyright (c) 2022, Nordic Semiconductor
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors may be
* used to endorse or promote products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
@file:Suppress("unused")
package no.nordicsemi.android.common.navigation
import android.net.Uri
import android.os.Bundle
import androidx.lifecycle.SavedStateHandle
import androidx.navigation.NavOptions
import androidx.navigation.NavOptionsBuilder
import androidx.navigation.PopUpToBuilder
import androidx.navigation.navOptions
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.mapNotNull
import kotlinx.parcelize.RawValue
import no.nordicsemi.android.common.navigation.internal.NavigationManager
import no.nordicsemi.android.common.navigation.internal.START_DESTINATION
interface Navigator {
/**
* Creates a flow that will emit the results of the navigation from the given destination.
*
* @param from The origin destination to listen for results from.
*/
fun <R> resultFrom(from: DestinationId<*, R>): Flow<NavigationResult<R>>
/**
* Requests navigation to the given destination. An required parameter must be passed.
*
* @param to The destination to navigate to.
* @param args An optional argument to pass to the destination. The argument will be saved
* in [SavedStateHandle], therefore it must be savable to a [Bundle].
* @param navOptions An optional [NavOptions] to use for this navigation.
*/
fun <A> navigateTo(to: DestinationId<A, *>, args: @RawValue A, navOptions: NavOptions? = null)
/**
* Requests navigation to the given destination. An required parameter must be passed.
*
* @param to The destination to navigate to.
* @param args An optional argument to pass to the destination. The argument will be saved
* in [SavedStateHandle], therefore it must be savable to a [Bundle].
* @param builder An optional [NavOptions] builder to use for this navigation.
*/
fun <A> navigateTo(to: DestinationId<A, *>, args: @RawValue A, builder: NavOptionsBuilder.() -> Unit) =
navigateTo(to, args, navOptions(builder))
/**
* Requests navigation to the given destination which takes no input parameter.
*
* @param to The destination to navigate to.
* @param navOptions An optional [NavOptions] to use for this navigation.
*/
fun navigateTo(to: DestinationId<Unit, *>, navOptions: NavOptions? = null) =
navigateTo(to, Unit, navOptions)
/**
* Requests navigation to the given destination which takes no input parameter.
*
* @param to The destination to navigate to.
* @param builder An optional [NavOptions] builder to use for this navigation.
*/
fun navigateTo(to: DestinationId<Unit, *>, builder: NavOptionsBuilder.() -> Unit) =
navigateTo(to, Unit, navOptions(builder))
/**
* Navigates up to previous destination, or finishes the Activity.
*/
fun navigateUp()
/**
* Navigates up to previous destination passing the given result, or finishes the Activity.
*
* @param from The destination from which navigating up.
* @param result The result, which will be passed to the previous destination.
* The returned object will be saved in [SavedStateHandle], therefore it must be
* savable to a [Bundle].
*/
fun <R> navigateUpWithResult(from: DestinationId<*, R>, result: @RawValue R)
/**
* Checks whether the given destination is in the back stack.
*/
fun isInHierarchy(destination: DestinationId<*, *>): StateFlow<Boolean>
/**
* Current destination as flow.
*/
fun currentDestination(): StateFlow<DestinationId<*, *>?>
/**
* Opens the given link in a browser.
*/
fun open(link: Uri)
}
/**
* Returns current emission as [NavigationResult.Success] if valid.
*/
fun <T> Flow<NavigationResult<T>>.onlySuccess() = this.mapNotNull { it as? NavigationResult.Success }
/**
* Returns the argument for the current destination as Flow.
*
* @param destination The current destination.
*/
fun <A> SavedStateHandle.getStateFlow(destination: DestinationId<A, *>, initial: A?): StateFlow<A?> =
getStateFlow(destination.name, initial)
/**
* Returns the argument for the current destination.
*
* @param destination The current destination.
*/
fun <A> SavedStateHandle.getOrNull(destination: DestinationId<A?, *>): A? =
get(destination.name)
/**
* Returns the argument for the current destination.
*
* @param destination The current destination.
*/
fun <A> SavedStateHandle.get(destination: DestinationId<A & Any, *>): A =
get(destination.name) ?: error("Destination '${destination.name}' requires a non-nullable argument")
/**
* Returns the argument for the current destination.
*
* @param destination The current destination.
*/
fun SavedStateHandle.get(destination: DestinationId<Unit, *>): Nothing =
error("Destination '${destination.name}' does not have an argument")
/**
* Pop up to a given destination before navigating. This pops all non-matching destination routes
* from the back stack until the destination with a matching route is found.
*/
fun NavOptionsBuilder.popUpTo(
destination: DestinationId<*, *>,
popUpToBuilder: PopUpToBuilder.() -> Unit = {}
) = popUpTo(destination.name, popUpToBuilder)
/**
* Pop up to the start destination before navigating. This pops all non-matching destination routes
* from the back stack until the destination with a matching route is found.
*/
fun NavOptionsBuilder.popUpToStartDestination(popUpToBuilder: PopUpToBuilder.() -> Unit = {}) =
popUpTo(START_DESTINATION, popUpToBuilder)