[material_ui][cupertino_ui] allow page routes to opt out of route semantics - #182556

[haashem]

Nested navigators may use routes to update only part of the visible screen. However, Material and Cupertino page routes currently introduce a semantics route scope, causing screen readers to treat these updates as navigation to a new screen.

This adds includeRouteSemantics to:

• MaterialPageRoute
• MaterialPage
• CupertinoPageRoute
• CupertinoPage

The option defaults to true, preserving existing behavior. When set to false, the route content is not wrapped in a semantics node with scopesRoute: true.

Tests cover both imperative routes and declarative pages.

Fixes flutter/flutter#168915.

Pre-Review Checklist

• I read the Contributor Guide and followed the process outlined there for submitting PRs.
• I read the AI contribution guidelines and understand my responsibilities, or I am not using AI tools.
• I read the Tree Hygiene page, which explains my responsibilities.
• I read and followed the relevant style guides and ran the auto-formatter.
• I signed the CLA.
• The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
• I linked to at least one issue that this PR fixes in the description above.
• I followed the version and CHANGELOG instructions, using semantic versioning and the repository CHANGELOG style, or I have commented below to indicate which documented exception this PR falls under¹.
• I updated/added any relevant documentation (doc comments with ///).
• I added new tests to check the change I am making, or I have commented below to indicate which test exemption this PR falls under¹.
• All existing and new tests are passing.

Footnotes

1. Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩²

[gemini-code-assist]

Code Review

This pull request adds an includeRouteSemantics option (defaulting to true) to CupertinoPageRoute, CupertinoPage, MaterialPageRoute, and MaterialPage, allowing them to opt out of introducing a semantics route scope. The review feedback suggests making the underlying _includeRouteSemantics getter public on both CupertinoRouteTransitionMixin and MaterialRouteTransitionMixin. This change would allow custom routes to override the property, simplify the overrides in the route and page classes, and enable reusing the documentation template via macros.

[chunhtai]

LGTM

[stuartmorgan-g]

Thank you for your contribution! Because of the volume of PRs we receive, we require that new contributors use our checklist to guide them through critical steps in creating a Flutter PR. Please edit the PR description to add the checklist, then ensure that you have completed all of the steps.