mirror of
https://github.com/flutter/flutter.git
synced 2026-02-20 02:29:02 +08:00
9d96df2364
WIP Commits separated as follows: - Update lints in analysis_options files - Run `dart fix --apply` - Clean up leftover analysis issues - Run `dart format .` in the right places. Local analysis and testing passes. Checking CI now. Part of https://github.com/flutter/flutter/issues/178827 - Adoption of flutter_lints in examples/api coming in a separate change (cc @loic-sharma) ## 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. 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](https://developers.google.com/gemini-code-assist/docs/review-github-code). 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. <!-- Links --> [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
475 lines
18 KiB
Dart
475 lines
18 KiB
Dart
// Copyright 2014 The Flutter Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
// found in the LICENSE file.
|
|
|
|
import 'package:flutter/gestures.dart';
|
|
import 'package:flutter/material.dart';
|
|
import 'package:flutter/services.dart';
|
|
import 'package:flutter_test/flutter_test.dart';
|
|
|
|
void main() {
|
|
void onPressed(TestMenu item) {}
|
|
|
|
Finder findMenuPanels(Axis orientation) {
|
|
return find.byWidgetPredicate((Widget widget) {
|
|
return widget.runtimeType.toString() == '_MenuPanel' &&
|
|
(widget as dynamic).orientation == orientation;
|
|
});
|
|
}
|
|
|
|
Finder findMenuBarPanel() {
|
|
return findMenuPanels(Axis.horizontal);
|
|
}
|
|
|
|
Finder findSubmenuPanel() {
|
|
return findMenuPanels(Axis.vertical);
|
|
}
|
|
|
|
Finder findSubMenuItem() {
|
|
return find.descendant(of: findSubmenuPanel().last, matching: find.byType(MenuItemButton));
|
|
}
|
|
|
|
Material getMenuBarPanelMaterial(WidgetTester tester) {
|
|
return tester.widget<Material>(
|
|
find.descendant(of: findMenuBarPanel(), matching: find.byType(Material)).first,
|
|
);
|
|
}
|
|
|
|
Material getSubmenuPanelMaterial(WidgetTester tester) {
|
|
return tester.widget<Material>(
|
|
find.descendant(of: findSubmenuPanel(), matching: find.byType(Material)).first,
|
|
);
|
|
}
|
|
|
|
DefaultTextStyle getLabelStyle(WidgetTester tester, String labelText) {
|
|
return tester.widget<DefaultTextStyle>(
|
|
find.ancestor(of: find.text(labelText), matching: find.byType(DefaultTextStyle)).first,
|
|
);
|
|
}
|
|
|
|
Future<TestGesture> hoverOver(WidgetTester tester, Finder finder) async {
|
|
final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.mouse);
|
|
await gesture.moveTo(tester.getCenter(finder));
|
|
await tester.pumpAndSettle();
|
|
return gesture;
|
|
}
|
|
|
|
test('MenuThemeData defaults', () {
|
|
const menuThemeData = MenuThemeData();
|
|
expect(menuThemeData.style, isNull);
|
|
expect(menuThemeData.submenuIcon, isNull);
|
|
});
|
|
|
|
testWidgets('Default MenuThemeData debugFillProperties', (WidgetTester tester) async {
|
|
final builder = DiagnosticPropertiesBuilder();
|
|
const MenuThemeData().debugFillProperties(builder);
|
|
|
|
final List<String> description = builder.properties
|
|
.where((DiagnosticsNode node) => !node.isFiltered(DiagnosticLevel.info))
|
|
.map((DiagnosticsNode node) => node.toString())
|
|
.toList();
|
|
|
|
expect(description, <String>[]);
|
|
});
|
|
|
|
testWidgets('MenuThemeData debugFillProperties', (WidgetTester tester) async {
|
|
final builder = DiagnosticPropertiesBuilder();
|
|
const MenuThemeData(
|
|
style: MenuStyle(backgroundColor: WidgetStatePropertyAll<Color?>(Color(0xfffffff1))),
|
|
submenuIcon: WidgetStatePropertyAll<Widget?>(Icon(Icons.add)),
|
|
).debugFillProperties(builder);
|
|
|
|
final List<String> description = builder.properties
|
|
.where((DiagnosticsNode node) => !node.isFiltered(DiagnosticLevel.info))
|
|
.map((DiagnosticsNode node) => node.toString())
|
|
.toList();
|
|
|
|
expect(
|
|
description,
|
|
equalsIgnoringHashCodes(<String>[
|
|
'style: MenuStyle#c6d29(backgroundColor: WidgetStatePropertyAll(Color(alpha: 1.0000, red: 1.0000, green: 1.0000, blue: 0.9451, colorSpace: ColorSpace.sRGB)))',
|
|
'submenuIcon: WidgetStatePropertyAll(Icon(IconData(U+0E047)))',
|
|
]),
|
|
);
|
|
});
|
|
|
|
test('MenuThemeData lerp special cases', () {
|
|
expect(MenuThemeData.lerp(null, null, 0), null);
|
|
const data = MenuThemeData();
|
|
expect(identical(MenuThemeData.lerp(data, data, 0.5), data), true);
|
|
});
|
|
|
|
testWidgets('theme is honored', (WidgetTester tester) async {
|
|
await tester.pumpWidget(
|
|
MaterialApp(
|
|
theme: ThemeData(useMaterial3: false),
|
|
home: Material(
|
|
child: Builder(
|
|
builder: (BuildContext context) {
|
|
return MenuBarTheme(
|
|
data: const MenuBarThemeData(
|
|
style: MenuStyle(
|
|
backgroundColor: MaterialStatePropertyAll<Color?>(Colors.green),
|
|
elevation: MaterialStatePropertyAll<double?>(20.0),
|
|
),
|
|
),
|
|
child: MenuTheme(
|
|
data: const MenuThemeData(
|
|
style: MenuStyle(
|
|
backgroundColor: MaterialStatePropertyAll<Color?>(Colors.red),
|
|
elevation: MaterialStatePropertyAll<double?>(15.0),
|
|
shape: MaterialStatePropertyAll<OutlinedBorder?>(StadiumBorder()),
|
|
padding: MaterialStatePropertyAll<EdgeInsetsGeometry>(
|
|
EdgeInsetsDirectional.all(10.0),
|
|
),
|
|
),
|
|
),
|
|
child: Column(
|
|
children: <Widget>[
|
|
MenuBar(children: createTestMenus(onPressed: onPressed)),
|
|
const Expanded(child: Placeholder()),
|
|
],
|
|
),
|
|
),
|
|
);
|
|
},
|
|
),
|
|
),
|
|
),
|
|
);
|
|
|
|
// Open a test menu.
|
|
await tester.tap(find.text(TestMenu.mainMenu1.label));
|
|
await tester.pump();
|
|
expect(
|
|
tester.getRect(findMenuBarPanel().first),
|
|
equals(const Rect.fromLTRB(234.0, 0.0, 566.0, 48.0)),
|
|
);
|
|
final Material menuBarMaterial = getMenuBarPanelMaterial(tester);
|
|
expect(menuBarMaterial.elevation, equals(20));
|
|
expect(menuBarMaterial.color, equals(Colors.green));
|
|
|
|
final Material subMenuMaterial = getSubmenuPanelMaterial(tester);
|
|
expect(
|
|
tester.getRect(findSubmenuPanel()),
|
|
equals(const Rect.fromLTRB(336.0, 48.0, 570.0, 212.0)),
|
|
);
|
|
expect(subMenuMaterial.elevation, equals(15));
|
|
expect(subMenuMaterial.color, equals(Colors.red));
|
|
});
|
|
|
|
testWidgets('Constructor parameters override theme parameters', (WidgetTester tester) async {
|
|
await tester.pumpWidget(
|
|
MaterialApp(
|
|
theme: ThemeData(useMaterial3: false),
|
|
home: Material(
|
|
child: Builder(
|
|
builder: (BuildContext context) {
|
|
return MenuBarTheme(
|
|
data: const MenuBarThemeData(
|
|
style: MenuStyle(
|
|
backgroundColor: MaterialStatePropertyAll<Color?>(Colors.green),
|
|
elevation: MaterialStatePropertyAll<double?>(20.0),
|
|
),
|
|
),
|
|
child: MenuTheme(
|
|
data: const MenuThemeData(
|
|
style: MenuStyle(
|
|
backgroundColor: MaterialStatePropertyAll<Color?>(Colors.red),
|
|
elevation: MaterialStatePropertyAll<double?>(15.0),
|
|
shape: MaterialStatePropertyAll<OutlinedBorder?>(StadiumBorder()),
|
|
padding: MaterialStatePropertyAll<EdgeInsetsGeometry>(
|
|
EdgeInsetsDirectional.all(10.0),
|
|
),
|
|
),
|
|
),
|
|
child: Column(
|
|
children: <Widget>[
|
|
MenuBar(
|
|
style: const MenuStyle(
|
|
backgroundColor: MaterialStatePropertyAll<Color?>(Colors.blue),
|
|
elevation: MaterialStatePropertyAll<double?>(10.0),
|
|
padding: MaterialStatePropertyAll<EdgeInsetsGeometry>(
|
|
EdgeInsetsDirectional.all(12.0),
|
|
),
|
|
),
|
|
children: createTestMenus(
|
|
onPressed: onPressed,
|
|
menuBackground: Colors.cyan,
|
|
menuElevation: 18.0,
|
|
menuPadding: const EdgeInsetsDirectional.all(14.0),
|
|
menuShape: const BeveledRectangleBorder(),
|
|
itemBackground: Colors.amber,
|
|
itemForeground: Colors.grey,
|
|
itemOverlay: Colors.blueGrey,
|
|
itemPadding: const EdgeInsetsDirectional.all(11.0),
|
|
itemShape: const StadiumBorder(),
|
|
),
|
|
),
|
|
const Expanded(child: Placeholder()),
|
|
],
|
|
),
|
|
),
|
|
);
|
|
},
|
|
),
|
|
),
|
|
),
|
|
);
|
|
|
|
// Open a test menu.
|
|
await tester.tap(find.text(TestMenu.mainMenu1.label));
|
|
await tester.pump();
|
|
|
|
expect(
|
|
tester.getRect(findMenuBarPanel().first),
|
|
equals(const Rect.fromLTRB(226.0, 0.0, 574.0, 72.0)),
|
|
);
|
|
final Material menuBarMaterial = getMenuBarPanelMaterial(tester);
|
|
expect(menuBarMaterial.elevation, equals(10.0));
|
|
expect(menuBarMaterial.color, equals(Colors.blue));
|
|
|
|
final Material subMenuMaterial = getSubmenuPanelMaterial(tester);
|
|
expect(
|
|
tester.getRect(findSubmenuPanel()),
|
|
equals(const Rect.fromLTRB(332.0, 60.0, 574.0, 232.0)),
|
|
);
|
|
expect(subMenuMaterial.elevation, equals(18));
|
|
expect(subMenuMaterial.color, equals(Colors.cyan));
|
|
expect(subMenuMaterial.shape, equals(const BeveledRectangleBorder()));
|
|
|
|
final Finder menuItem = findSubMenuItem();
|
|
expect(tester.getRect(menuItem.first), equals(const Rect.fromLTRB(346.0, 74.0, 560.0, 122.0)));
|
|
final Material menuItemMaterial = tester.widget<Material>(
|
|
find.ancestor(of: find.text(TestMenu.subMenu10.label), matching: find.byType(Material)).first,
|
|
);
|
|
expect(menuItemMaterial.color, equals(Colors.amber));
|
|
expect(menuItemMaterial.elevation, equals(0.0));
|
|
expect(menuItemMaterial.shape, equals(const StadiumBorder()));
|
|
expect(getLabelStyle(tester, TestMenu.subMenu10.label).style.color, equals(Colors.grey));
|
|
final ButtonStyle? textButtonStyle = tester
|
|
.widget<TextButton>(
|
|
find
|
|
.ancestor(of: find.text(TestMenu.subMenu10.label), matching: find.byType(TextButton))
|
|
.first,
|
|
)
|
|
.style;
|
|
expect(
|
|
textButtonStyle?.overlayColor?.resolve(<WidgetState>{WidgetState.hovered}),
|
|
equals(Colors.blueGrey),
|
|
);
|
|
});
|
|
|
|
testWidgets('SubmenuButton.submenuIcon updates default arrow icon', (WidgetTester tester) async {
|
|
final controller = MenuController();
|
|
const IconData disabledIcon = Icons.close_fullscreen;
|
|
const IconData hoveredIcon = Icons.ac_unit;
|
|
const IconData focusedIcon = Icons.zoom_out;
|
|
const IconData defaultIcon = Icons.minimize;
|
|
final WidgetStateProperty<Widget?> submenuIcon = WidgetStateProperty.resolveWith<Widget?>((
|
|
Set<WidgetState> states,
|
|
) {
|
|
if (states.contains(WidgetState.disabled)) {
|
|
return const Icon(disabledIcon);
|
|
}
|
|
if (states.contains(WidgetState.hovered)) {
|
|
return const Icon(hoveredIcon);
|
|
}
|
|
if (states.contains(WidgetState.focused)) {
|
|
return const Icon(focusedIcon);
|
|
}
|
|
return const Icon(defaultIcon);
|
|
});
|
|
|
|
Widget buildMenu({WidgetStateProperty<Widget?>? icon, bool enabled = true}) {
|
|
return MaterialApp(
|
|
theme: ThemeData(menuTheme: MenuThemeData(submenuIcon: icon)),
|
|
home: Material(
|
|
child: MenuBar(
|
|
controller: controller,
|
|
children: <Widget>[
|
|
SubmenuButton(
|
|
menuChildren: <Widget>[
|
|
SubmenuButton(
|
|
menuChildren: enabled
|
|
? <Widget>[MenuItemButton(child: Text(TestMenu.mainMenu0.label))]
|
|
: <Widget>[],
|
|
child: Text(TestMenu.subSubMenu110.label),
|
|
),
|
|
],
|
|
child: Text(TestMenu.subMenu00.label),
|
|
),
|
|
],
|
|
),
|
|
),
|
|
);
|
|
}
|
|
|
|
await tester.pumpWidget(buildMenu());
|
|
await tester.tap(find.text(TestMenu.subMenu00.label));
|
|
await tester.pump();
|
|
|
|
expect(find.byIcon(Icons.arrow_right), findsOneWidget);
|
|
|
|
controller.close();
|
|
await tester.pump();
|
|
|
|
await tester.pumpWidget(buildMenu(icon: submenuIcon));
|
|
await tester.pumpAndSettle();
|
|
|
|
await tester.tap(find.text(TestMenu.subMenu00.label));
|
|
await tester.pump();
|
|
expect(find.byIcon(defaultIcon), findsOneWidget);
|
|
|
|
await tester.sendKeyEvent(LogicalKeyboardKey.arrowDown);
|
|
await tester.pump();
|
|
expect(find.byIcon(focusedIcon), findsOneWidget);
|
|
|
|
controller.close();
|
|
await tester.pump();
|
|
|
|
await tester.tap(find.text(TestMenu.subMenu00.label));
|
|
await tester.pump();
|
|
await hoverOver(tester, find.text(TestMenu.subSubMenu110.label));
|
|
await tester.pump();
|
|
expect(find.byIcon(hoveredIcon), findsOneWidget);
|
|
|
|
controller.close();
|
|
await tester.pump();
|
|
|
|
await tester.pumpWidget(buildMenu(icon: submenuIcon, enabled: false));
|
|
await tester.tap(find.text(TestMenu.subMenu00.label));
|
|
await tester.pump();
|
|
expect(find.byIcon(disabledIcon), findsOneWidget);
|
|
});
|
|
}
|
|
|
|
List<Widget> createTestMenus({
|
|
void Function(TestMenu)? onPressed,
|
|
void Function(TestMenu)? onOpen,
|
|
void Function(TestMenu)? onClose,
|
|
Map<TestMenu, MenuSerializableShortcut> shortcuts = const <TestMenu, MenuSerializableShortcut>{},
|
|
bool includeStandard = false,
|
|
Color? itemOverlay,
|
|
Color? itemBackground,
|
|
Color? itemForeground,
|
|
EdgeInsetsDirectional? itemPadding,
|
|
Color? menuBackground,
|
|
EdgeInsetsDirectional? menuPadding,
|
|
OutlinedBorder? menuShape,
|
|
double? menuElevation,
|
|
OutlinedBorder? itemShape,
|
|
}) {
|
|
final menuStyle = MenuStyle(
|
|
padding: menuPadding != null ? MaterialStatePropertyAll<EdgeInsetsGeometry>(menuPadding) : null,
|
|
backgroundColor: menuBackground != null
|
|
? MaterialStatePropertyAll<Color>(menuBackground)
|
|
: null,
|
|
elevation: menuElevation != null ? MaterialStatePropertyAll<double>(menuElevation) : null,
|
|
shape: menuShape != null ? MaterialStatePropertyAll<OutlinedBorder>(menuShape) : null,
|
|
);
|
|
final itemStyle = ButtonStyle(
|
|
padding: itemPadding != null ? MaterialStatePropertyAll<EdgeInsetsGeometry>(itemPadding) : null,
|
|
shape: itemShape != null ? MaterialStatePropertyAll<OutlinedBorder>(itemShape) : null,
|
|
foregroundColor: itemForeground != null
|
|
? MaterialStatePropertyAll<Color>(itemForeground)
|
|
: null,
|
|
backgroundColor: itemBackground != null
|
|
? MaterialStatePropertyAll<Color>(itemBackground)
|
|
: null,
|
|
overlayColor: itemOverlay != null ? MaterialStatePropertyAll<Color>(itemOverlay) : null,
|
|
);
|
|
final result = <Widget>[
|
|
SubmenuButton(
|
|
onOpen: onOpen != null ? () => onOpen(TestMenu.mainMenu0) : null,
|
|
onClose: onClose != null ? () => onClose(TestMenu.mainMenu0) : null,
|
|
menuChildren: <Widget>[
|
|
MenuItemButton(
|
|
onPressed: onPressed != null ? () => onPressed(TestMenu.subMenu00) : null,
|
|
shortcut: shortcuts[TestMenu.subMenu00],
|
|
child: Text(TestMenu.subMenu00.label),
|
|
),
|
|
],
|
|
child: Text(TestMenu.mainMenu0.label),
|
|
),
|
|
SubmenuButton(
|
|
onOpen: onOpen != null ? () => onOpen(TestMenu.mainMenu1) : null,
|
|
onClose: onClose != null ? () => onClose(TestMenu.mainMenu1) : null,
|
|
menuStyle: menuStyle,
|
|
menuChildren: <Widget>[
|
|
MenuItemButton(
|
|
onPressed: onPressed != null ? () => onPressed(TestMenu.subMenu10) : null,
|
|
shortcut: shortcuts[TestMenu.subMenu10],
|
|
style: itemStyle,
|
|
child: Text(TestMenu.subMenu10.label),
|
|
),
|
|
SubmenuButton(
|
|
onOpen: onOpen != null ? () => onOpen(TestMenu.subMenu11) : null,
|
|
onClose: onClose != null ? () => onClose(TestMenu.subMenu11) : null,
|
|
menuChildren: <Widget>[
|
|
MenuItemButton(
|
|
onPressed: onPressed != null ? () => onPressed(TestMenu.subSubMenu110) : null,
|
|
shortcut: shortcuts[TestMenu.subSubMenu110],
|
|
child: Text(TestMenu.subSubMenu110.label),
|
|
),
|
|
MenuItemButton(
|
|
onPressed: onPressed != null ? () => onPressed(TestMenu.subSubMenu111) : null,
|
|
shortcut: shortcuts[TestMenu.subSubMenu111],
|
|
child: Text(TestMenu.subSubMenu111.label),
|
|
),
|
|
MenuItemButton(
|
|
onPressed: onPressed != null ? () => onPressed(TestMenu.subSubMenu112) : null,
|
|
shortcut: shortcuts[TestMenu.subSubMenu112],
|
|
child: Text(TestMenu.subSubMenu112.label),
|
|
),
|
|
MenuItemButton(
|
|
onPressed: onPressed != null ? () => onPressed(TestMenu.subSubMenu113) : null,
|
|
shortcut: shortcuts[TestMenu.subSubMenu113],
|
|
child: Text(TestMenu.subSubMenu113.label),
|
|
),
|
|
],
|
|
child: Text(TestMenu.subMenu11.label),
|
|
),
|
|
MenuItemButton(
|
|
onPressed: onPressed != null ? () => onPressed(TestMenu.subMenu12) : null,
|
|
shortcut: shortcuts[TestMenu.subMenu12],
|
|
child: Text(TestMenu.subMenu12.label),
|
|
),
|
|
],
|
|
child: Text(TestMenu.mainMenu1.label),
|
|
),
|
|
SubmenuButton(
|
|
onOpen: onOpen != null ? () => onOpen(TestMenu.mainMenu2) : null,
|
|
onClose: onClose != null ? () => onClose(TestMenu.mainMenu2) : null,
|
|
menuChildren: <Widget>[
|
|
MenuItemButton(
|
|
// Always disabled.
|
|
shortcut: shortcuts[TestMenu.subMenu20],
|
|
// Always disabled.
|
|
child: Text(TestMenu.subMenu20.label),
|
|
),
|
|
],
|
|
child: Text(TestMenu.mainMenu2.label),
|
|
),
|
|
];
|
|
return result;
|
|
}
|
|
|
|
enum TestMenu {
|
|
mainMenu0('Menu 0'),
|
|
mainMenu1('Menu 1'),
|
|
mainMenu2('Menu 2'),
|
|
subMenu00('Sub Menu 00'),
|
|
subMenu10('Sub Menu 10'),
|
|
subMenu11('Sub Menu 11'),
|
|
subMenu12('Sub Menu 12'),
|
|
subMenu20('Sub Menu 20'),
|
|
subSubMenu110('Sub Sub Menu 110'),
|
|
subSubMenu111('Sub Sub Menu 111'),
|
|
subSubMenu112('Sub Sub Menu 112'),
|
|
subSubMenu113('Sub Sub Menu 113');
|
|
|
|
const TestMenu(this.label);
|
|
final String label;
|
|
}
|