DEV/flutter_flutter
1
0
Fork 0
mirror of https://github.com/flutter/flutter.git synced 2026-02-20 02:29:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add key to BottomNavigationBarItem (#139617)

Browse Source 
Pass key into _BottomNavigationTile

Adding a optional key parameter to BottomNavigationBarItem to be passed through to _BottomNavigationTile.
This will allow easier testing in some scenarios, and fix the splash appearing on the wrong tile.

https://github.com/flutter/flutter/issues/139615
https://github.com/flutter/flutter/issues/34833
This commit is contained in:
Jack Gibbons 2024-01-04 04:58:21 +13:00 committed by GitHub
parent 70386a613b
commit f4cb3d215d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/flutter/lib/src/material/bottom_navigation_bar.dart
View File

@ -449,6 +449,7 @@ class _BottomNavigationTile extends StatelessWidget {
this.item,
this.animation,
this.iconSize, {
super.key,
this.onTap,
this.labelColorTween,
this.iconColorTween,
@ -1101,6 +1102,7 @@ class _BottomNavigationBarState extends State<BottomNavigationBar> with TickerPr
widget.items[i],
_animations[i],
widget.iconSize,
key: widget.items[i].key,
selectedIconTheme: widget.useLegacyColorScheme ? widget.selectedIconTheme ?? bottomTheme.selectedIconTheme : effectiveSelectedIconTheme,
unselectedIconTheme: widget.useLegacyColorScheme ? widget.unselectedIconTheme ?? bottomTheme.unselectedIconTheme : effectiveUnselectedIconTheme,
selectedLabelStyle: effectiveSelectedLabelStyle,

9
packages/flutter/lib/src/widgets/bottom_navigation_bar_item.dart
View File

@ -23,6 +23,7 @@ class BottomNavigationBarItem {
///
/// The argument [icon] should not be null and the argument [label] should not be null when used in a Material Design's [BottomNavigationBar].
const BottomNavigationBarItem({
this.key,
required this.icon,
this.label,
Widget? activeIcon,
@ -30,6 +31,14 @@ class BottomNavigationBarItem {
this.tooltip,
}) : activeIcon = activeIcon ?? icon;
/// A key to be passed through to the resultant widget.
///
/// This allows the identification of different [BottomNavigationBarItem]s through their keys.
///
/// When changing the number of bar items in response to a bar item being tapped, giving
/// each item a key will allow the inkwell / splash animation to be correctly positioned.
final Key? key;
/// The icon of the item.
///
/// Typically the icon is an [Icon] or an [ImageIcon] widget. If another type

28
packages/flutter/test/material/bottom_navigation_bar_test.dart
View File

@ -3174,6 +3174,34 @@ void main() {
addTearDown(tester.view.resetPhysicalSize);
});
testWidgets('BottomNavigationBar keys passed through', (WidgetTester tester) async {
const Key key1 = Key('key1');
const Key key2 = Key('key2');
await tester.pumpWidget(
boilerplate(
textDirection: TextDirection.ltr,
bottomNavigationBar: BottomNavigationBar(
items: const <BottomNavigationBarItem>[
BottomNavigationBarItem(
key: key1,
icon: Icon(Icons.favorite_border),
label: 'Favorite',
),
BottomNavigationBarItem(
key: key2,
icon: Icon(Icons.access_alarm),
label: 'Alarm',
),
],
),
),
);
expect(find.byKey(key1), findsOneWidget);
expect(find.byKey(key2), findsOneWidget);
});
}
Widget boilerplate({ Widget? bottomNavigationBar, required TextDirection textDirection, bool? useMaterial3 }) {