mirror of
https://github.com/flutter/samples.git
synced 2025-11-08 22:09:06 +00:00
Rename Navigator 2.0 to Router (#712)
* Rename Navigator 2.0 to Router This aligns better with the documentation for this new API, and doesn't imply that apps need to be upgraded. * introduction -> navigator
This commit is contained in:
John Ryan
GitHub
142
navigation_and_routing/lib/router/pages.dart
Normal file
142
navigation_and_routing/lib/router/pages.dart
Normal file
@@ -0,0 +1,142 @@
|
||||
// Copyright 2020, the Flutter project authors. Please see the AUTHORS file
|
||||
// for details. All rights reserved. Use of this source code is governed by a
|
||||
// BSD-style license that can be found in the LICENSE file.
|
||||
|
||||
/// Shows how to define a list of [Page] objects on Navigator declaratively.
|
||||
library nav2_pages;
|
||||
|
||||
import 'package:flutter/material.dart';
|
||||
|
||||
void main() {
|
||||
runApp(BooksApp());
|
||||
}
|
||||
|
||||
class Book {
|
||||
final String title;
|
||||
final String author;
|
||||
|
||||
Book(this.title, this.author);
|
||||
}
|
||||
|
||||
class BooksApp extends StatefulWidget {
|
||||
@override
|
||||
State<StatefulWidget> createState() => _BooksAppState();
|
||||
}
|
||||
|
||||
class _BooksAppState extends State<BooksApp> {
|
||||
Book _selectedBook;
|
||||
|
||||
List<Book> books = [
|
||||
Book('Stranger in a Strange Land', 'Robert A. Heinlein'),
|
||||
Book('Foundation', 'Isaac Asimov'),
|
||||
Book('Fahrenheit 451', 'Ray Bradbury'),
|
||||
];
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return MaterialApp(
|
||||
title: 'Books App',
|
||||
home: Navigator(
|
||||
pages: [
|
||||
MaterialPage(
|
||||
key: ValueKey('BooksListPage'),
|
||||
child: BooksListScreen(
|
||||
books: books,
|
||||
onTapped: _handleBookTapped,
|
||||
),
|
||||
),
|
||||
if (_selectedBook != null) BookDetailsPage(book: _selectedBook)
|
||||
],
|
||||
onPopPage: (route, result) {
|
||||
if (!route.didPop(result)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Update the list of pages by setting _selectedBook to null
|
||||
setState(() {
|
||||
_selectedBook = null;
|
||||
});
|
||||
|
||||
return true;
|
||||
},
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
void _handleBookTapped(Book book) {
|
||||
setState(() {
|
||||
_selectedBook = book;
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
class BookDetailsPage extends Page {
|
||||
final Book book;
|
||||
|
||||
BookDetailsPage({
|
||||
this.book,
|
||||
}) : super(key: ValueKey(book));
|
||||
|
||||
Route createRoute(BuildContext context) {
|
||||
return MaterialPageRoute(
|
||||
settings: this,
|
||||
builder: (BuildContext context) {
|
||||
return BookDetailsScreen(book: book);
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
class BooksListScreen extends StatelessWidget {
|
||||
final List<Book> books;
|
||||
final ValueChanged<Book> onTapped;
|
||||
|
||||
BooksListScreen({
|
||||
@required this.books,
|
||||
@required this.onTapped,
|
||||
});
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return Scaffold(
|
||||
appBar: AppBar(),
|
||||
body: ListView(
|
||||
children: [
|
||||
for (var book in books)
|
||||
ListTile(
|
||||
title: Text(book.title),
|
||||
subtitle: Text(book.author),
|
||||
onTap: () => onTapped(book),
|
||||
)
|
||||
],
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
class BookDetailsScreen extends StatelessWidget {
|
||||
final Book book;
|
||||
|
||||
BookDetailsScreen({
|
||||
@required this.book,
|
||||
});
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return Scaffold(
|
||||
appBar: AppBar(),
|
||||
body: Padding(
|
||||
padding: const EdgeInsets.all(8.0),
|
||||
child: Column(
|
||||
crossAxisAlignment: CrossAxisAlignment.start,
|
||||
children: [
|
||||
if (book != null) ...[
|
||||
Text(book.title, style: Theme.of(context).textTheme.headline6),
|
||||
Text(book.author, style: Theme.of(context).textTheme.subtitle1),
|
||||
],
|
||||
],
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
263
navigation_and_routing/lib/router/router.dart
Normal file
263
navigation_and_routing/lib/router/router.dart
Normal file
@@ -0,0 +1,263 @@
|
||||
// Copyright 2020, the Flutter project authors. Please see the AUTHORS file
|
||||
// for details. All rights reserved. Use of this source code is governed by a
|
||||
// BSD-style license that can be found in the LICENSE file.
|
||||
|
||||
/// Full sample that shows a custom RouteInformationParser and RouterDelegate
|
||||
/// parsing named routes and declaratively building the stack of pages for the
|
||||
/// [Navigator].
|
||||
import 'package:flutter/material.dart';
|
||||
|
||||
void main() {
|
||||
runApp(BooksApp());
|
||||
}
|
||||
|
||||
class Book {
|
||||
final String title;
|
||||
final String author;
|
||||
|
||||
Book(this.title, this.author);
|
||||
}
|
||||
|
||||
class BooksApp extends StatefulWidget {
|
||||
@override
|
||||
State<StatefulWidget> createState() => _BooksAppState();
|
||||
}
|
||||
|
||||
class _BooksAppState extends State<BooksApp> {
|
||||
BookRouterDelegate _routerDelegate = BookRouterDelegate();
|
||||
BookRouteInformationParser _routeInformationParser =
|
||||
BookRouteInformationParser();
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return MaterialApp.router(
|
||||
title: 'Books App',
|
||||
routerDelegate: _routerDelegate,
|
||||
routeInformationParser: _routeInformationParser,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
class BookRouteInformationParser extends RouteInformationParser<BookRoutePath> {
|
||||
@override
|
||||
Future<BookRoutePath> parseRouteInformation(
|
||||
RouteInformation routeInformation) async {
|
||||
final uri = Uri.parse(routeInformation.location);
|
||||
// Handle '/'
|
||||
if (uri.pathSegments.length == 0) {
|
||||
return BookRoutePath.home();
|
||||
}
|
||||
|
||||
// Handle '/book/:id'
|
||||
if (uri.pathSegments.length == 2) {
|
||||
if (uri.pathSegments[0] != 'book') return BookRoutePath.unknown();
|
||||
var remaining = uri.pathSegments[1];
|
||||
var id = int.tryParse(remaining);
|
||||
if (id == null) return BookRoutePath.unknown();
|
||||
return BookRoutePath.details(id);
|
||||
}
|
||||
|
||||
// Handle unknown routes
|
||||
return BookRoutePath.unknown();
|
||||
}
|
||||
|
||||
@override
|
||||
RouteInformation restoreRouteInformation(BookRoutePath path) {
|
||||
if (path.isUnknown) {
|
||||
return RouteInformation(location: '/404');
|
||||
}
|
||||
if (path.isHomePage) {
|
||||
return RouteInformation(location: '/');
|
||||
}
|
||||
if (path.isDetailsPage) {
|
||||
return RouteInformation(location: '/book/${path.id}');
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
class BookRouterDelegate extends RouterDelegate<BookRoutePath>
|
||||
with ChangeNotifier, PopNavigatorRouterDelegateMixin<BookRoutePath> {
|
||||
final GlobalKey<NavigatorState> navigatorKey;
|
||||
|
||||
Book _selectedBook;
|
||||
bool show404 = false;
|
||||
|
||||
List<Book> books = [
|
||||
Book('Stranger in a Strange Land', 'Robert A. Heinlein'),
|
||||
Book('Foundation', 'Isaac Asimov'),
|
||||
Book('Fahrenheit 451', 'Ray Bradbury'),
|
||||
];
|
||||
|
||||
BookRouterDelegate() : navigatorKey = GlobalKey<NavigatorState>();
|
||||
|
||||
BookRoutePath get currentConfiguration {
|
||||
if (show404) {
|
||||
return BookRoutePath.unknown();
|
||||
}
|
||||
return _selectedBook == null
|
||||
? BookRoutePath.home()
|
||||
: BookRoutePath.details(books.indexOf(_selectedBook));
|
||||
}
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return Navigator(
|
||||
key: navigatorKey,
|
||||
pages: [
|
||||
MaterialPage(
|
||||
key: ValueKey('BooksListPage'),
|
||||
child: BooksListScreen(
|
||||
books: books,
|
||||
onTapped: _handleBookTapped,
|
||||
),
|
||||
),
|
||||
if (show404)
|
||||
MaterialPage(key: ValueKey('UnknownPage'), child: UnknownScreen())
|
||||
else if (_selectedBook != null)
|
||||
BookDetailsPage(book: _selectedBook)
|
||||
],
|
||||
onPopPage: (route, result) {
|
||||
if (!route.didPop(result)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Update the list of pages by setting _selectedBook to null
|
||||
_selectedBook = null;
|
||||
show404 = false;
|
||||
notifyListeners();
|
||||
|
||||
return true;
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
@override
|
||||
Future<void> setNewRoutePath(BookRoutePath path) async {
|
||||
if (path.isUnknown) {
|
||||
_selectedBook = null;
|
||||
show404 = true;
|
||||
return;
|
||||
}
|
||||
|
||||
if (path.isDetailsPage) {
|
||||
if (path.id < 0 || path.id > books.length - 1) {
|
||||
show404 = true;
|
||||
return;
|
||||
}
|
||||
|
||||
_selectedBook = books[path.id];
|
||||
} else {
|
||||
_selectedBook = null;
|
||||
}
|
||||
|
||||
show404 = false;
|
||||
}
|
||||
|
||||
void _handleBookTapped(Book book) {
|
||||
_selectedBook = book;
|
||||
notifyListeners();
|
||||
}
|
||||
}
|
||||
|
||||
class BookDetailsPage extends Page {
|
||||
final Book book;
|
||||
|
||||
BookDetailsPage({
|
||||
this.book,
|
||||
}) : super(key: ValueKey(book));
|
||||
|
||||
Route createRoute(BuildContext context) {
|
||||
return MaterialPageRoute(
|
||||
settings: this,
|
||||
builder: (BuildContext context) {
|
||||
return BookDetailsScreen(book: book);
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
class BookRoutePath {
|
||||
final int id;
|
||||
final bool isUnknown;
|
||||
|
||||
BookRoutePath.home()
|
||||
: id = null,
|
||||
isUnknown = false;
|
||||
|
||||
BookRoutePath.details(this.id) : isUnknown = false;
|
||||
|
||||
BookRoutePath.unknown()
|
||||
: id = null,
|
||||
isUnknown = true;
|
||||
|
||||
bool get isHomePage => id == null;
|
||||
|
||||
bool get isDetailsPage => id != null;
|
||||
}
|
||||
|
||||
class BooksListScreen extends StatelessWidget {
|
||||
final List<Book> books;
|
||||
final ValueChanged<Book> onTapped;
|
||||
|
||||
BooksListScreen({
|
||||
@required this.books,
|
||||
@required this.onTapped,
|
||||
});
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return Scaffold(
|
||||
appBar: AppBar(),
|
||||
body: ListView(
|
||||
children: [
|
||||
for (var book in books)
|
||||
ListTile(
|
||||
title: Text(book.title),
|
||||
subtitle: Text(book.author),
|
||||
onTap: () => onTapped(book),
|
||||
)
|
||||
],
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
class BookDetailsScreen extends StatelessWidget {
|
||||
final Book book;
|
||||
|
||||
BookDetailsScreen({
|
||||
@required this.book,
|
||||
});
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return Scaffold(
|
||||
appBar: AppBar(),
|
||||
body: Padding(
|
||||
padding: const EdgeInsets.all(8.0),
|
||||
child: Column(
|
||||
crossAxisAlignment: CrossAxisAlignment.start,
|
||||
children: [
|
||||
if (book != null) ...[
|
||||
Text(book.title, style: Theme.of(context).textTheme.headline6),
|
||||
Text(book.author, style: Theme.of(context).textTheme.subtitle1),
|
||||
],
|
||||
],
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
class UnknownScreen extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return Scaffold(
|
||||
appBar: AppBar(),
|
||||
body: Center(
|
||||
child: Text('404!'),
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user