Skip to content

[material_ui] Migrate MaterialApp API doc snippets to {@example} and add unit tests (batch 6) - #13021

Open
dkwingsmt wants to merge 5 commits into
flutter:mainfrom
dkwingsmt:snippet_material_app
Open

dkwingsmt wants to merge 5 commits into
flutter:mainfrom
dkwingsmt:snippet_material_app

Conversation

@dkwingsmt

@dkwingsmt dkwingsmt commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

This PR addresses batch 6 of the migration detailed in flutter/flutter#188530 (comment).

app.snippet.4.dart‎ contains some non-trivial changes to fix a type error and to make it testable.

Pre-Review Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

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. ↩ ↩2

@flutter-dashboard flutter-dashboard Bot added the CICD Run CI/CD label Sep 25, 2026
@github-actions github-actions Bot added p: material_ui triage-design Should be looked at in design triage labels Sep 25, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request refactors the documentation for MaterialApp by replacing inline code snippets with external example files and adds the corresponding example and test files. Feedback was provided to improve test robustness by using more stable widget finders instead of relying on specific text content.

Comment on lines +18 to +19
final BuildContext context = tester.element(find.text('Home Route'));
Navigator.of(context).pushNamed('/about');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using tester.element(find.text('Home Route')) to obtain a BuildContext for navigation makes the test fragile, as it relies on the specific text content of the UI. A more robust and idiomatic approach in Flutter widget tests is to access the NavigatorState directly using tester.state.

Suggested change
final BuildContext context = tester.element(find.text('Home Route'));
Navigator.of(context).pushNamed('/about');
tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/about');

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this isn't significant.

Comment on lines +17 to +18
final BuildContext context = tester.element(find.text('MaterialApp Theme'));
final ThemeData theme = Theme.of(context);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Obtaining the BuildContext from a specific text widget makes the test fragile if the text content changes. It is more robust to obtain the context from a structural widget like Scaffold.

Suggested change
final BuildContext context = tester.element(find.text('MaterialApp Theme'));
final ThemeData theme = Theme.of(context);
final BuildContext context = tester.element(find.byType(Scaffold));
final ThemeData theme = Theme.of(context);

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this isn't significant.

@dkwingsmt dkwingsmt added override: no versioning needed Override the check requiring version bumps for most changes override: no changelog needed Override the check requiring CHANGELOG updates for most changes labels Sep 25, 2026

@QuncCccccc QuncCccccc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!


await tester.sendKeyEvent(LogicalKeyboardKey.select);
expect(invoked, isTrue);
});

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: maybe we can test this against iOS like

Suggested change
});
}, variant: TargetPlatformVariant.only(TargetPlatform.iOS));

This test still passes if the snippet's one extra shortcut, const SingleActivator(LogicalKeyboardKey.select): const ActivateIntent(), is removed because the same entry is already in WidgetsApp.defaultShortcuts on Android

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really good point! I've changed the activating key from Select to keyE, which should be more useful as an example than having the platform set to iOS.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CICD Run CI/CD override: no changelog needed Override the check requiring CHANGELOG updates for most changes override: no versioning needed Override the check requiring version bumps for most changes p: material_ui triage-design Should be looked at in design triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants