Skip to content

[material_ui] Migrate Switch API doc snippets to {@example} (batch 8) - #13052

Merged
auto-submit[bot] merged 5 commits into
flutter:mainfrom
dkwingsmt:snippet_material_switch
Oct 2, 2026
Merged

auto-submit[bot] merged 5 commits into
flutter:mainfrom
dkwingsmt:snippet_material_switch

Conversation

@dkwingsmt

@dkwingsmt dkwingsmt commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

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

Non-trivial changes:

  • For switch.snippet.0, the original version incorrectly used thumbColor and this has been corrected by this PR (the snippet.1.dart now shows trackColor customization).

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 28, 2026
@github-actions github-actions Bot added p: material_ui triage-design Should be looked at in design triage labels Sep 28, 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 extracts inline code examples from the Switch documentation in packages/material_ui/lib/src/switch.dart into separate snippet files under packages/material_ui/example/lib/switch/ and introduces corresponding widget tests. Feedback on the snippets suggests removing redundant private getters (_nullableOnChanged and _value) to improve the readability of the generated API documentation.

Comment thread packages/material_ui/example/lib/switch/switch.snippet.0.dart
Comment thread packages/material_ui/example/lib/switch/switch.snippet.1.dart
Comment thread packages/material_ui/example/lib/switch/switch.snippet.2.dart
Comment thread packages/material_ui/example/lib/switch/switch.snippet.3.dart
Comment thread packages/material_ui/example/lib/switch/switch.snippet.4.dart
@dkwingsmt

Copy link
Copy Markdown
Contributor Author

The pattern questioned by gemini code assist is also used in cupertino_checkbox.snippet.0.dart. If we want to change it we should change that file as well. I'm ok with either.

@elliette elliette left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you, Tong! LGTM

@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 Oct 1, 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. Thank you!

/// Switch(
/// value: true,
/// onChanged: (bool value) { },
/// thumbColor: WidgetStateProperty.resolveWith<Color>((Set<WidgetState> states) {

@QuncCccccc QuncCccccc Oct 2, 2026 •

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: This example incorrectly used thumbColor and this has been corrected by this PR (the snippet.1.dart now shows trackColor customization). Maybe consider mentioning this fix in PR description so in the future people and agents can better understand what each PR does:)!

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.

Done. Thanks!

@dkwingsmt dkwingsmt added the autosubmit Merge PR when tree becomes green via auto submit App label Oct 2, 2026
@auto-submit
auto-submit Bot merged commit aa3575f into flutter:main Oct 2, 2026
13 checks passed
ZhuJHua pushed a commit to ZhuJHua/flutter that referenced this pull request Oct 6, 2026
…er#193840)

flutter/packages@5620e65...951f2f7

2026-10-05 [email protected] [material_ui] Add scrollPadding
property to DropdownMenuFormField (flutter/packages#12735)
2026-10-02 [email protected] [material_ui]
Migrate M3 Motion template to use new gen_defaults
(flutter/packages#13058)
2026-10-02 [email protected]
[cupertino_ui] Forward showDragHandle from showCupertinoSheet to
CupertinoSheetRoute (flutter/packages#13011)
2026-10-02 [email protected] [cupertino_ui]
Fix CupertinoMagnifier focal point with custom size
(flutter/packages#13029)
2026-10-02 [email protected] [ci] Add material_ui and cupertino_ui
to customer testing (flutter/packages#13114)
2026-10-02 [email protected] [material_ui]
Add Material 3 Expressive migration skill (flutter/packages#12818)
2026-10-02 [email protected] [video_player] Ignore late position
updates after disposal (flutter/packages#12971)
2026-10-02 [email protected] [material_ui]
Remove unconditional dart:io import from about.dart
(flutter/packages#12774)
2026-10-02 [email protected] [material_ui] Fix
DropdownButtonFormField underline alignment at bottom
(flutter/packages#12606)
2026-10-02 [email protected] Roll Flutter from
e89fd0a to d03768e (23 revisions) (flutter/packages#13111)
2026-10-02 [email protected] [material_ui] Migrate
`Switch` API doc snippets to {@example} (batch 8)
(flutter/packages#13052)
2026-10-02 [email protected]
[url_launcher] Fix supportsCloseForLaunchMode to query close support
(flutter/packages#12926)
2026-10-02 [email protected] Redistribute
iOS/macOS Suggested Reviewers (flutter/packages#13076)
2026-10-02 [email protected] [image_picker] Subsample large images
when resizing on Android (flutter/packages#13038)
2026-10-02 [email protected] [cupertino_ui] Remove
redundant null arguments in Completer.complete (flutter/packages#13008)
2026-10-02 [email protected] [repo]
Update AGENTS.md with dependency allowance and versioning guidance
(flutter/packages#12579)

If this roll has caused a breakage, revert this CL and set the roller
to dry run mode using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC [email protected] on the revert to ensure that a
human
is aware of the problem.

To file a bug in Flutter:
https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App 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