Skip to content

[material_ui, cupertino_ui] Migrate snippet TODOs to <callout-box> #12146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
auto-submit merged 4 commits into from
Jul 11, 2026
Merged

[material_ui, cupertino_ui] Migrate snippet TODOs to <callout-box> #12146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
facdc46
Impl
dkwingsmt Jul 8, 2026
40db949
Disable lint rule
dkwingsmt Jul 8, 2026
5393caf
Empty lines
dkwingsmt Jul 8, 2026
6a49964
Merge remote-tracking branch 'origin/main' into migrate-snippet
dkwingsmt Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/cupertino_ui/analysis_options.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,8 @@ analyzer:
- windows/**
- macos/**
- linux/**

linter:
rules:
# TODO(dkwingsmt): Remove when https://github.com/dart-lang/sdk/issues/63777 is fixed.
unintended_html_in_doc_comment: false
Comment on lines +19 to +20

@justinmc justinmc Jul 10, 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.

I guess this is better than doing this everywhere:

/// <callout-box> // ignore: unintended_html_in_doc_comment

30 changes: 15 additions & 15 deletions packages/cupertino_ui/lib/src/app.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ import 'theme.dart';
/// * The San Francisco font family is unavailable on Android and can result
/// in undefined font behavior.
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand All @@ -89,10 +89,10 @@ import 'theme.dart';
/// )
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
/// <callout-box>
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand Down Expand Up @@ -122,10 +122,10 @@ import 'theme.dart';
/// )
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
/// <callout-box>
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand All @@ -149,7 +149,7 @@ import 'theme.dart';
/// )
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
/// See also:
///
Expand Down Expand Up @@ -372,8 +372,8 @@ class CupertinoApp extends StatefulWidget {
final bool debugShowCheckedModeBanner;

/// {@macro flutter.widgets.widgetsApp.shortcuts}
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand All @@ -400,13 +400,13 @@ class CupertinoApp extends StatefulWidget {
/// }
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
/// {@macro flutter.widgets.widgetsApp.shortcuts.seeAlso}
final Map<ShortcutActivator, Intent>? shortcuts;

/// {@macro flutter.widgets.widgetsApp.actions}
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand Down Expand Up @@ -438,7 +438,7 @@ class CupertinoApp extends StatefulWidget {
/// }
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
/// {@macro flutter.widgets.widgetsApp.actions.seeAlso}
final Map<Type, Action<Intent>>? actions;

Expand Down
6 changes: 3 additions & 3 deletions packages/cupertino_ui/lib/src/checkbox.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,8 +205,8 @@ class CupertinoCheckbox extends StatefulWidget {
/// * [WidgetState.focused].
/// * [WidgetState.disabled].
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand All @@ -227,7 +227,7 @@ class CupertinoCheckbox extends StatefulWidget {
/// )
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
/// {@endtemplate}
///
/// If [fillColor] resolves to null for the requested state, then the fill color
Expand Down
18 changes: 9 additions & 9 deletions packages/cupertino_ui/lib/src/colors.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -661,8 +661,8 @@ abstract final class CupertinoColors {
/// [CupertinoDynamicColor.resolve] against its own [BuildContext], on a best-effort
/// basis.
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand All @@ -682,7 +682,7 @@ abstract final class CupertinoColors {
/// )
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
/// ### Using a [CupertinoDynamicColor] from a [CupertinoTheme]
///
Expand All @@ -691,8 +691,8 @@ abstract final class CupertinoColors {
/// implicitly resolves all the colors used in the retrieved [CupertinoThemeData],
/// before returning it.
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand All @@ -711,7 +711,7 @@ abstract final class CupertinoColors {
/// )
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
/// ### Manually Resolving a [CupertinoDynamicColor]
///
Expand All @@ -722,8 +722,8 @@ abstract final class CupertinoColors {
/// the colors used in the [Border] have to be resolved manually before being passed
/// to [CupertinoNavigationBar]'s constructor.
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand All @@ -750,7 +750,7 @@ abstract final class CupertinoColors {
/// )
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
/// See also:
///
Expand Down
14 changes: 6 additions & 8 deletions packages/cupertino_ui/lib/src/context_menu.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,8 @@ class CupertinoContextMenu extends StatefulWidget {
/// Exposes the default border radius for matching iOS 16.0 behavior. This
/// value was eyeballed from the iOS simulator running iOS 16.0.
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand Down Expand Up @@ -215,8 +215,7 @@ class CupertinoContextMenu extends StatefulWidget {
/// )
/// ```
///
///
// TODO(framework): End of the blue example container.
/// </callout-box>
static const double kOpenBorderRadius = _previewBorderRadiusRatio;

/// Exposes the final box shadow of the opening animation of the child widget
Expand Down Expand Up @@ -259,8 +258,8 @@ class CupertinoContextMenu extends StatefulWidget {
/// the widget from 0 to [animationOpensAt], and the second stage for when the
/// widget fully opens up to the menu, from [animationOpensAt] to 1.
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand Down Expand Up @@ -329,8 +328,7 @@ class CupertinoContextMenu extends StatefulWidget {
/// )
/// ```
///
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
// TODO(framework): Replace the following block with a @dartpad directive
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4123
Expand Down
12 changes: 6 additions & 6 deletions packages/cupertino_ui/lib/src/date_picker.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,8 +483,8 @@ class CupertinoDatePicker extends StatefulWidget {
///
/// If the selection overlay builder returns null, no overlay will be drawn.
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand Down Expand Up @@ -519,7 +519,7 @@ class CupertinoDatePicker extends StatefulWidget {
/// )
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
final SelectionOverlayBuilder? selectionOverlayBuilder;

/// The behavior of reporting the selected date.
Expand Down Expand Up @@ -2267,8 +2267,8 @@ class CupertinoTimerPicker extends StatefulWidget {
///
/// If the selection overlay builder returns null, no overlay will be drawn.
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand Down Expand Up @@ -2301,7 +2301,7 @@ class CupertinoTimerPicker extends StatefulWidget {
/// )
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
final SelectionOverlayBuilder? selectionOverlayBuilder;

/// The behavior of reporting the selected duration.
Expand Down
6 changes: 3 additions & 3 deletions packages/cupertino_ui/lib/src/icons.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import 'package:flutter/widgets.dart';
/// cupertino_icons: ^1.0.0
/// ```
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand Down Expand Up @@ -57,7 +57,7 @@ import 'package:flutter/widgets.dart';
/// )
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
/// For versions 0.1.3 and below, see this [glyph map](https://raw.githubusercontent.com/flutter/packages/main/third_party/packages/cupertino_icons/map.png).
///
Expand Down
12 changes: 6 additions & 6 deletions packages/cupertino_ui/lib/src/magnifier.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ import 'theme.dart';
/// A [CupertinoMagnifier] used for magnifying text in cases where a user's
/// finger may be blocking the point of interest, like a selection handle.
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
/// This sample demonstrates how to use [CupertinoTextMagnifier].
///
/// {@example example/lib/magnifier/cupertino_text_magnifier.0.dart}
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
/// Delegates styling to [CupertinoMagnifier] with its position depending on
/// [magnifierInfo].
Expand Down Expand Up @@ -226,16 +226,16 @@ class _CupertinoTextMagnifierState extends State<CupertinoTextMagnifier>
/// A [RawMagnifier] used for magnifying text in cases where a user's
/// finger may be blocking the point of interest, like a selection handle.
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
/// This sample demonstrates how to use [CupertinoMagnifier].
///
/// {@example example/lib/magnifier/cupertino_magnifier.0.dart}
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
/// [CupertinoMagnifier] is a wrapper around [RawMagnifier] that handles styling
/// and transitions.
Expand Down
10 changes: 4 additions & 6 deletions packages/cupertino_ui/lib/src/menu_anchor.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,15 +295,14 @@ typedef CupertinoMenuAnimationStatusChangedCallback = void Function(AnimationSta
/// invoked every time the [AnimationStatus] of the menu animation changes.
///
/// ## Usage
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
/// This example demonstrates a simple [CupertinoMenuAnchor] that wraps
/// a button.
///
/// {@example /example/lib/menu_anchor/menu_anchor.0.dart}
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
// TODO(framework): Replace the following block with a @dartpad directive
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4123
Expand Down Expand Up @@ -1701,15 +1700,14 @@ class _CupertinoDividerPainter extends CustomPainter {
/// will perform a destructive action, and will color the text of the menu item
/// [CupertinoColors.systemRed].
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
/// This example demonstrates a simple [CupertinoMenuAnchor] that wraps
/// a button.
///
/// {@example /example/lib/menu_anchor/menu_anchor.0.dart}
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
// TODO(framework): Replace the following block with a @dartpad directive
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4123
Expand Down
12 changes: 6 additions & 6 deletions packages/cupertino_ui/lib/src/slider.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,8 @@ class CupertinoSlider extends StatefulWidget {
/// The value passed will be the last [value] that the slider had before the
/// change began.
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand All @@ -163,7 +163,7 @@ class CupertinoSlider extends StatefulWidget {
/// )
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
/// See also:
///
Expand All @@ -177,8 +177,8 @@ class CupertinoSlider extends StatefulWidget {
/// [onChanged] for that), but rather to know when the user has completed
/// selecting a new [value] by ending a drag.
///
// TODO(framework): Replace the following block with a blue example container
// when it's supported. https://github.com/dart-lang/dartdoc/issues/4243
/// <callout-box>
///
// TODO(framework): Add unit tests to this code snippet.
// https://github.com/flutter/flutter/issues/188530
///
Expand All @@ -200,7 +200,7 @@ class CupertinoSlider extends StatefulWidget {
/// )
/// ```
///
// TODO(framework): End of the blue example container.
/// </callout-box>
///
/// See also:
///
Expand Down
Loading
Loading