Navigator 页面 API 重大变更

对 Navigator 页面 API 进行了重构，以便它们能够与 Flutter 的其他退出机制集成。

添加了 onPopPage 属性，用于在页面即将退出时进行清理。要阻止退出，您需要在回调函数中返回 false。这与其他框架中的退出机制（例如 PopScope 和 iOS 返回手势）配合不佳。

为了将框架的退出机制整合在一起，需要重构页面 API。

onDidRemovePage 属性取代了 onPopPage 属性。您现在无法在 onDidRemovePage 属性中阻止退出。相反，您只需负责更新 pages。

退出机制现在通过 Page.canPop 和 Page.onPopInvoked 属性进行管理。这些属性的功能类似于您使用 PopScope widget 的方式。

迁移前的代码

dartimport 'package:flutter/material.dart';

final MaterialPage<void> page1 = MaterialPage<void>(child: Placeholder());
final MaterialPage<void> page2 = MaterialPage<void>(child: Placeholder());
final MaterialPage<void> page3 = MaterialPage<void>(child: Placeholder());

void main() {
  final List<Page<void>> pages = <Page<void>>[page1, page2, page3];
  runApp(
    MaterialApp(
      home: Navigator(
        pages: pages,
        onPopPage: (Route<Object?> route, Object? result) {
          if (route.settings == page2) {
            return false;
          }
          if (route.didPop) {
            pages.remove(route.settings);
            return true;
          }
          return false;
        },
      ),
    ),
  );
}

迁移后的代码

dartimport 'package:flutter/material.dart';

final MaterialPage<void> page1 = MaterialPage<void>(child: Placeholder());
final MaterialPage<void> page2 = MaterialPage<void>(canPop: false, child: Placeholder());
final MaterialPage<void> page3 = MaterialPage<void>(child: Placeholder());

void main() {
  final List<Page<void>> pages = <Page<void>>[page1, page2, page3];
  runApp(
    MaterialApp(
      home: Navigator(
        pages: pages,
        onDidRemovePage: (Page<Object?> page) {
          pages.remove(page);
        },
      ),
    ),
  );
}

已在版本中落地：3.22.0-32.0.pre
稳定版本：3.24.0

API 文档

Navigator 页面 API 重大变更

概述

背景

变更说明

迁移指南

时间线

参考资料