Skip to content

popRoute() documentation is misleading  #118975

Description

@eximius313

Documentation of Future<bool> popRoute() says:

The method should return a boolean [Future] to indicate whether this delegate handles the request. Returning false will cause the entire app to be popped.

While this is true for flat Router structure, it is invalid for nested Router structure.
If popRoute() in NestedRouterDelegate returns false, then entire app is not popped. The ParentRouterDelegate takes charge instead, and on it's popRoute() depends what will happen.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Important issues not at the top of the work listd: api docsIssues with https://api.flutter.dev/f: routesNavigator, Router, and related APIs.frameworkflutter/packages/flutter repository. See also f: labels.team-frameworkOwned by Framework teamtriaged-frameworkTriaged by Framework team

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions