feat: Add `maxCount` parameter to `Badge.count` constructor. #171054

iamtoricool · 2025-06-24T03:14:50Z

feat: Add maxCount parameter to Badge.count constructor

This enhancement provides the ability to specify a dynamic maximum limit for the badge count, offering greater flexibility and eliminating the reliance on hardcoded values within the widget. This allows developers to, for example, display "99+" instead of "100" or "9+" instead of "10", improving UI consistency and preventing overly large numbers on badges.

Description of Changes

This PR introduces a new optional parameter, maxCount, to the Badge.count constructor. This provides a flexible way to define a numerical upper bound for the badge display.

Key aspects of this change:

Dynamic Limits: Developers can now set custom maximum values (e.g., 9, 99, 999) that, when exceeded, will display the maxCount value followed by a + symbol (e.g., "9+", "99+").
Improved UI/UX: Prevents large, potentially overflowing numbers from appearing on badges, maintaining visual integrity and a cleaner user interface.
Reduced Hardcoding: Centralizes the logic for maximum badge values within the Badge widget itself, reducing the need for manual checks and conditional rendering outside the widget.
Comprehensive Documentation: Includes updated API documentation for the maxCount parameter, clarifying its usage, behavior, and the visual outcome when the maximum is reached.

This change aligns with Flutter's principles of providing highly customizable and intuitive widgets.

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported. (Assuming no breaking changes)
All existing and new tests are passing.

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

- This allows for dynamic maximum limits on badge counts, removing the need for hardcoded values.

- Adds comprehensive API documentation for the newly introduced `maxCount` parameter.

flutter-dashboard · 2025-06-24T03:14:53Z

It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

QuncCccccc

Thank you for your contribution! Could you help add some unit tests to verify the code change?

Adds an example demonstrating the `maxCount` property of the `Badge` widget. The example showcases how the badge displays a maximum count with an overflow indicator when the actual count exceeds the specified maximum.

iamtoricool · 2025-06-30T15:00:26Z

Thank you for your contribution! Could you help add some unit tests to verify the code change?

Hey, thanks for the feedback! I’ve added a BadgeMaxCountExampleApp demo and a widget test that covers:

Overflow case (1000 with maxCount: 99 shows “99+”)
Within‑range counts
Default maxCount (values over 999 render as “999+”)

You’ll find them in examples/api/lib/material/badge/badge.1.dart and examples/api/test/material/badge/badge.1_test.dart. Let me know if you’d like any changes! 😊

QuncCccccc · 2025-07-02T00:07:14Z

I’ve added a BadgeMaxCountExampleApp demo and a widget test that covers

Thanks a lot for adding them! I actually think it's not necessary to add an example just for the new parameter. What I mean in my last comment is to add unit tests in packages/flutter/test/material/badge_test.dart, sorry if it's misleading:) Please let me know if any help is needed on the unit tests!

QuncCccccc · 2025-07-01T23:59:40Z

packages/flutter/lib/src/material/badge.dart


  /// Convenience constructor for creating a badge with a numeric
-  /// label with 1-3 digits based on [count].
+  /// label with 1-[maxCount] digits based on [count].


This change seems not accurate. maxCount means the max number showing up on badge instead of digits, right?

Thank you for the feedback! You’re right — maxCount limits the maximum number shown on the badge, not the number of digits. I’ll update the doc comment to clarify this. Please let me know if you have suggestions for the wording!

packages/flutter/lib/src/material/badge.dart

The `Badge.count` constructor now accurately displays the badge label based on the `count` and `maxCount` properties. - When `count` is less than or equal to `maxCount`, the badge displays the `count` value. - When `count` exceeds `maxCount`, the badge displays '[maxCount]+'. This commit also includes a new test case to verify the correct behavior of `Badge.count` with `maxCount`. The example demonstrating the `maxCount` property of the `Badge` widget has been removed.

pranavo72bex · 2025-07-07T03:09:53Z

packages/flutter/lib/src/material/badge.dart

    this.isLabelVisible = true,
    this.child,
-  }) : label = Text(count > 999 ? '999+' : '$count');
+  }) : label = Text(count > maxCount ? '$maxCount+' : '$count');


Move Label Creation to a Getter or Method
Right now, label assignment is inline in the initializer list. Moving this to a small private method improves readability:

class Badge extends StatelessWidget { final int maxCount; late final Widget label; // ✅ Make it late so we can assign it in the constructor

}) : maxCount = displayMaxCount { label = _buildLabel(count, maxCount); // ✅ assign here using the method }

Text _buildLabel(int count, int maxCount) { return Text(count > maxCount ? '$maxCount+' : '$count'); }

I am not sure this is necessary, but thanks for the feedback!

Just to improve code readability 😅

pranavo72bex · 2025-07-07T03:11:53Z

packages/flutter/test/material/badge_test.dart

+      );
+    }
+
+    await tester.pumpWidget(buildFrame(5, 99));


Add Edge Case Test for Negative Count
Even though it’s unlikely to happen in production, explicitly asserting that negative count values throw an AssertionError or are clamped would increase robustness.

+1, that is a good case to cover!

QuncCccccc

LGTM! Thank you for your contribution!

Piinks · 2025-07-16T15:50:05Z

packages/flutter/lib/src/material/badge.dart

    this.isLabelVisible = true,
    this.child,
-  }) : label = Text(count > 999 ? '999+' : '$count');
+  }) : label = Text(count > maxCount ? '$maxCount+' : '$count');


Adding the assertion here that we're non-negative is probably the right spot.

Adding the assertion here that we're non-negative is probably the right spot.

Awesome, thanks for the confirmation! I've added the assert(count >= 0, ...) and assert(maxCount > 0, ...) checks in the constructor, and expanded our unit tests to include negative, zero, and invalid maxCount cases. The updated code and tests are pushed—please let me know if anything else needs tweaking! 😊

This commit adds assertions to `Badge.count` to ensure that the `count` is non-negative and `maxCount` is positive. It also ensures that "0" is displayed when the count is zero.

victorsanni

LGTM. Thanks for the PR.

flutter/flutter#171054)

flutter/flutter@9c626d9...440713c 2025-07-18 stuartmorgan@google.com Add OS version support section to plugin docs (flutter/flutter#172316) 2025-07-18 engine-flutter-autoroll@skia.org Roll Dart SDK from 7fcc5f48c335 to fe2232bd5b9f (2 revisions) (flutter/flutter#172339) 2025-07-18 robert.ancell@canonical.com Refactor handling of frame waiting. (flutter/flutter#172277) 2025-07-18 137456488+flutter-pub-roller-bot@users.noreply.github.com Roll pub packages (flutter/flutter#172332) 2025-07-17 matanlurey@users.noreply.github.com Refactor and forbid `base/exit.dart` outside of `lib/runner.dart` (flutter/flutter#171923) 2025-07-17 matanlurey@users.noreply.github.com Use UTC timezone for `stamp_command_test` to avoid local TZ flakes (flutter/flutter#172319) 2025-07-17 1961493+harryterkelsen@users.noreply.github.com [web] Add tests for unified platform view embedding behavior (flutter/flutter#172313) 2025-07-17 jmccandless@google.com Platform views shouldn't receive pointer events when not laid out (flutter/flutter#172043) 2025-07-17 ahmedsameha1@gmail.com Fix Size.isEmpty description (flutter/flutter#172021) 2025-07-17 iamtoricool@gmail.com feat: Add `maxCount` parameter to `Badge.count` constructor. (flutter/flutter#171054) 2025-07-17 31859944+LongCatIsLooong@users.noreply.github.com add `debugPaintTextLayoutBoxes` for debugging text layout (flutter/flutter#168876) 2025-07-17 engine-flutter-autoroll@skia.org Roll Packages from 4a231ae to cb8fef6 (31 revisions) (flutter/flutter#172303) 2025-07-17 jmccandless@google.com Fix mutating Paint bug (flutter/flutter#171180) 2025-07-17 jmccandless@google.com No SystemContextMenu when readOnly is true (flutter/flutter#171242) 2025-07-17 muhammad.mohiuddin@live.com Add a getter to get the recorder used by painting context (flutter/flutter#170223) 2025-07-17 jason-simmons@users.noreply.github.com [Impeller] Add missing SetPipeline call for the vertices uber pipeline in AtlasContents (flutter/flutter#172273) 2025-07-17 engine-flutter-autoroll@skia.org Roll Dart SDK from 486f9c0663bc to 7fcc5f48c335 (1 revision) (flutter/flutter#172279) 2025-07-17 engine-flutter-autoroll@skia.org Roll Skia from 3673a1f26a63 to 9587301e33bc (3 revisions) (flutter/flutter#172281) 2025-07-17 jason-simmons@users.noreply.github.com Fix a race in FlutterEngineTest.CanLogToStdout (flutter/flutter#172025) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC bmparr@google.com,stuartmorgan@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: 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

…#171054) feat: Add `maxCount` parameter to `Badge.count` constructor This enhancement provides the ability to specify a **dynamic maximum limit** for the badge count, offering greater flexibility and eliminating the reliance on hardcoded values within the widget. This allows developers to, for example, display "99+" instead of "100" or "9+" instead of "10", improving UI consistency and preventing overly large numbers on badges. --- ## Description of Changes This PR introduces a new optional parameter, `maxCount`, to the `Badge.count` constructor. This provides a flexible way to define a numerical upper bound for the badge display. Key aspects of this change: * **Dynamic Limits:** Developers can now set custom maximum values (e.g., 9, 99, 999) that, when exceeded, will display the `maxCount` value followed by a `+` symbol (e.g., "9+", "99+"). * **Improved UI/UX:** Prevents large, potentially overflowing numbers from appearing on badges, maintaining visual integrity and a cleaner user interface. * **Reduced Hardcoding:** Centralizes the logic for maximum badge values within the `Badge` widget itself, reducing the need for manual checks and conditional rendering outside the widget. * **Comprehensive Documentation:** Includes updated API documentation for the `maxCount` parameter, clarifying its usage, behavior, and the visual outcome when the maximum is reached. This change aligns with Flutter's principles of providing highly customizable and intuitive widgets. --- ## Pre-launch Checklist - [X] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [X] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [X] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [X] I signed the [CLA]. - [X] I listed at least one issue that this PR fixes in the description above. - [X] I updated/added relevant documentation (doc comments with `///`). - [X] I added new tests to check the change I am making, or this PR is [test-exempt]. - [X] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. (Assuming no breaking changes) - [X] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

…r#9646) flutter/flutter@9c626d9...440713c 2025-07-18 stuartmorgan@google.com Add OS version support section to plugin docs (flutter/flutter#172316) 2025-07-18 engine-flutter-autoroll@skia.org Roll Dart SDK from 7fcc5f48c335 to fe2232bd5b9f (2 revisions) (flutter/flutter#172339) 2025-07-18 robert.ancell@canonical.com Refactor handling of frame waiting. (flutter/flutter#172277) 2025-07-18 137456488+flutter-pub-roller-bot@users.noreply.github.com Roll pub packages (flutter/flutter#172332) 2025-07-17 matanlurey@users.noreply.github.com Refactor and forbid `base/exit.dart` outside of `lib/runner.dart` (flutter/flutter#171923) 2025-07-17 matanlurey@users.noreply.github.com Use UTC timezone for `stamp_command_test` to avoid local TZ flakes (flutter/flutter#172319) 2025-07-17 1961493+harryterkelsen@users.noreply.github.com [web] Add tests for unified platform view embedding behavior (flutter/flutter#172313) 2025-07-17 jmccandless@google.com Platform views shouldn't receive pointer events when not laid out (flutter/flutter#172043) 2025-07-17 ahmedsameha1@gmail.com Fix Size.isEmpty description (flutter/flutter#172021) 2025-07-17 iamtoricool@gmail.com feat: Add `maxCount` parameter to `Badge.count` constructor. (flutter/flutter#171054) 2025-07-17 31859944+LongCatIsLooong@users.noreply.github.com add `debugPaintTextLayoutBoxes` for debugging text layout (flutter/flutter#168876) 2025-07-17 engine-flutter-autoroll@skia.org Roll Packages from 4a231ae to cb8fef6 (31 revisions) (flutter/flutter#172303) 2025-07-17 jmccandless@google.com Fix mutating Paint bug (flutter/flutter#171180) 2025-07-17 jmccandless@google.com No SystemContextMenu when readOnly is true (flutter/flutter#171242) 2025-07-17 muhammad.mohiuddin@live.com Add a getter to get the recorder used by painting context (flutter/flutter#170223) 2025-07-17 jason-simmons@users.noreply.github.com [Impeller] Add missing SetPipeline call for the vertices uber pipeline in AtlasContents (flutter/flutter#172273) 2025-07-17 engine-flutter-autoroll@skia.org Roll Dart SDK from 486f9c0663bc to 7fcc5f48c335 (1 revision) (flutter/flutter#172279) 2025-07-17 engine-flutter-autoroll@skia.org Roll Skia from 3673a1f26a63 to 9587301e33bc (3 revisions) (flutter/flutter#172281) 2025-07-17 jason-simmons@users.noreply.github.com Fix a race in FlutterEngineTest.CanLogToStdout (flutter/flutter#172025) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC bmparr@google.com,stuartmorgan@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: 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

…#171054) feat: Add `maxCount` parameter to `Badge.count` constructor This enhancement provides the ability to specify a **dynamic maximum limit** for the badge count, offering greater flexibility and eliminating the reliance on hardcoded values within the widget. This allows developers to, for example, display "99+" instead of "100" or "9+" instead of "10", improving UI consistency and preventing overly large numbers on badges. --- ## Description of Changes This PR introduces a new optional parameter, `maxCount`, to the `Badge.count` constructor. This provides a flexible way to define a numerical upper bound for the badge display. Key aspects of this change: * **Dynamic Limits:** Developers can now set custom maximum values (e.g., 9, 99, 999) that, when exceeded, will display the `maxCount` value followed by a `+` symbol (e.g., "9+", "99+"). * **Improved UI/UX:** Prevents large, potentially overflowing numbers from appearing on badges, maintaining visual integrity and a cleaner user interface. * **Reduced Hardcoding:** Centralizes the logic for maximum badge values within the `Badge` widget itself, reducing the need for manual checks and conditional rendering outside the widget. * **Comprehensive Documentation:** Includes updated API documentation for the `maxCount` parameter, clarifying its usage, behavior, and the visual outcome when the maximum is reached. This change aligns with Flutter's principles of providing highly customizable and intuitive widgets. --- ## Pre-launch Checklist - [X] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [X] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [X] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [X] I signed the [CLA]. - [X] I listed at least one issue that this PR fixes in the description above. - [X] I updated/added relevant documentation (doc comments with `///`). - [X] I added new tests to check the change I am making, or this PR is [test-exempt]. - [X] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. (Assuming no breaking changes) - [X] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

flutter/flutter#171054)

iamtoricool added 2 commits June 24, 2025 08:43

feat: Add maxCount parameter to Badge.count constructor.

06a3226

- This allows for dynamic maximum limits on badge counts, removing the need for hardcoded values.

docs: Update Badge.count documentation for maxCount.

c64987c

- Adds comprehensive API documentation for the newly introduced `maxCount` parameter.

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. labels Jun 24, 2025

Merge branch 'master' into master

93bacf1

dkwingsmt requested a review from QuncCccccc June 25, 2025 18:33

QuncCccccc reviewed Jun 25, 2025

View reviewed changes

iamtoricool added 2 commits June 30, 2025 20:11

Merge branch 'flutter:master' into master

4d958af

Adds Badge maxCount example

a82eb71

Adds an example demonstrating the `maxCount` property of the `Badge` widget. The example showcases how the badge displays a maximum count with an overflow indicator when the actual count exceeds the specified maximum.

github-actions bot added d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos labels Jun 30, 2025

Merge branch 'master' into master

2bba988

iamtoricool requested a review from QuncCccccc June 30, 2025 16:11

QuncCccccc reviewed Jul 2, 2025

View reviewed changes

packages/flutter/lib/src/material/badge.dart Show resolved Hide resolved

github-actions bot removed d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos labels Jul 2, 2025

iamtoricool added 3 commits July 2, 2025 09:36

Merge branch 'master' into master

ee54aa3

Merge branch 'master' into master

e7edee7

Merge branch 'master' into master

a50d67a

pranavo72bex reviewed Jul 7, 2025

View reviewed changes

Merge branch 'master' into master

3451352

dkwingsmt requested a review from QuncCccccc July 10, 2025 23:24

QuncCccccc approved these changes Jul 16, 2025

View reviewed changes

Piinks reviewed Jul 16, 2025

View reviewed changes

iamtoricool added 2 commits July 17, 2025 10:20

Merge branch 'flutter:master' into master

35cfbca

feat(material): add assertions and zero count display to Badge.count

feee3a8

This commit adds assertions to `Badge.count` to ensure that the `count` is non-negative and `maxCount` is positive. It also ensures that "0" is displayed when the count is zero.

victorsanni approved these changes Jul 17, 2025

View reviewed changes

Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 17, 2025

auto-submit bot added this pull request to the merge queue Jul 17, 2025

Merged via the queue into flutter:master with commit d2534e1 Jul 17, 2025
73 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jul 17, 2025

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2025

d2534e118 feat: Add maxCount parameter to Badge.count constructor. (

740adc3

flutter/flutter#171054)

engine-flutter-autoroll mentioned this pull request Jul 18, 2025

Roll Flutter from 9c626d9f9afa to 440713c3b287 (19 revisions) flutter/packages#9646

Merged

Piinks mentioned this pull request Jul 19, 2025

Flutter Notable Commits - 2025 #161460

Open

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 12, 2025

d2534e118 feat: Add maxCount parameter to Badge.count constructor. (

7d9c434

flutter/flutter#171054)

feat: Add maxCount parameter to Badge.count constructor. #171054

feat: Add maxCount parameter to Badge.count constructor. #171054

Conversation

iamtoricool commented Jun 24, 2025

Description of Changes

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented Jun 24, 2025

Uh oh!

QuncCccccc left a comment

Choose a reason for hiding this comment

Uh oh!

iamtoricool commented Jun 30, 2025

Uh oh!

QuncCccccc commented Jul 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

QuncCccccc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

victorsanni left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

feat: Add `maxCount` parameter to `Badge.count` constructor. #171054

feat: Add `maxCount` parameter to `Badge.count` constructor. #171054