シェルとタブ

シェルとは、そのブランチの画面が変わっても残るアプリの部分です。下部のタブ、サイドメニュー、ヘッダーなどです。各ブランチは独自のスタックを持ち、パスがブランチで始まる画面はそのブランチの中で、そのパスの画面を下にして開きます。

使う理由

独自の履歴を持つタブは、手で書くナビゲーションの中で最も難しい部分です。各タブに独自の Navigator が必要で、戻るボタンは正しい画面を閉じなければならず、タブの中へのディープリンクはその下のスタックを組み立てなければなりません。シェルはブランチをそのパスで宣言し、残りはルーターが行います。

例

@RouteShell(branches: ['/catalog', '/profile'])
class MainTabs extends StatelessWidget {
  const MainTabs(this.shell, {super.key});

  final ShellState shell;

  @override
  Widget build(BuildContext context) => Scaffold(
    body: shell.child,
    bottomNavigationBar: NavigationBar(
      selectedIndex: shell.index,
      onDestinationSelected: shell.select,
      destinations: const [
        NavigationDestination(icon: Icon(Icons.book), label: 'Catalog'),
        NavigationDestination(icon: Icon(Icons.person), label: 'Profile'),
      ],
    ),
  );
}

Scaffold と NavigationBar は Material のウィジェットです。それを使うアプリは material の種類で、依存関係に spring_boot_starter_flutter_material と material_ui を持ちます (セットアップ を参照)。

ShellState

メンバー 意味
child 現在のブランチの画面。コンテンツの場所に置く。他のブランチは一度訪れると構築されたまま (画面外に) 残るため、それぞれがスタックと状態を保つ
index branches の中での現在のブランチのインデックス
branches ブランチを始めるパス
branch 現在のブランチのパス
select(index) 離れたときの状態のブランチ、一度も訪れていなければその最初の画面に切り替える。現在のブランチを再び選ぶと、その最初の画面に戻る

別のブランチの画面

画面は、パスがその下にないブランチの中に置くことができます。そのためアドレスは平坦なままです。@ScreenRoute('/motion', branch: '/more') は /more タブの中で、タブの最初の画面 (/more) の上に開き、戻るとそこに戻ります。

@RouteShell(branches: ['/catalog', '/more'])
class MainTabs extends StatelessWidget { ... }

@ScreenRoute('/motion', branch: '/more')
class MotionSettingsPage extends StatelessWidget { ... }

Dart の設定では、ブランチの中で宣言されながらそのパスの外にある画面が同じように動きます。または screen(...) に branch: '/more' を渡します。どのシェルも持たないブランチは起動を止めます。

ブランチごとの Bean

@Scope(NavigationScopes.branch) を持つ Bean は、そのブランチが存在する間、つまりシェルが閉じるまで存在します (画面やブランチごとの Bean を参照)。

関連項目