/
router.dart
405 lines (372 loc) · 10.8 KB
/
router.dart
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';
import '../../flutter_modular.dart';
import '../interfaces/child_module.dart';
import '../interfaces/route_guard.dart';
import '../transitions/transitions.dart';
import '../utils/old.dart';
typedef RouteBuilder<T> = MaterialPageRoute<T> Function(
WidgetBuilder, RouteSettings);
_debugPrintModular(String text) {
if (Modular.debugMode) {
debugPrint(text);
}
}
class ModularRouter<T> {
///
/// Paramenter name: [routerName]
///
/// Name for your route
///
/// Type: String
///
/// For more example go to Modular page from gitHub [https://github.com/Flutterando/modular]
///
final String routerName;
///
/// Paramenter name: [child]
///
/// The widget will be displayed
///
/// Type: Widget
///
/// For more example go to Modular page from gitHub [https://github.com/Flutterando/modular]
///
final Widget Function(BuildContext context, ModularArguments args) child;
///
/// Paramenter name: [module]
///
/// The module will be loaded
///
/// Type: ChildModule
///
/// For more example go to Modular page from gitHub [https://github.com/Flutterando/modular]
///
final ChildModule module;
///
/// Paramenter name: [params]
///
/// The parameters that can be transferred to another screen
///
/// Type: Map<String, String>
///
/// For more example go to Modular page from gitHub [https://github.com/Flutterando/modular]
///
Map<String, String> params;
///
/// Paramenter name: [guards]
///
/// Route guards are middleware-like objects
///
/// that allow you to control the access of a given route from other route.
///
/// You can implement a route guard by making a class that implements RouteGuard.
///
/// Type: List<RouteGuard>
///
/// Example:
/// ```dart
///class MyGuard implements RouteGuard {
/// @override
/// bool canActivate(String url) {
/// if (url != '/admin'){
/// // Return `true` to allow access
/// return true;
/// } else {
/// // Return `false` to disallow access
/// return false
/// }
/// }
///}
///To use your RouteGuard in a route, pass it to the guards parameter:
///
///@override
///List<Router> get routers => [
/// Router('/', module: HomeModule()),
/// Router(
/// '/admin',
/// module: AdminModule(),
/// guards: [MyGuard()],
/// ),
///];
/// ```
/// For more example go to Modular page from gitHub [https://github.com/Flutterando/modular]
///
final List<RouteGuard> guards;
///
/// Paramenter name: [transition]
///
/// Used to animate the transition from one screen to another
///
/// For more example go to Modular page from gitHub [https://github.com/Flutterando/modular]
///
final TransitionType transition;
///
/// Paramenter name: [customTransiton]
///
/// PS: For [customTransition] to work,
///
/// you must set the [transition] parameter for
/// ```dart
/// transition.custom,
/// ```
///
/// Example: Using just First Animation
/// ```dart
/// customTransition: CustomTransition(
/// transitionBuilder: (context, animation, secondaryAnimation, child) {
/// return SlideTransition(
/// transformHitTests: false,
/// position: Tween<Offset>(
/// begin: const Offset(0.0, 1.0),
/// end: Offset.zero,
/// ).chain(CurveTween(curve: Curves.ease)).animate(animation),
/// child: child);
/// },
/// ),
/// ```
/// Example: Using just secondaryAnimation
/// ```dart
/// customTransition: CustomTransition(
/// transitionBuilder: (context, animation, secondaryAnimation, child) {
/// return SlideTransition(
/// transformHitTests: false,
/// position: Tween<Offset>(
/// begin: const Offset(0.0, 1.0),
/// end: Offset.zero,
/// ).chain(CurveTween(curve: Curves.ease)).animate(animation),
/// child: SlideTransition(
/// transformHitTests: false,
/// position: Tween<Offset>(
/// begin: Offset.zero,
/// end: const Offset(0.0, -1.0),
/// ).chain(CurveTween(curve: Curves.ease)).animate(secondaryAnimation),
/// child: child,
/// ),
/// );
/// },
/// ),
/// ```
/// For more example go to Modular page from gitHub [https://github.com/Flutterando/modular]
///
final CustomTransition customTransition;
///
/// Paramenter name: [transition]
///
/// Used to animate the transition from one screen to another
///
/// For more example go to Modular page from gitHub [https://github.com/Flutterando/modular]
///
final RouteBuilder<T> routeGenerator;
final String modulePath;
ModularRouter(
this.routerName, {
this.module,
this.child,
this.guards,
this.params,
this.transition = TransitionType.defaultTransition,
this.routeGenerator,
this.customTransition,
this.modulePath,
}) {
assert(routerName != null);
if (transition == null) throw ArgumentError('transition must not be null');
if (transition == TransitionType.custom && customTransition == null) {
throw ArgumentError(
'[customTransition] required for transition type [TransitionType.custom]');
}
if (module == null && child == null) {
throw ArgumentError('[module] or [child] must be provided');
}
if (module != null && child != null) {
throw ArgumentError('You should provide only [module] or [child]');
}
}
final Map<
TransitionType,
PageRouteBuilder<T> Function(
Widget Function(BuildContext, ModularArguments) builder,
ModularArguments args,
RouteSettings settings,
)> _transitions = {
TransitionType.fadeIn: fadeInTransition,
TransitionType.noTransition: noTransition,
TransitionType.rightToLeft: rightToLeft,
TransitionType.leftToRight: leftToRight,
TransitionType.upToDown: upToDown,
TransitionType.downToUp: downToUp,
TransitionType.scale: scale,
TransitionType.rotate: rotate,
TransitionType.size: size,
TransitionType.rightToLeftWithFade: rightToLeftWithFade,
TransitionType.leftToRightWithFade: leftToRightWithFade,
};
ModularRouter<T> copyWith(
{Widget Function(BuildContext context, ModularArguments args) child,
String routerName,
ChildModule module,
Map<String, String> params,
List<RouteGuard> guards,
TransitionType transition,
RouteBuilder routeGenerator,
String modulePath,
CustomTransition customTransition}) {
return ModularRouter<T>(
routerName ?? this.routerName,
child: child ?? this.child,
module: module ?? this.module,
params: params ?? this.params,
modulePath: modulePath ?? this.modulePath,
guards: guards ?? this.guards,
routeGenerator: routeGenerator ?? this.routeGenerator,
transition: transition ?? this.transition,
customTransition: customTransition ?? this.customTransition,
);
}
static List<ModularRouter> group({
@required List<ModularRouter> routes,
List<RouteGuard> guards,
TransitionType transition,
CustomTransition customTransition,
}) {
return routes.map((r) {
return r.copyWith(
guards: guards,
transition: transition ?? r.transition,
customTransition: customTransition ?? r.customTransition,
);
}).toList();
}
Widget _disposableGenerate({
Map<String, ChildModule> injectMap,
bool isRouterOutlet,
String path,
}) {
Widget page = _DisposableWidget(
child: child,
dispose: (old, actual) {
final trash = <String>[];
if (!isRouterOutlet) {
Modular.oldProccess(old);
}
if (actual.isCurrent) {
return;
}
injectMap.forEach((key, module) {
module.paths.remove(path);
if (module.paths.length == 0) {
module.cleanInjects();
trash.add(key);
_debugPrintModular("-- ${module.runtimeType.toString()} DISPOSED");
}
});
for (final key in trash) {
injectMap.remove(key);
}
},
);
return page;
}
Route<T> getPageRoute(
{Map<String, ChildModule> injectMap,
RouteSettings settings,
bool isRouterOutlet}) {
final disposablePage = _disposableGenerate(
injectMap: injectMap,
path: settings.name,
isRouterOutlet: isRouterOutlet);
if (transition == TransitionType.custom && customTransition != null) {
return PageRouteBuilder(
pageBuilder: (context, _, __) {
return disposablePage;
},
settings: settings,
transitionsBuilder: customTransition.transitionBuilder,
transitionDuration: customTransition.transitionDuration,
);
} else if (transition == TransitionType.defaultTransition) {
// Helper function
Widget widgetBuilder(BuildContext context) {
return disposablePage;
}
if (routeGenerator != null) {
return routeGenerator(widgetBuilder, settings);
}
return Modular.isCupertino
? CupertinoPageRoute<T>(
settings: settings,
builder: widgetBuilder,
)
: MaterialPageRoute<T>(
settings: settings,
builder: widgetBuilder,
);
} else {
var selectTransition = _transitions[transition];
return selectTransition((context, args) {
return disposablePage;
}, Modular.args, settings);
}
}
}
enum TransitionType {
defaultTransition,
fadeIn,
noTransition,
rightToLeft,
leftToRight,
upToDown,
downToUp,
scale,
rotate,
size,
rightToLeftWithFade,
leftToRightWithFade,
custom,
}
class CustomTransition {
final Widget Function(
BuildContext, Animation<double>, Animation<double>, Widget)
transitionBuilder;
final Duration transitionDuration;
CustomTransition(
{@required this.transitionBuilder,
this.transitionDuration = const Duration(milliseconds: 300)});
}
class _DisposableWidget extends StatefulWidget {
final Function(Old old, ModalRoute actual) dispose;
final Widget Function(BuildContext context, ModularArguments args) child;
_DisposableWidget({
Key key,
this.dispose,
this.child,
}) : super(key: key);
@override
__DisposableWidgetState createState() => __DisposableWidgetState();
}
class __DisposableWidgetState extends State<_DisposableWidget> {
Old old;
ModalRoute actual;
ModularArguments args;
@override
void initState() {
super.initState();
old = Modular.old;
args = Modular.args;
}
@override
void didChangeDependencies() {
super.didChangeDependencies();
actual = ModalRoute.of(context);
}
@override
void dispose() {
widget.dispose(old, actual);
super.dispose();
}
@override
Widget build(BuildContext context) {
return widget.child(context, args);
}
}