Skip to content

Add bottom navigation bar item semantics label#180577

Merged
auto-submit[bot] merged 6 commits intoflutter:masterfrom
Lilian-C:AddBottomNavigationBarItemSemanticsLabel
Jan 23, 2026
Merged

Add bottom navigation bar item semantics label#180577
auto-submit[bot] merged 6 commits intoflutter:masterfrom
Lilian-C:AddBottomNavigationBarItemSemanticsLabel

Conversation

@Lilian-C
Copy link
Copy Markdown
Contributor

@Lilian-C Lilian-C commented Jan 6, 2026

Fix #180621

This PR adds a semanticsLabel for the BottomNavigationBarItem.

While this PR addresses the need for a semanticsLabel, it's worth noting that replacing the current "String label" parameter with a "Widget label" could be a more flexible long-term solution in the BottomNavigationBarItem. This approach would allow full control over the label's content and appearance.

However, this would be a breaking change.

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.
  • All existing and new tests are passing.

@google-cla
Copy link
Copy Markdown

google-cla Bot commented Jan 6, 2026

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@github-actions github-actions Bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. f: cupertino flutter/packages/flutter/cupertino repository labels Jan 6, 2026
@Lilian-C Lilian-C force-pushed the AddBottomNavigationBarItemSemanticsLabel branch 2 times, most recently from d1e2422 to 6c02cdb Compare January 6, 2026 14:13
@Lilian-C Lilian-C marked this pull request as ready for review January 13, 2026 09:33
@dkwingsmt dkwingsmt added the team-accessibility Owned by Framework Accessibility team (i.e. responsible for accessibility code in flutter/flutter) label Jan 14, 2026
@dkwingsmt dkwingsmt requested a review from Piinks January 14, 2026 19:05
Comment on lines +112 to +113
/// it overrides the default semantic label which is typically composed of
/// the [label] and the tab position information.
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.

Suggested change
/// it overrides the default semantic label which is typically composed of
/// the [label] and the tab position information.
/// it overrides the default [label] String when read by accessibility tools.

-ish, feel free to tweak.

I think, and @chunhtai can tell me if I am wrong :), the tab information will still be provided in the default semantics here.
The BottomNav..Item ends up getting wrapped in a Semantics container with the tab index, and then further down the tree from there is where the label text is inserted. The docs should be clear about this in case folks think they need to figure out tab indexing themselves.

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.

Fixed :)


expect(
tester.getSemantics(find.text('A')),
containsSemantics(label: 'Custom A label\nTab 1 of 2'),
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.

Yep, the test actually confirms this, great thanks!

@Piinks
Copy link
Copy Markdown
Contributor

Piinks commented Jan 15, 2026

Can you take a look at the analysis failure?

@Lilian-C Lilian-C force-pushed the AddBottomNavigationBarItemSemanticsLabel branch from 2c24dc0 to 19289e4 Compare January 15, 2026 09:04
@Lilian-C
Copy link
Copy Markdown
Contributor Author

Fixed the analysis failure, it was a lint issue.

Also, I modified the tests to use isSemantics instead of containsSemantics in this commit

@dkwingsmt dkwingsmt requested a review from Piinks January 21, 2026 19:20
Copy link
Copy Markdown
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

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

LGTM thank you!

Copy link
Copy Markdown
Member

@hannah-hyj hannah-hyj left a comment

Choose a reason for hiding this comment

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

LGTM!

@ksokolovskyi ksokolovskyi added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 23, 2026
@auto-submit auto-submit Bot added this pull request to the merge queue Jan 23, 2026
Merged via the queue into flutter:master with commit 0bdd313 Jan 23, 2026
70 of 71 checks passed
@flutter-dashboard flutter-dashboard Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jan 23, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 23, 2026
auto-submit Bot pushed a commit to flutter/packages that referenced this pull request Jan 23, 2026
Roll Flutter from 48c2475 to bfc9041eb118 (173 revisions)

flutter/flutter@48c2475...bfc9041

2026-01-23 matt.kosarek@canonical.com No longer exiting the application when the RegularWindow is destroyed + resolving the window created promise after runWidget (flutter/flutter#181339)
2026-01-23 kazbek.sultanov.doc@gmail.com Remove unnecessary Material import from dialog_test.dart (flutter/flutter#181249)
2026-01-23 engine-flutter-autoroll@skia.org Roll Skia from 8e516fe6828f to db10db8bd55f (1 revision) (flutter/flutter#181379)
2026-01-23 50643541+Mairramer@users.noreply.github.com Reset TextFormField to initial value after state change (flutter/flutter#181199)
2026-01-23 engine-flutter-autoroll@skia.org Roll Dart SDK from 980b2b41d36e to e82d7ad1855e (1 revision) (flutter/flutter#181375)
2026-01-23 engine-flutter-autoroll@skia.org Roll Skia from 3e86f377d300 to 8e516fe6828f (4 revisions) (flutter/flutter#181370)
2026-01-23 kazbek.sultanov.doc@gmail.com Remove unnecessary Material import from sliver_visibility_test (flutter/flutter#181248)
2026-01-23 43635580+Lilian-C@users.noreply.github.com Add bottom navigation bar item semantics label (flutter/flutter#180577)
2026-01-23 58190796+MitchellGoodwin@users.noreply.github.com Make topGap not required for CupertinoSheetTransition (flutter/flutter#181269)
2026-01-23 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from b4cLyhuxciUC-4zCJ... to n7NohL9DPpEuPjNt9... (flutter/flutter#181365)
2026-01-23 engine-flutter-autoroll@skia.org Roll Dart SDK from 806f04638561 to 980b2b41d36e (1 revision) (flutter/flutter#181364)
2026-01-23 34871572+gmackall@users.noreply.github.com Reland hybrid views test (flutter/flutter#181336)
2026-01-23 git@reb0.org Revert DropdownMenu non-nullable breaking change (flutter/flutter#181074)
2026-01-23 dkwingsmt@users.noreply.github.com Fix leaks in `flutter_test` tests (flutter/flutter#180879)
2026-01-23 97480502+b-luk@users.noreply.github.com Re-enable fragment_shader_tests.dart 'Shader Compiler appropriately pads vec3 uniform arrays' test on Vulkan (flutter/flutter#181292)
2026-01-23 bkonyi@google.com [ Tool ] Fix `update-packages` failing due to mismatched dependencies between flutter_tools and the framework (flutter/flutter#181335)
2026-01-23 jason-simmons@users.noreply.github.com [Impeller] Make dynamically created shader metadata for runtime effects consistent with metadata for built-in shaders (flutter/flutter#181201)
2026-01-23 97480502+b-luk@users.noreply.github.com Broaden the applicability of `Color` fix_data rules from flutter/painting.dart (flutter/flutter#181093)
2026-01-23 15619084+vashworth@users.noreply.github.com Fixes macOS App.framework not being codesigned or find framework (flutter/flutter#181348)
2026-01-22 69134234+sutes-work@users.noreply.github.com Roll Fuchsia GN SDK from NAEC5tfgSl8g94nwp... to JLBh4Z9PKsjIJcqDU... (flutter/flutter#181139)
2026-01-22 engine-flutter-autoroll@skia.org Roll Dart SDK from ab4640ea82e9 to 806f04638561 (2 revisions) (flutter/flutter#181347)
2026-01-22 sokolovskyi.konstantin@gmail.com Add ExpansibleController.toggle method. (flutter/flutter#181320)
2026-01-22 42980667+srivats22@users.noreply.github.com Fixes Typo in codebase (flutter/flutter#181256)
2026-01-22 engine-flutter-autoroll@skia.org Roll Skia from 4766615bcc96 to 3e86f377d300 (3 revisions) (flutter/flutter#181346)
2026-01-22 ahmedsameha1@gmail.com Make sure that a Hero doesn't crash in 0x0 environment (flutter/flutter#180954)
2026-01-22 jason-simmons@users.noreply.github.com Reland "Fix capitalization of the path to FlutterWindowControllerTest.mm in the macOS platform build script" (flutter/flutter#181200)
2026-01-22 engine-flutter-autoroll@skia.org Roll Skia from 6e9746be8c4a to 4766615bcc96 (3 revisions) (flutter/flutter#181331)
2026-01-22 kazbek.sultanov.doc@gmail.com Fix remove material import textfield (flutter/flutter#181254)
2026-01-22 15619084+vashworth@users.noreply.github.com Add FlutterFramework as an Xcode SwiftPM local package override (flutter/flutter#179512)
2026-01-22 engine-flutter-autoroll@skia.org Roll Dart SDK from 7bd4c68b625c to ab4640ea82e9 (1 revision) (flutter/flutter#181324)
2026-01-22 engine-flutter-autoroll@skia.org Roll Packages from d80c60e to 9010299 (9 revisions) (flutter/flutter#181323)
2026-01-22 engine-flutter-autoroll@skia.org Roll Dart SDK from 2d53a77adc5d to 7bd4c68b625c (2 revisions) (flutter/flutter#181316)
2026-01-22 engine-flutter-autoroll@skia.org Roll Skia from 3f6949bc5780 to 6e9746be8c4a (2 revisions) (flutter/flutter#181311)
2026-01-22 engine-flutter-autoroll@skia.org Roll Skia from ef6efc358b4a to 3f6949bc5780 (2 revisions) (flutter/flutter#181307)
2026-01-22 engine-flutter-autoroll@skia.org Roll Dart SDK from 5d7c8faf2e41 to 2d53a77adc5d (1 revision) (flutter/flutter#181305)
2026-01-22 120639059+Enderjua@users.noreply.github.com [Material] update hourFormat to use Dart 3 switch expression (flutter/flutter#181041)
2026-01-22 146823759+brahim-guaali@users.noreply.github.com Use null-aware elements in cupertino/nav_bar.dart (flutter/flutter#181237)
2026-01-22 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from b2KIEXVAlEqImQ9VO... to b4cLyhuxciUC-4zCJ... (flutter/flutter#181297)
2026-01-22 137456488+flutter-pub-roller-bot@users.noreply.github.com Roll pub packages (flutter/flutter#181295)
2026-01-22 30870216+gaaclarke@users.noreply.github.com Enables fragment shader test for impeller (fixes mat2 on vulkan) (flutter/flutter#181013)
2026-01-21 engine-flutter-autoroll@skia.org Roll Dart SDK from 366200db1aa1 to 5d7c8faf2e41 (4 revisions) (flutter/flutter#181290)
2026-01-21 engine-flutter-autoroll@skia.org Roll Skia from b5ec89e31f59 to ef6efc358b4a (19 revisions) (flutter/flutter#181289)
2026-01-21 brackenavaron@gmail.com fix description for semantics finders (flutter/flutter#181214)
2026-01-21 ahmedsameha1@gmail.com Make sure that an Icon doesn't crash in 0x0 environment (flutter/flutter#181021)
2026-01-21 ahmedsameha1@gmail.com Make sure that a GridPaper doesn't crash in 0x0 environment (flutter/flutter#180906)
2026-01-21 magder@google.com Bring Linux coverage out of bringup (flutter/flutter#181280)
...
flutter-zl pushed a commit to flutter-zl/flutter that referenced this pull request Feb 10, 2026
Fix [flutter#180621](flutter#180621)

This PR adds a semanticsLabel for the BottomNavigationBarItem.



While this PR addresses the need for a semanticsLabel, it's worth noting
that replacing the current "String label" parameter with a "Widget
label" could be a more flexible long-term solution in the
BottomNavigationBarItem. This approach would allow full control over the
label's content and appearance.

However, this would be a breaking change.

## 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.
- [x] All existing and new tests are passing.

---------

Co-authored-by: Lilian Cadiou <lilian_cadiou@ext.connect-tech.sncf>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

f: cupertino flutter/packages/flutter/cupertino repository f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels. team-accessibility Owned by Framework Accessibility team (i.e. responsible for accessibility code in flutter/flutter)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a semanticsLabel for the BottomNavigationBarItem

6 participants