Flutter未知功能插件captain的使用（注意：由于介绍为undefined，以下基于插件名称进行合理推测）

Flutter未知功能插件captain的使用

Captain ⛵️

使用Captain进行声明式导航

Captain允许你以一种声明式的方式进行导航，使得设计复杂的导航变得非常简单。

将Captain放置在Widget树中

将Captain()组件放置在你的Widget树中，位置与Router或Navigator组件相同。最佳实践是将其放在Material/Cupertino/WidgetsApp之下，例如：

MaterialApp(
  home: Captain(
    CaptainConfig([
      PageToShowBeneath(),
      MyBeautifulHomePage(),
    ]),
    // 只有pages是必需的
  ),
),

CaptainConfig

CaptainConfig用于配置Captain的行为。以下是一个示例：

CaptainConfig(
  // 必须的参数
  [MyStartingPage()],
  // 可选的参数
  popPage: (routeThatIsGettingPopped, itsResult, pageStack) => pageStack..removeLast(),
  shouldPop: (pageStack) => pageStack.isNotEmpty,
  actions: {
    'removeEverythingAndAddThePages': (pageStack) {
      pageStack.removeAll();
      return pageStack..addAll([
        Page1(),
        Page2(),
      ]);
    }
  },
  initialRouteInformation: RouteInformation(location: 'initial'),
  parseRouteInformation: (newRouteInformation, pageStack) {
    if (newRouteInformation.location == '/home' && pageStack.length < 2) {
      return HomePage();
    }
  },
  restoreRouteInformation: (page) {
    if (page is Home) {
      return RouteInformation(location: '/welcomeToHome');
    }
  }
)

使用Captain进行导航

Captain支持命令式的导航风格，符合Navigator.of(context)格式。

使用方式

• .action(Object actionKey)用于调用在CaptainConfig中注册的预定义动作。
• .actionFunc(List<Page> Function(List<Page>))用于直接改变页面堆栈并返回新的页面堆栈。

示例

// 调用CaptainConfig中定义的动作
Navigator.of(context).action("myActionKey");

// 直接更改页面堆栈并返回新的页面堆栈
Navigator.of(context).actionFunc((pageStack) => pageStack..add(pageToAdd));

完整示例

以下是一个完整的示例代码：

import 'package:captain/captain.dart';
import 'package:flutter/material.dart';

void main() {
  runApp(
    CaptainApp(),
  );
}

class CaptainApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Captain(
        config: CaptainConfig([
          MaterialPage(
            child: Scaffold(
              body: Builder(
                builder: (context) => Center(
                  child: Column(
                    children: [
                      TextButton(
                        onPressed: () => Navigator.of(context)
                            .actionFunc((pageStack) => pageStack..removeLast()),
                        child: const Text("POP"),
                      ),
                      TextButton(
                        child: const Text("添加页面"),
                        onPressed: () {
                          Navigator.of(context).actionFunc(
                            (pageStack) => pageStack
                              ..add(
                                MaterialPage(
                                  child: Scaffold(
                                    appBar: AppBar(title: Text("新页面")),
                                  ),
                                ),
                              ),
                          );
                        },
                      ),
                    ],
                  ),
                ),
              ),
            ),
          ),
        ]),
      ),
    );
  }
}