// 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/foundation.dart'; import 'package:flutter/gestures.dart'; import 'package:flutter/material.dart'; import 'package:flutter/rendering.dart'; import 'package:flutter_test/flutter_test.dart'; import '../widgets/semantics_tester.dart'; void main() { TextStyle iconStyle(WidgetTester tester, IconData icon) { final RichText iconRichText = tester.widget( find.descendant(of: find.byIcon(icon), matching: find.byType(RichText)), ); return iconRichText.text.style!; } Color textColor(WidgetTester tester, String text) { return tester.renderObject(find.text(text)).text.style!.color!; } testWidgets('TextButton, TextButton.icon defaults', (WidgetTester tester) async { const colorScheme = ColorScheme.light(); final theme = ThemeData.from(colorScheme: colorScheme); final bool material3 = theme.useMaterial3; // Enabled TextButton await tester.pumpWidget( MaterialApp( theme: theme, home: Center( child: TextButton(onPressed: () {}, child: const Text('button')), ), ), ); final Finder buttonMaterial = find.descendant( of: find.byType(TextButton), matching: find.byType(Material), ); Material material = tester.widget(buttonMaterial); expect(material.animationDuration, const Duration(milliseconds: 200)); expect(material.borderOnForeground, false); expect(material.borderRadius, null); expect(material.clipBehavior, Clip.none); expect(material.color, Colors.transparent); expect(material.elevation, 0.0); expect(material.shadowColor, material3 ? Colors.transparent : const Color(0xff000000)); expect( material.shape, material3 ? const StadiumBorder() : const RoundedRectangleBorder(borderRadius: BorderRadius.all(Radius.circular(4))), ); expect(material.textStyle!.color, colorScheme.primary); expect(material.textStyle!.fontFamily, 'Roboto'); expect(material.textStyle!.fontSize, 14); expect(material.textStyle!.fontWeight, FontWeight.w500); expect(material.type, MaterialType.button); final Align align = tester.firstWidget( find.ancestor(of: find.text('button'), matching: find.byType(Align)), ); expect(align.alignment, Alignment.center); final Offset center = tester.getCenter(find.byType(TextButton)); final TestGesture gesture = await tester.startGesture(center); await tester.pump(); // start the splash animation await tester.pump(const Duration(milliseconds: 100)); // splash is underway // Material 3 uses the InkSparkle which uses a shader, so we can't capture // the effect with paint methods. if (!material3) { final RenderObject inkFeatures = tester.allRenderObjects.firstWhere( (RenderObject object) => object.runtimeType.toString() == '_RenderInkFeatures', ); expect(inkFeatures, paints..circle(color: colorScheme.primary.withOpacity(0.12))); } await gesture.up(); await tester.pumpAndSettle(); material = tester.widget(buttonMaterial); // No change vs enabled and not pressed. expect(material.animationDuration, const Duration(milliseconds: 200)); expect(material.borderOnForeground, false); expect(material.borderRadius, null); expect(material.clipBehavior, Clip.none); expect(material.color, Colors.transparent); expect(material.elevation, 0.0); expect(material.shadowColor, material3 ? Colors.transparent : const Color(0xff000000)); expect( material.shape, material3 ? const StadiumBorder() : const RoundedRectangleBorder(borderRadius: BorderRadius.all(Radius.circular(4))), ); expect(material.textStyle!.color, colorScheme.primary); expect(material.textStyle!.fontFamily, 'Roboto'); expect(material.textStyle!.fontSize, 14); expect(material.textStyle!.fontWeight, FontWeight.w500); expect(material.type, MaterialType.button); // Enabled TextButton.icon final Key iconButtonKey = UniqueKey(); await tester.pumpWidget( MaterialApp( theme: theme, home: Center( child: TextButton.icon( key: iconButtonKey, onPressed: () {}, icon: const Icon(Icons.add), label: const Text('label'), ), ), ), ); final Finder iconButtonMaterial = find.descendant( of: find.byKey(iconButtonKey), matching: find.byType(Material), ); material = tester.widget(iconButtonMaterial); expect(material.animationDuration, const Duration(milliseconds: 200)); expect(material.borderOnForeground, false); expect(material.borderRadius, null); expect(material.clipBehavior, Clip.none); expect(material.color, Colors.transparent); expect(material.elevation, 0.0); expect(material.shadowColor, material3 ? Colors.transparent : const Color(0xff000000)); expect( material.shape, material3 ? const StadiumBorder() : const RoundedRectangleBorder(borderRadius: BorderRadius.all(Radius.circular(4))), ); expect(material.textStyle!.color, colorScheme.primary); expect(material.textStyle!.fontFamily, 'Roboto'); expect(material.textStyle!.fontSize, 14); expect(material.textStyle!.fontWeight, FontWeight.w500); expect(material.type, MaterialType.button); // Disabled TextButton await tester.pumpWidget( MaterialApp( theme: theme, home: const Center(child: TextButton(onPressed: null, child: Text('button'))), ), ); material = tester.widget(buttonMaterial); expect(material.animationDuration, const Duration(milliseconds: 200)); expect(material.borderOnForeground, false); expect(material.borderRadius, null); expect(material.clipBehavior, Clip.none); expect(material.color, Colors.transparent); expect(material.elevation, 0.0); expect(material.shadowColor, material3 ? Colors.transparent : const Color(0xff000000)); expect( material.shape, material3 ? const StadiumBorder() : const RoundedRectangleBorder(borderRadius: BorderRadius.all(Radius.circular(4))), ); expect(material.textStyle!.color, colorScheme.onSurface.withOpacity(0.38)); expect(material.textStyle!.fontFamily, 'Roboto'); expect(material.textStyle!.fontSize, 14); expect(material.textStyle!.fontWeight, FontWeight.w500); expect(material.type, MaterialType.button); }); testWidgets('TextButton.defaultStyle produces a ButtonStyle with appropriate non-null values', ( WidgetTester tester, ) async { const colorScheme = ColorScheme.light(); final theme = ThemeData.from(colorScheme: colorScheme); final button = TextButton(onPressed: () {}, child: const Text('button')); BuildContext? capturedContext; // Enabled TextButton await tester.pumpWidget( MaterialApp( theme: theme, home: Center( child: Builder( builder: (BuildContext context) { capturedContext = context; return button; }, ), ), ), ); final ButtonStyle style = button.defaultStyleOf(capturedContext!); // Properties that must be non-null. expect(style.textStyle, isNotNull, reason: 'textStyle style'); expect(style.backgroundColor, isNotNull, reason: 'backgroundColor style'); expect(style.foregroundColor, isNotNull, reason: 'foregroundColor style'); expect(style.overlayColor, isNotNull, reason: 'overlayColor style'); expect(style.shadowColor, isNotNull, reason: 'shadowColor style'); expect(style.surfaceTintColor, isNotNull, reason: 'surfaceTintColor style'); expect(style.elevation, isNotNull, reason: 'elevation style'); expect(style.padding, isNotNull, reason: 'padding style'); expect(style.minimumSize, isNotNull, reason: 'minimumSize style'); expect(style.maximumSize, isNotNull, reason: 'maximumSize style'); expect(style.iconColor, isNotNull, reason: 'iconColor style'); expect(style.iconSize, isNotNull, reason: 'iconSize style'); expect(style.shape, isNotNull, reason: 'shape style'); expect(style.mouseCursor, isNotNull, reason: 'mouseCursor style'); expect(style.visualDensity, isNotNull, reason: 'visualDensity style'); expect(style.tapTargetSize, isNotNull, reason: 'tapTargetSize style'); expect(style.animationDuration, isNotNull, reason: 'animationDuration style'); expect(style.enableFeedback, isNotNull, reason: 'enableFeedback style'); expect(style.alignment, isNotNull, reason: 'alignment style'); expect(style.splashFactory, isNotNull, reason: 'splashFactory style'); // Properties that are expected to be null. expect(style.fixedSize, isNull, reason: 'fixedSize style'); expect(style.side, isNull, reason: 'side style'); expect(style.backgroundBuilder, isNull, reason: 'backgroundBuilder style'); expect(style.foregroundBuilder, isNull, reason: 'foregroundBuilder style'); }); testWidgets( 'TextButton.defaultStyle with an icon produces a ButtonStyle with appropriate non-null values', (WidgetTester tester) async { const colorScheme = ColorScheme.light(); final theme = ThemeData.from(colorScheme: colorScheme); final button = TextButton.icon( onPressed: () {}, icon: const SizedBox(), label: const Text('button'), ); BuildContext? capturedContext; await tester.pumpWidget( MaterialApp( theme: theme, home: Center( child: Builder( builder: (BuildContext context) { capturedContext = context; return button; }, ), ), ), ); final ButtonStyle style = button.defaultStyleOf(capturedContext!); // Properties that must be non-null. expect(style.textStyle, isNotNull, reason: 'textStyle style'); expect(style.backgroundColor, isNotNull, reason: 'backgroundColor style'); expect(style.foregroundColor, isNotNull, reason: 'foregroundColor style'); expect(style.overlayColor, isNotNull, reason: 'overlayColor style'); expect(style.shadowColor, isNotNull, reason: 'shadowColor style'); expect(style.surfaceTintColor, isNotNull, reason: 'surfaceTintColor style'); expect(style.elevation, isNotNull, reason: 'elevation style'); expect(style.padding, isNotNull, reason: 'padding style'); expect(style.minimumSize, isNotNull, reason: 'minimumSize style'); expect(style.maximumSize, isNotNull, reason: 'maximumSize style'); expect(style.iconColor, isNotNull, reason: 'iconColor style'); expect(style.iconSize, isNotNull, reason: 'iconSize style'); expect(style.shape, isNotNull, reason: 'shape style'); expect(style.mouseCursor, isNotNull, reason: 'mouseCursor style'); expect(style.visualDensity, isNotNull, reason: 'visualDensity style'); expect(style.tapTargetSize, isNotNull, reason: 'tapTargetSize style'); expect(style.animationDuration, isNotNull, reason: 'animationDuration style'); expect(style.enableFeedback, isNotNull, reason: 'enableFeedback style'); expect(style.alignment, isNotNull, reason: 'alignment style'); expect(style.splashFactory, isNotNull, reason: 'splashFactory style'); // Properties that are expected to be null. expect(style.fixedSize, isNull, reason: 'fixedSize style'); expect(style.side, isNull, reason: 'side style'); expect(style.backgroundBuilder, isNull, reason: 'backgroundBuilder style'); expect(style.foregroundBuilder, isNull, reason: 'foregroundBuilder style'); }, ); testWidgets('TextButton.icon produces the correct widgets when icon is null', ( WidgetTester tester, ) async { const colorScheme = ColorScheme.light(); final theme = ThemeData.from(colorScheme: colorScheme); final Key iconButtonKey = UniqueKey(); await tester.pumpWidget( MaterialApp( theme: theme, home: Center( child: TextButton.icon( key: iconButtonKey, onPressed: () {}, icon: const Icon(Icons.add), label: const Text('label'), ), ), ), ); expect(find.byIcon(Icons.add), findsOneWidget); expect(find.text('label'), findsOneWidget); await tester.pumpWidget( MaterialApp( theme: theme, home: Center( child: TextButton.icon( key: iconButtonKey, onPressed: () {}, // No icon specified. label: const Text('label'), ), ), ), ); expect(find.byIcon(Icons.add), findsNothing); expect(find.text('label'), findsOneWidget); }); testWidgets( 'Default TextButton meets a11y contrast guidelines', (WidgetTester tester) async { final focusNode = FocusNode(); await tester.pumpWidget( MaterialApp( theme: ThemeData.from(colorScheme: const ColorScheme.light()), home: Scaffold( body: Center( child: TextButton( onPressed: () {}, focusNode: focusNode, child: const Text('TextButton'), ), ), ), ), ); // Default, not disabled. await expectLater(tester, meetsGuideline(textContrastGuideline)); // Hovered. final Offset center = tester.getCenter(find.byType(TextButton)); final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.mouse); await gesture.addPointer(); await gesture.moveTo(center); await tester.pumpAndSettle(); await expectLater(tester, meetsGuideline(textContrastGuideline)); // Highlighted (pressed). await gesture.down(center); await tester.pump(); // Start the splash and highlight animations. await tester.pump( const Duration(milliseconds: 800), ); // Wait for splash and highlight to be well under way. await expectLater(tester, meetsGuideline(textContrastGuideline)); await gesture.removePointer(); // Focused. focusNode.requestFocus(); await tester.pumpAndSettle(); await expectLater(tester, meetsGuideline(textContrastGuideline)); focusNode.dispose(); }, skip: isBrowser, // https://github.com/flutter/flutter/issues/44115 ); testWidgets( 'TextButton with colored theme meets a11y contrast guidelines', (WidgetTester tester) async { final focusNode = FocusNode(); Color getTextColor(Set states) { final interactiveStates = { WidgetState.pressed, WidgetState.hovered, WidgetState.focused, }; if (states.any(interactiveStates.contains)) { return Colors.blue[900]!; } return Colors.blue[800]!; } await tester.pumpWidget( MaterialApp( home: Scaffold( body: Center( child: TextButtonTheme( data: TextButtonThemeData( style: ButtonStyle( foregroundColor: WidgetStateProperty.resolveWith(getTextColor), ), ), child: Builder( builder: (BuildContext context) { return TextButton( onPressed: () {}, focusNode: focusNode, child: const Text('TextButton'), ); }, ), ), ), ), ), ); // Default, not disabled. await expectLater(tester, meetsGuideline(textContrastGuideline)); // Focused. focusNode.requestFocus(); await tester.pumpAndSettle(); await expectLater(tester, meetsGuideline(textContrastGuideline)); // Hovered. final Offset center = tester.getCenter(find.byType(TextButton)); final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.mouse); await gesture.addPointer(); await gesture.moveTo(center); await tester.pumpAndSettle(); await expectLater(tester, meetsGuideline(textContrastGuideline)); // Highlighted (pressed). await gesture.down(center); await tester.pump(); // Start the splash and highlight animations. await tester.pump( const Duration(milliseconds: 800), ); // Wait for splash and highlight to be well under way. await expectLater(tester, meetsGuideline(textContrastGuideline)); focusNode.dispose(); }, skip: isBrowser, // https://github.com/flutter/flutter/issues/44115 ); testWidgets('TextButton default overlayColor resolves pressed state', ( WidgetTester tester, ) async { final focusNode = FocusNode(); final theme = ThemeData(); await tester.pumpWidget( MaterialApp( theme: theme, home: Scaffold( body: Center( child: Builder( builder: (BuildContext context) { return TextButton( onPressed: () {}, focusNode: focusNode, child: const Text('TextButton'), ); }, ), ), ), ), ); RenderObject overlayColor() { return tester.allRenderObjects.firstWhere( (RenderObject object) => object.runtimeType.toString() == '_RenderInkFeatures', ); } // Hovered. final Offset center = tester.getCenter(find.byType(TextButton)); final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.mouse); await gesture.addPointer(); await gesture.moveTo(center); await tester.pumpAndSettle(); expect(overlayColor(), paints..rect(color: theme.colorScheme.primary.withOpacity(0.08))); // Highlighted (pressed). await gesture.down(center); await tester.pumpAndSettle(); expect( overlayColor(), paints ..rect() ..rect(color: theme.colorScheme.primary.withOpacity(0.1)), ); // Remove pressed and hovered states await gesture.up(); await tester.pumpAndSettle(); await gesture.moveTo(const Offset(0, 50)); await tester.pumpAndSettle(); // Focused. focusNode.requestFocus(); await tester.pumpAndSettle(); expect(overlayColor(), paints..rect(color: theme.colorScheme.primary.withOpacity(0.1))); focusNode.dispose(); }); testWidgets('TextButton uses stateful color for text color in different states', ( WidgetTester tester, ) async { const buttonText = 'TextButton'; final focusNode = FocusNode(); const pressedColor = Color(0x00000001); const hoverColor = Color(0x00000002); const focusedColor = Color(0x00000003); const defaultColor = Color(0x00000004); Color getTextColor(Set states) { if (states.contains(WidgetState.pressed)) { return pressedColor; } if (states.contains(WidgetState.hovered)) { return hoverColor; } if (states.contains(WidgetState.focused)) { return focusedColor; } return defaultColor; } await tester.pumpWidget( MaterialApp( home: Scaffold( body: Center( child: TextButton( style: ButtonStyle( foregroundColor: WidgetStateProperty.resolveWith(getTextColor), ), onPressed: () {}, focusNode: focusNode, child: const Text(buttonText), ), ), ), ), ); // Default, not disabled. expect(textColor(tester, buttonText), equals(defaultColor)); // Focused. focusNode.requestFocus(); await tester.pumpAndSettle(); expect(textColor(tester, buttonText), focusedColor); // Hovered. final Offset center = tester.getCenter(find.byType(TextButton)); final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.mouse); await gesture.addPointer(); await gesture.moveTo(center); await tester.pumpAndSettle(); expect(textColor(tester, buttonText), hoverColor); // Highlighted (pressed). await gesture.down(center); await tester.pump(); // Start the splash and highlight animations. await tester.pump( const Duration(milliseconds: 800), ); // Wait for splash and highlight to be well under way. expect(textColor(tester, buttonText), pressedColor); focusNode.dispose(); }); testWidgets('TextButton uses stateful color for icon color in different states', ( WidgetTester tester, ) async { final focusNode = FocusNode(); final Key buttonKey = UniqueKey(); const pressedColor = Color(0x00000001); const hoverColor = Color(0x00000002); const focusedColor = Color(0x00000003); const defaultColor = Color(0x00000004); Color getTextColor(Set states) { if (states.contains(WidgetState.pressed)) { return pressedColor; } if (states.contains(WidgetState.hovered)) { return hoverColor; } if (states.contains(WidgetState.focused)) { return focusedColor; } return defaultColor; } await tester.pumpWidget( MaterialApp( home: Scaffold( body: Center( child: TextButton.icon( style: ButtonStyle( foregroundColor: WidgetStateProperty.resolveWith(getTextColor), iconColor: WidgetStateProperty.resolveWith(getTextColor), ), key: buttonKey, icon: const Icon(Icons.add), label: const Text('TextButton'), onPressed: () {}, focusNode: focusNode, ), ), ), ), ); // Default, not disabled. expect(iconStyle(tester, Icons.add).color, equals(defaultColor)); // Focused. focusNode.requestFocus(); await tester.pumpAndSettle(); expect(iconStyle(tester, Icons.add).color, focusedColor); // Hovered. final Offset center = tester.getCenter(find.byKey(buttonKey)); final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.mouse); await gesture.addPointer(); await gesture.moveTo(center); await tester.pumpAndSettle(); expect(iconStyle(tester, Icons.add).color, hoverColor); // Highlighted (pressed). await gesture.down(center); await tester.pump(); // Start the splash and highlight animations. await tester.pump( const Duration(milliseconds: 800), ); // Wait for splash and highlight to be well under way. expect(iconStyle(tester, Icons.add).color, pressedColor); focusNode.dispose(); }); testWidgets('TextButton has no clip by default', (WidgetTester tester) async { await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: TextButton( child: Container(), onPressed: () { /* to make sure the button is enabled */ }, ), ), ); expect(tester.renderObject(find.byType(TextButton)), paintsExactlyCountTimes(#clipPath, 0)); }); testWidgets('Does TextButton work with hover', (WidgetTester tester) async { const hoverColor = Color(0xff001122); Color? getOverlayColor(Set states) { return states.contains(WidgetState.hovered) ? hoverColor : null; } await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: TextButton( style: ButtonStyle( overlayColor: WidgetStateProperty.resolveWith(getOverlayColor), ), child: Container(), onPressed: () { /* to make sure the button is enabled */ }, ), ), ); final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.mouse); await gesture.addPointer(); await gesture.moveTo(tester.getCenter(find.byType(TextButton))); await tester.pumpAndSettle(); final RenderObject inkFeatures = tester.allRenderObjects.firstWhere( (RenderObject object) => object.runtimeType.toString() == '_RenderInkFeatures', ); expect(inkFeatures, paints..rect(color: hoverColor)); }); testWidgets('Does TextButton work with focus', (WidgetTester tester) async { const focusColor = Color(0xff001122); Color? getOverlayColor(Set states) { return states.contains(WidgetState.focused) ? focusColor : null; } final focusNode = FocusNode(debugLabel: 'TextButton Node'); await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: TextButton( style: ButtonStyle( overlayColor: WidgetStateProperty.resolveWith(getOverlayColor), ), focusNode: focusNode, onPressed: () {}, child: const Text('button'), ), ), ); WidgetsBinding.instance.focusManager.highlightStrategy = FocusHighlightStrategy.alwaysTraditional; focusNode.requestFocus(); await tester.pumpAndSettle(); final RenderObject inkFeatures = tester.allRenderObjects.firstWhere( (RenderObject object) => object.runtimeType.toString() == '_RenderInkFeatures', ); expect(inkFeatures, paints..rect(color: focusColor)); focusNode.dispose(); }); testWidgets('Does TextButton contribute semantics', (WidgetTester tester) async { final semantics = SemanticsTester(tester); await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: Center( child: TextButton( style: const ButtonStyle( // Specifying minimumSize to mimic the original minimumSize for // RaisedButton so that the semantics tree's rect and transform // match the original version of this test. minimumSize: MaterialStatePropertyAll(Size(88, 36)), ), onPressed: () {}, child: const Text('ABC'), ), ), ), ); expect( semantics, hasSemantics( TestSemantics.root( children: [ TestSemantics.rootChild( actions: [SemanticsAction.tap, SemanticsAction.focus], label: 'ABC', rect: const Rect.fromLTRB(0.0, 0.0, 88.0, 48.0), transform: Matrix4.translationValues(356.0, 276.0, 0.0), flags: [ SemanticsFlag.hasEnabledState, SemanticsFlag.isButton, SemanticsFlag.isEnabled, SemanticsFlag.isFocusable, ], ), ], ), ignoreId: true, ), ); semantics.dispose(); }); testWidgets('Does TextButton scale with font scale changes', (WidgetTester tester) async { await tester.pumpWidget( Theme( data: ThemeData(useMaterial3: false), child: Directionality( textDirection: TextDirection.ltr, child: MediaQuery( data: const MediaQueryData(), child: Center( child: TextButton(onPressed: () {}, child: const Text('ABC')), ), ), ), ), ); expect(tester.getSize(find.byType(TextButton)), equals(const Size(64.0, 48.0))); expect(tester.getSize(find.byType(Text)), equals(const Size(42.0, 14.0))); // textScaleFactor expands text, but not button. await tester.pumpWidget( Theme( data: ThemeData(useMaterial3: false), child: Directionality( textDirection: TextDirection.ltr, child: MediaQuery.withClampedTextScaling( minScaleFactor: 1.25, maxScaleFactor: 1.25, child: Center( child: TextButton(onPressed: () {}, child: const Text('ABC')), ), ), ), ), ); const textButtonSize = Size(68.5, 48.0); const textSize = Size(52.5, 18.0); expect(tester.getSize(find.byType(TextButton)), textButtonSize); expect(tester.getSize(find.byType(Text)), textSize); // Set text scale large enough to expand text and button. await tester.pumpWidget( Theme( data: ThemeData(useMaterial3: false), child: Directionality( textDirection: TextDirection.ltr, child: MediaQuery.withClampedTextScaling( minScaleFactor: 3.0, maxScaleFactor: 3.0, child: Center( child: TextButton(onPressed: () {}, child: const Text('ABC')), ), ), ), ), ); expect(tester.getSize(find.byType(TextButton)), const Size(134.0, 48.0)); expect(tester.getSize(find.byType(Text)), const Size(126.0, 42.0)); }); testWidgets('TextButton size is configurable by ThemeData.materialTapTargetSize', ( WidgetTester tester, ) async { Widget buildFrame(MaterialTapTargetSize tapTargetSize, Key key) { return Theme( data: ThemeData(useMaterial3: false, materialTapTargetSize: tapTargetSize), child: Directionality( textDirection: TextDirection.ltr, child: Center( child: TextButton( key: key, style: TextButton.styleFrom(minimumSize: const Size(64, 36)), child: const SizedBox(width: 50.0, height: 8.0), onPressed: () {}, ), ), ), ); } final Key key1 = UniqueKey(); await tester.pumpWidget(buildFrame(MaterialTapTargetSize.padded, key1)); expect(tester.getSize(find.byKey(key1)), const Size(66.0, 48.0)); final Key key2 = UniqueKey(); await tester.pumpWidget(buildFrame(MaterialTapTargetSize.shrinkWrap, key2)); expect(tester.getSize(find.byKey(key2)), const Size(66.0, 36.0)); }); testWidgets('TextButton onPressed and onLongPress callbacks are correctly called when non-null', ( WidgetTester tester, ) async { bool wasPressed; Finder textButton; Widget buildFrame({VoidCallback? onPressed, VoidCallback? onLongPress}) { return Directionality( textDirection: TextDirection.ltr, child: TextButton( onPressed: onPressed, onLongPress: onLongPress, child: const Text('button'), ), ); } // onPressed not null, onLongPress null. wasPressed = false; await tester.pumpWidget( buildFrame( onPressed: () { wasPressed = true; }, ), ); textButton = find.byType(TextButton); expect(tester.widget(textButton).enabled, true); await tester.tap(textButton); expect(wasPressed, true); // onPressed null, onLongPress not null. wasPressed = false; await tester.pumpWidget( buildFrame( onLongPress: () { wasPressed = true; }, ), ); textButton = find.byType(TextButton); expect(tester.widget(textButton).enabled, true); await tester.longPress(textButton); expect(wasPressed, true); // onPressed null, onLongPress null. await tester.pumpWidget(buildFrame()); textButton = find.byType(TextButton); expect(tester.widget(textButton).enabled, false); }); testWidgets('TextButton onPressed and onLongPress callbacks are distinctly recognized', ( WidgetTester tester, ) async { var didPressButton = false; var didLongPressButton = false; await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: TextButton( onPressed: () { didPressButton = true; }, onLongPress: () { didLongPressButton = true; }, child: const Text('button'), ), ), ); final Finder textButton = find.byType(TextButton); expect(tester.widget(textButton).enabled, true); expect(didPressButton, isFalse); await tester.tap(textButton); expect(didPressButton, isTrue); expect(didLongPressButton, isFalse); await tester.longPress(textButton); expect(didLongPressButton, isTrue); }); testWidgets("TextButton response doesn't hover when disabled", (WidgetTester tester) async { FocusManager.instance.highlightStrategy = FocusHighlightStrategy.alwaysTouch; final focusNode = FocusNode(debugLabel: 'TextButton Focus'); final GlobalKey childKey = GlobalKey(); var hovering = false; await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: SizedBox( width: 100, height: 100, child: TextButton( autofocus: true, onPressed: () {}, onLongPress: () {}, onHover: (bool value) { hovering = value; }, focusNode: focusNode, child: SizedBox(key: childKey), ), ), ), ); await tester.pumpAndSettle(); expect(focusNode.hasPrimaryFocus, isTrue); final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.mouse); await gesture.addPointer(); await gesture.moveTo(tester.getCenter(find.byKey(childKey))); await tester.pumpAndSettle(); expect(hovering, isTrue); await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: SizedBox( width: 100, height: 100, child: TextButton( focusNode: focusNode, onHover: (bool value) { hovering = value; }, onPressed: null, child: SizedBox(key: childKey), ), ), ), ); await tester.pumpAndSettle(); expect(focusNode.hasPrimaryFocus, isFalse); focusNode.dispose(); }); testWidgets('disabled and hovered TextButton responds to mouse-exit', ( WidgetTester tester, ) async { var onHoverCount = 0; late bool hover; Widget buildFrame({required bool enabled}) { return Directionality( textDirection: TextDirection.ltr, child: Center( child: SizedBox( width: 100, height: 100, child: TextButton( onPressed: enabled ? () {} : null, onHover: (bool value) { onHoverCount += 1; hover = value; }, child: const Text('TextButton'), ), ), ), ); } await tester.pumpWidget(buildFrame(enabled: true)); final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.mouse); await gesture.addPointer(); await gesture.moveTo(tester.getCenter(find.byType(TextButton))); await tester.pumpAndSettle(); expect(onHoverCount, 1); expect(hover, true); await tester.pumpWidget(buildFrame(enabled: false)); await tester.pumpAndSettle(); await gesture.moveTo(Offset.zero); // Even though the TextButton has been disabled, the mouse-exit still // causes onHover(false) to be called. expect(onHoverCount, 2); expect(hover, false); await gesture.moveTo(tester.getCenter(find.byType(TextButton))); await tester.pumpAndSettle(); // We no longer see hover events because the TextButton is disabled // and it's no longer in the "hovering" state. expect(onHoverCount, 2); expect(hover, false); await tester.pumpWidget(buildFrame(enabled: true)); await tester.pumpAndSettle(); // The TextButton was enabled while it contained the mouse, however // we do not call onHover() because it may call setState(). expect(onHoverCount, 2); expect(hover, false); await gesture.moveTo(tester.getCenter(find.byType(TextButton)) - const Offset(1, 1)); await tester.pumpAndSettle(); // Moving the mouse a little within the TextButton doesn't change anything. expect(onHoverCount, 2); expect(hover, false); }); testWidgets('Can set TextButton focus and Can set unFocus.', (WidgetTester tester) async { final node = FocusNode(debugLabel: 'TextButton Focus'); var gotFocus = false; await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: TextButton( focusNode: node, onFocusChange: (bool focused) => gotFocus = focused, onPressed: () {}, child: const SizedBox(), ), ), ); node.requestFocus(); await tester.pump(); expect(gotFocus, isTrue); expect(node.hasFocus, isTrue); node.unfocus(); await tester.pump(); expect(gotFocus, isFalse); expect(node.hasFocus, isFalse); node.dispose(); }); testWidgets('When TextButton disable, Can not set TextButton focus.', ( WidgetTester tester, ) async { final node = FocusNode(debugLabel: 'TextButton Focus'); var gotFocus = false; await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: TextButton( focusNode: node, onFocusChange: (bool focused) => gotFocus = focused, onPressed: null, child: const SizedBox(), ), ), ); node.requestFocus(); await tester.pump(); expect(gotFocus, isFalse); expect(node.hasFocus, isFalse); node.dispose(); }); testWidgets('TextButton responds to density changes.', (WidgetTester tester) async { const key = Key('test'); const childKey = Key('test child'); Future buildTest(VisualDensity visualDensity, {bool useText = false}) async { return tester.pumpWidget( MaterialApp( theme: ThemeData(useMaterial3: false), home: Directionality( textDirection: TextDirection.rtl, child: Center( child: TextButton( style: ButtonStyle(visualDensity: visualDensity), key: key, onPressed: () {}, child: useText ? const Text('Text', key: childKey) : Container( key: childKey, width: 100, height: 100, color: const Color(0xffff0000), ), ), ), ), ), ); } await buildTest(VisualDensity.standard); final RenderBox box = tester.renderObject(find.byKey(key)); Rect childRect = tester.getRect(find.byKey(childKey)); await tester.pumpAndSettle(); expect(box.size, equals(const Size(116, 116))); expect(childRect, equals(const Rect.fromLTRB(350, 250, 450, 350))); await buildTest(const VisualDensity(horizontal: 3.0, vertical: 3.0)); await tester.pumpAndSettle(); childRect = tester.getRect(find.byKey(childKey)); expect(box.size, equals(const Size(140, 140))); expect(childRect, equals(const Rect.fromLTRB(350, 250, 450, 350))); await buildTest(const VisualDensity(horizontal: -3.0, vertical: -3.0)); await tester.pumpAndSettle(); childRect = tester.getRect(find.byKey(childKey)); expect(box.size, equals(const Size(116, 100))); expect(childRect, equals(const Rect.fromLTRB(350, 250, 450, 350))); await buildTest(VisualDensity.standard, useText: true); await tester.pumpAndSettle(); childRect = tester.getRect(find.byKey(childKey)); expect(box.size, equals(const Size(72, 48))); expect(childRect, equals(const Rect.fromLTRB(372.0, 293.0, 428.0, 307.0))); await buildTest(const VisualDensity(horizontal: 3.0, vertical: 3.0), useText: true); await tester.pumpAndSettle(); childRect = tester.getRect(find.byKey(childKey)); expect(box.size, equals(const Size(96, 60))); expect(childRect, equals(const Rect.fromLTRB(372.0, 293.0, 428.0, 307.0))); await buildTest(const VisualDensity(horizontal: -3.0, vertical: -3.0), useText: true); await tester.pumpAndSettle(); childRect = tester.getRect(find.byKey(childKey)); expect(box.size, equals(const Size(72, 36))); expect(childRect, equals(const Rect.fromLTRB(372.0, 293.0, 428.0, 307.0))); }); group('Default TextButton padding for textScaleFactor, textDirection', () { const buttonKey = ValueKey('button'); const labelKey = ValueKey('label'); const iconKey = ValueKey('icon'); const textScaleFactorOptions = [0.5, 1.0, 1.25, 1.5, 2.0, 2.5, 3.0, 4.0]; const textDirectionOptions = [TextDirection.ltr, TextDirection.rtl]; const iconOptions = [null, Icon(Icons.add, size: 18, key: iconKey)]; // Expected values for each textScaleFactor. final paddingVertical = { 0.5: 8, 1: 8, 1.25: 6, 1.5: 4, 2: 0, 2.5: 0, 3: 0, 4: 0, }; final paddingWithIconGap = { 0.5: 8, 1: 8, 1.25: 7, 1.5: 6, 2: 4, 2.5: 4, 3: 4, 4: 4, }; final textPaddingWithoutIconHorizontal = { 0.5: 8, 1: 8, 1.25: 8, 1.5: 8, 2: 8, 2.5: 6, 3: 4, 4: 4, }; final textPaddingWithIconHorizontal = { 0.5: 8, 1: 8, 1.25: 7, 1.5: 6, 2: 4, 2.5: 4, 3: 4, 4: 4, }; Rect globalBounds(RenderBox renderBox) { final Offset topLeft = renderBox.localToGlobal(Offset.zero); return topLeft & renderBox.size; } /// Computes the padding between two [Rect]s, one inside the other. EdgeInsets paddingBetween({required Rect parent, required Rect child}) { assert(parent.intersect(child) == child); return EdgeInsets.fromLTRB( child.left - parent.left, child.top - parent.top, parent.right - child.right, parent.bottom - child.bottom, ); } for (final textScaleFactor in textScaleFactorOptions) { for (final textDirection in textDirectionOptions) { for (final icon in iconOptions) { final String testName = [ 'TextButton, text scale $textScaleFactor', if (icon != null) 'with icon', if (textDirection == TextDirection.rtl) 'RTL', ].join(', '); testWidgets(testName, (WidgetTester tester) async { await tester.pumpWidget( MaterialApp( theme: ThemeData( useMaterial3: false, colorScheme: const ColorScheme.light(), textButtonTheme: TextButtonThemeData( style: TextButton.styleFrom(minimumSize: const Size(64, 36)), ), ), home: Builder( builder: (BuildContext context) { return MediaQuery.withClampedTextScaling( minScaleFactor: textScaleFactor, maxScaleFactor: textScaleFactor, child: Directionality( textDirection: textDirection, child: Scaffold( body: Center( child: icon == null ? TextButton( key: buttonKey, onPressed: () {}, child: const Text('button', key: labelKey), ) : TextButton.icon( key: buttonKey, onPressed: () {}, icon: icon, label: const Text('button', key: labelKey), ), ), ), ), ); }, ), ), ); final Element paddingElement = tester.element( find.descendant(of: find.byKey(buttonKey), matching: find.byType(Padding)), ); expect(Directionality.of(paddingElement), textDirection); final paddingWidget = paddingElement.widget as Padding; // Compute expected padding, and check. final double expectedPaddingTop = paddingVertical[textScaleFactor]!; final double expectedPaddingBottom = paddingVertical[textScaleFactor]!; final double expectedPaddingStart = icon != null ? textPaddingWithIconHorizontal[textScaleFactor]! : textPaddingWithoutIconHorizontal[textScaleFactor]!; final expectedPaddingEnd = expectedPaddingStart; final EdgeInsets expectedPadding = EdgeInsetsDirectional.fromSTEB( expectedPaddingStart, expectedPaddingTop, expectedPaddingEnd, expectedPaddingBottom, ).resolve(textDirection); expect(paddingWidget.padding.resolve(textDirection), expectedPadding); // Measure padding in terms of the difference between the button and its label child // and check that. final RenderBox labelRenderBox = tester.renderObject(find.byKey(labelKey)); final Rect labelBounds = globalBounds(labelRenderBox); final RenderBox? iconRenderBox = icon == null ? null : tester.renderObject(find.byKey(iconKey)); final Rect? iconBounds = icon == null ? null : globalBounds(iconRenderBox!); final Rect childBounds = icon == null ? labelBounds : labelBounds.expandToInclude(iconBounds!); // We measure the `InkResponse` descendant of the button // element, because the button has a larger `RenderBox` // which accommodates the minimum tap target with a height // of 48. final RenderBox buttonRenderBox = tester.renderObject( find.descendant( of: find.byKey(buttonKey), matching: find.byWidgetPredicate((Widget widget) => widget is InkResponse), ), ); final Rect buttonBounds = globalBounds(buttonRenderBox); final EdgeInsets visuallyMeasuredPadding = paddingBetween( parent: buttonBounds, child: childBounds, ); // Since there is a requirement of a minimum width of 64 // and a minimum height of 36 on material buttons, the visual // padding of smaller buttons may not match their settings. // Therefore, we only test buttons that are large enough. if (buttonBounds.width > 64) { expect(visuallyMeasuredPadding.left, expectedPadding.left); expect(visuallyMeasuredPadding.right, expectedPadding.right); } if (buttonBounds.height > 36) { expect(visuallyMeasuredPadding.top, expectedPadding.top); expect(visuallyMeasuredPadding.bottom, expectedPadding.bottom); } // Check the gap between the icon and the label if (icon != null) { final double gapWidth = textDirection == TextDirection.ltr ? labelBounds.left - iconBounds!.right : iconBounds!.left - labelBounds.right; expect(gapWidth, paddingWithIconGap[textScaleFactor]); } // Check the text's height - should be consistent with the textScaleFactor. final RenderBox textRenderObject = tester.renderObject( find.descendant( of: find.byKey(labelKey), matching: find.byElementPredicate((Element element) => element.widget is RichText), ), ); final double textHeight = textRenderObject.paintBounds.size.height; final double expectedTextHeight = 14 * textScaleFactor; expect(textHeight, moreOrLessEquals(expectedTextHeight, epsilon: 0.5)); }); } } } }); testWidgets('Override TextButton default padding', (WidgetTester tester) async { await tester.pumpWidget( MaterialApp( theme: ThemeData.from(colorScheme: const ColorScheme.light()), home: Builder( builder: (BuildContext context) { return MediaQuery.withClampedTextScaling( minScaleFactor: 2, maxScaleFactor: 2, child: Scaffold( body: Center( child: TextButton( style: TextButton.styleFrom(padding: const EdgeInsets.all(22)), onPressed: () {}, child: const Text('TextButton'), ), ), ), ); }, ), ), ); final Padding paddingWidget = tester.widget( find.descendant(of: find.byType(TextButton), matching: find.byType(Padding)), ); expect(paddingWidget.padding, const EdgeInsets.all(22)); }); testWidgets('Override theme fontSize changes padding', (WidgetTester tester) async { await tester.pumpWidget( MaterialApp( theme: ThemeData.from( colorScheme: const ColorScheme.light(), textTheme: const TextTheme(labelLarge: TextStyle(fontSize: 28.0)), ), home: Builder( builder: (BuildContext context) { return Scaffold( body: Center( child: TextButton(onPressed: () {}, child: const Text('text')), ), ); }, ), ), ); final Padding paddingWidget = tester.widget( find.descendant(of: find.byType(TextButton), matching: find.byType(Padding)), ); expect(paddingWidget.padding, const EdgeInsets.symmetric(horizontal: 8)); }); testWidgets('M3 TextButton has correct default padding', (WidgetTester tester) async { final Key key = UniqueKey(); await tester.pumpWidget( MaterialApp( theme: ThemeData.from(colorScheme: const ColorScheme.light()), home: Scaffold( body: Center( child: TextButton(key: key, onPressed: () {}, child: const Text('TextButton')), ), ), ), ); final Padding paddingWidget = tester.widget( find.descendant(of: find.byKey(key), matching: find.byType(Padding)), ); expect(paddingWidget.padding, const EdgeInsets.symmetric(horizontal: 12, vertical: 8)); }); testWidgets('M3 TextButton.icon has correct default padding', (WidgetTester tester) async { final Key key = UniqueKey(); await tester.pumpWidget( MaterialApp( theme: ThemeData.from(colorScheme: const ColorScheme.light()), home: Scaffold( body: Center( child: TextButton.icon( key: key, onPressed: () {}, icon: const Icon(Icons.add), label: const Text('TextButton'), ), ), ), ), ); final Padding paddingWidget = tester.widget( find.descendant(of: find.byKey(key), matching: find.byType(Padding)), ); expect(paddingWidget.padding, const EdgeInsetsDirectional.fromSTEB(12, 8, 16, 8)); }); testWidgets('Fixed size TextButtons', (WidgetTester tester) async { await tester.pumpWidget( MaterialApp( home: Scaffold( body: Column( mainAxisSize: MainAxisSize.min, children: [ TextButton( style: TextButton.styleFrom(fixedSize: const Size(100, 100)), onPressed: () {}, child: const Text('100x100'), ), TextButton( style: TextButton.styleFrom(fixedSize: const Size.fromWidth(200)), onPressed: () {}, child: const Text('200xh'), ), TextButton( style: TextButton.styleFrom(fixedSize: const Size.fromHeight(200)), onPressed: () {}, child: const Text('wx200'), ), ], ), ), ), ); expect(tester.getSize(find.widgetWithText(TextButton, '100x100')), const Size(100, 100)); expect(tester.getSize(find.widgetWithText(TextButton, '200xh')).width, 200); expect(tester.getSize(find.widgetWithText(TextButton, 'wx200')).height, 200); }); testWidgets('TextButton with NoSplash splashFactory paints nothing', (WidgetTester tester) async { Widget buildFrame({InteractiveInkFeatureFactory? splashFactory}) { return MaterialApp( home: Scaffold( body: Center( child: TextButton( style: TextButton.styleFrom(splashFactory: splashFactory), onPressed: () {}, child: const Text('test'), ), ), ), ); } // NoSplash.splashFactory, no splash circles drawn await tester.pumpWidget(buildFrame(splashFactory: NoSplash.splashFactory)); { final TestGesture gesture = await tester.startGesture(tester.getCenter(find.text('test'))); final MaterialInkController material = Material.of(tester.element(find.text('test'))); await tester.pump(const Duration(milliseconds: 200)); expect(material, paintsExactlyCountTimes(#drawCircle, 0)); await gesture.up(); await tester.pumpAndSettle(); } // InkRipple.splashFactory, one splash circle drawn. await tester.pumpWidget(buildFrame(splashFactory: InkRipple.splashFactory)); { final TestGesture gesture = await tester.startGesture(tester.getCenter(find.text('test'))); final MaterialInkController material = Material.of(tester.element(find.text('test'))); await tester.pump(const Duration(milliseconds: 200)); expect(material, paintsExactlyCountTimes(#drawCircle, 1)); await gesture.up(); await tester.pumpAndSettle(); } }); testWidgets( 'TextButton uses InkSparkle only for Android non-web when useMaterial3 is true', (WidgetTester tester) async { final theme = ThemeData(); await tester.pumpWidget( MaterialApp( theme: theme, home: Center( child: TextButton(onPressed: () {}, child: const Text('button')), ), ), ); final InkWell buttonInkWell = tester.widget( find.descendant(of: find.byType(TextButton), matching: find.byType(InkWell)), ); if (debugDefaultTargetPlatformOverride! == TargetPlatform.android && !kIsWeb) { expect(buttonInkWell.splashFactory, equals(InkSparkle.splashFactory)); } else { expect(buttonInkWell.splashFactory, equals(InkRipple.splashFactory)); } }, variant: TargetPlatformVariant.all(), ); testWidgets('TextButton uses InkRipple when useMaterial3 is false', (WidgetTester tester) async { final theme = ThemeData(useMaterial3: false); await tester.pumpWidget( MaterialApp( theme: theme, home: Center( child: TextButton(onPressed: () {}, child: const Text('button')), ), ), ); final InkWell buttonInkWell = tester.widget( find.descendant(of: find.byType(TextButton), matching: find.byType(InkWell)), ); expect(buttonInkWell.splashFactory, equals(InkRipple.splashFactory)); }, variant: TargetPlatformVariant.all()); testWidgets('TextButton.icon does not overflow', (WidgetTester tester) async { // Regression test for https://github.com/flutter/flutter/issues/77815 await tester.pumpWidget( MaterialApp( home: Scaffold( body: SizedBox( width: 200, child: TextButton.icon( onPressed: () {}, icon: const Icon(Icons.add), label: const Text( // Much wider than 200 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut a euismod nibh. Morbi laoreet purus.', ), ), ), ), ), ); expect(tester.takeException(), null); }); testWidgets('TextButton.icon icon,label layout', (WidgetTester tester) async { final Key buttonKey = UniqueKey(); final Key iconKey = UniqueKey(); final Key labelKey = UniqueKey(); final ButtonStyle style = TextButton.styleFrom( padding: EdgeInsets.zero, visualDensity: VisualDensity.standard, // dx=0, dy=0 ); await tester.pumpWidget( MaterialApp( home: Scaffold( body: SizedBox( width: 200, child: TextButton.icon( key: buttonKey, style: style, onPressed: () {}, icon: SizedBox(key: iconKey, width: 50, height: 100), label: SizedBox(key: labelKey, width: 50, height: 100), ), ), ), ), ); // The button's label and icon are separated by a gap of 8: // 46 [icon 50] 8 [label 50] 46 // The overall button width is 200. So: // icon.x = 46 // label.x = 46 + 50 + 8 = 104 expect(tester.getRect(find.byKey(buttonKey)), const Rect.fromLTRB(0.0, 0.0, 200.0, 100.0)); expect(tester.getRect(find.byKey(iconKey)), const Rect.fromLTRB(46.0, 0.0, 96.0, 100.0)); expect(tester.getRect(find.byKey(labelKey)), const Rect.fromLTRB(104.0, 0.0, 154.0, 100.0)); }); testWidgets('TextButton maximumSize', (WidgetTester tester) async { final Key key0 = UniqueKey(); final Key key1 = UniqueKey(); await tester.pumpWidget( MaterialApp( theme: ThemeData(useMaterial3: false), home: Scaffold( body: Center( child: Column( mainAxisSize: MainAxisSize.min, children: [ TextButton( key: key0, style: TextButton.styleFrom( minimumSize: const Size(24, 36), maximumSize: const Size.fromWidth(64), ), onPressed: () {}, child: const Text('A B C D E F G H I J K L M N O P'), ), TextButton.icon( key: key1, style: TextButton.styleFrom( minimumSize: const Size(24, 36), maximumSize: const Size.fromWidth(104), ), onPressed: () {}, icon: Container(color: Colors.red, width: 32, height: 32), label: const Text('A B C D E F G H I J K L M N O P'), ), ], ), ), ), ), ); expect(tester.getSize(find.byKey(key0)), const Size(64.0, 128.0)); expect(tester.getSize(find.byKey(key1)), const Size(104.0, 128.0)); }); testWidgets('Fixed size TextButton, same as minimumSize == maximumSize', ( WidgetTester tester, ) async { await tester.pumpWidget( MaterialApp( home: Scaffold( body: Column( mainAxisSize: MainAxisSize.min, children: [ TextButton( style: TextButton.styleFrom(fixedSize: const Size(200, 200)), onPressed: () {}, child: const Text('200x200'), ), TextButton( style: TextButton.styleFrom( minimumSize: const Size(200, 200), maximumSize: const Size(200, 200), ), onPressed: () {}, child: const Text('200,200'), ), ], ), ), ), ); expect(tester.getSize(find.widgetWithText(TextButton, '200x200')), const Size(200, 200)); expect(tester.getSize(find.widgetWithText(TextButton, '200,200')), const Size(200, 200)); }); testWidgets('TextButton changes mouse cursor when hovered', (WidgetTester tester) async { await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: MouseRegion( cursor: SystemMouseCursors.forbidden, child: TextButton( style: TextButton.styleFrom( enabledMouseCursor: SystemMouseCursors.text, disabledMouseCursor: SystemMouseCursors.grab, ), onPressed: () {}, child: const Text('button'), ), ), ), ); final TestGesture gesture = await tester.createGesture( kind: PointerDeviceKind.mouse, pointer: 1, ); await gesture.addPointer(location: Offset.zero); await tester.pump(); expect( RendererBinding.instance.mouseTracker.debugDeviceActiveCursor(1), SystemMouseCursors.text, ); // Test cursor when disabled await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: MouseRegion( cursor: SystemMouseCursors.forbidden, child: TextButton( style: TextButton.styleFrom( enabledMouseCursor: SystemMouseCursors.text, disabledMouseCursor: SystemMouseCursors.grab, ), onPressed: null, child: const Text('button'), ), ), ), ); expect( RendererBinding.instance.mouseTracker.debugDeviceActiveCursor(1), SystemMouseCursors.grab, ); // Test default cursor await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: MouseRegion( cursor: SystemMouseCursors.forbidden, child: TextButton(onPressed: () {}, child: const Text('button')), ), ), ); expect( RendererBinding.instance.mouseTracker.debugDeviceActiveCursor(1), kIsWeb ? SystemMouseCursors.click : SystemMouseCursors.basic, ); // Test default cursor when disabled await tester.pumpWidget( const Directionality( textDirection: TextDirection.ltr, child: MouseRegion( cursor: SystemMouseCursors.forbidden, child: TextButton(onPressed: null, child: Text('button')), ), ), ); expect( RendererBinding.instance.mouseTracker.debugDeviceActiveCursor(1), SystemMouseCursors.basic, ); }); testWidgets('TextButton in SelectionArea changes mouse cursor when hovered', ( WidgetTester tester, ) async { // Regression test for https://github.com/flutter/flutter/issues/104595. await tester.pumpWidget( MaterialApp( home: SelectionArea( child: TextButton( style: TextButton.styleFrom( enabledMouseCursor: SystemMouseCursors.click, disabledMouseCursor: SystemMouseCursors.grab, ), onPressed: () {}, child: const Text('button'), ), ), ), ); final TestGesture gesture = await tester.createGesture( kind: PointerDeviceKind.mouse, pointer: 1, ); await gesture.addPointer(location: tester.getCenter(find.byType(Text))); await tester.pump(); expect( RendererBinding.instance.mouseTracker.debugDeviceActiveCursor(1), SystemMouseCursors.click, ); }); testWidgets('TextButton.styleFrom can be used to set foreground and background colors', ( WidgetTester tester, ) async { await tester.pumpWidget( MaterialApp( home: Scaffold( body: TextButton( style: TextButton.styleFrom( foregroundColor: Colors.white, backgroundColor: Colors.purple, ), onPressed: () {}, child: const Text('button'), ), ), ), ); final Material material = tester.widget( find.descendant(of: find.byType(TextButton), matching: find.byType(Material)), ); expect(material.color, Colors.purple); expect(material.textStyle!.color, Colors.white); }); Future testStatesController(Widget? icon, WidgetTester tester) async { var count = 0; void valueChanged() { count += 1; } final controller = MaterialStatesController(); addTearDown(controller.dispose); controller.addListener(valueChanged); await tester.pumpWidget( MaterialApp( home: Center( child: icon == null ? TextButton( statesController: controller, onPressed: () {}, child: const Text('button'), ) : TextButton.icon( statesController: controller, onPressed: () {}, icon: icon, label: const Text('button'), ), ), ), ); expect(controller.value, {}); expect(count, 0); final Offset center = tester.getCenter(find.byType(Text)); final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.mouse); await gesture.addPointer(); await gesture.moveTo(center); await tester.pumpAndSettle(); expect(controller.value, {WidgetState.hovered}); expect(count, 1); await gesture.moveTo(Offset.zero); await tester.pumpAndSettle(); expect(controller.value, {}); expect(count, 2); await gesture.moveTo(center); await tester.pumpAndSettle(); expect(controller.value, {WidgetState.hovered}); expect(count, 3); await gesture.down(center); await tester.pumpAndSettle(); expect(controller.value, {WidgetState.hovered, WidgetState.pressed}); expect(count, 4); await gesture.up(); await tester.pumpAndSettle(); expect(controller.value, {WidgetState.hovered}); expect(count, 5); await gesture.moveTo(Offset.zero); await tester.pumpAndSettle(); expect(controller.value, {}); expect(count, 6); await gesture.down(center); await tester.pumpAndSettle(); expect(controller.value, {WidgetState.hovered, WidgetState.pressed}); expect(count, 8); // adds hovered and pressed - two changes // If the button is rebuilt disabled, then the pressed state is // removed. await tester.pumpWidget( MaterialApp( home: Center( child: icon == null ? TextButton( statesController: controller, onPressed: null, child: const Text('button'), ) : TextButton.icon( statesController: controller, onPressed: null, icon: icon, label: const Text('button'), ), ), ), ); await tester.pumpAndSettle(); expect(controller.value, {WidgetState.hovered, WidgetState.disabled}); expect(count, 10); // removes pressed and adds disabled - two changes await gesture.moveTo(Offset.zero); await tester.pumpAndSettle(); expect(controller.value, {WidgetState.disabled}); expect(count, 11); await gesture.removePointer(); } testWidgets('TextButton statesController', (WidgetTester tester) async { testStatesController(null, tester); }); testWidgets('TextButton.icon statesController', (WidgetTester tester) async { testStatesController(const Icon(Icons.add), tester); }); testWidgets('Disabled TextButton statesController', (WidgetTester tester) async { var count = 0; void valueChanged() { count += 1; } final controller = MaterialStatesController(); addTearDown(controller.dispose); controller.addListener(valueChanged); await tester.pumpWidget( MaterialApp( home: Center( child: TextButton( statesController: controller, onPressed: null, child: const Text('button'), ), ), ), ); expect(controller.value, {WidgetState.disabled}); expect(count, 1); }); testWidgets('icon color can be different from the text color', (WidgetTester tester) async { final Key iconButtonKey = UniqueKey(); const colorScheme = ColorScheme.light(); final theme = ThemeData.from(colorScheme: colorScheme); await tester.pumpWidget( MaterialApp( theme: theme, home: Center( child: TextButton.icon( key: iconButtonKey, style: TextButton.styleFrom(iconColor: Colors.red), icon: const Icon(Icons.add), onPressed: () {}, label: const Text('button'), ), ), ), ); Finder buttonMaterial = find.descendant( of: find.byKey(iconButtonKey), matching: find.byType(Material), ); Material material = tester.widget(buttonMaterial); expect(material.textStyle!.color, colorScheme.primary); expect(iconStyle(tester, Icons.add).color, equals(Colors.red)); // disabled button await tester.pumpWidget( MaterialApp( theme: theme, home: Center( child: TextButton.icon( key: iconButtonKey, style: TextButton.styleFrom(iconColor: Colors.red, disabledIconColor: Colors.blue), icon: const Icon(Icons.add), onPressed: null, label: const Text('button'), ), ), ), ); await tester.pumpAndSettle(); buttonMaterial = find.descendant( of: find.byKey(iconButtonKey), matching: find.byType(Material), ); material = tester.widget(buttonMaterial); expect(material.textStyle!.color, colorScheme.onSurface.withOpacity(0.38)); expect(iconStyle(tester, Icons.add).color, equals(Colors.blue)); }); testWidgets("TextButton.styleFrom doesn't throw exception on passing only one cursor", ( WidgetTester tester, ) async { // This is a regression test for https://github.com/flutter/flutter/issues/118071. await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: TextButton( style: TextButton.styleFrom(enabledMouseCursor: SystemMouseCursors.text), onPressed: () {}, child: const Text('button'), ), ), ); expect(tester.takeException(), isNull); }); testWidgets('TextButton backgroundBuilder and foregroundBuilder', (WidgetTester tester) async { const backgroundColor = Color(0xFF000011); const foregroundColor = Color(0xFF000022); await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: TextButton( style: TextButton.styleFrom( backgroundBuilder: (BuildContext context, Set states, Widget? child) { return DecoratedBox( decoration: const BoxDecoration(color: backgroundColor), child: child, ); }, foregroundBuilder: (BuildContext context, Set states, Widget? child) { return DecoratedBox( decoration: const BoxDecoration(color: foregroundColor), child: child, ); }, ), onPressed: () {}, child: const Text('button'), ), ), ); BoxDecoration boxDecorationOf(Finder finder) { return tester.widget(finder).decoration as BoxDecoration; } final Finder decorations = find.descendant( of: find.byType(TextButton), matching: find.byType(DecoratedBox), ); expect(boxDecorationOf(decorations.at(0)).color, backgroundColor); expect(boxDecorationOf(decorations.at(1)).color, foregroundColor); Text textChildOf(Finder finder) { return tester.widget(find.descendant(of: finder, matching: find.byType(Text))); } expect(textChildOf(decorations.at(0)).data, 'button'); expect(textChildOf(decorations.at(1)).data, 'button'); }); testWidgets( 'TextButton backgroundBuilder drops button child and foregroundBuilder return value', (WidgetTester tester) async { const backgroundColor = Color(0xFF000011); const foregroundColor = Color(0xFF000022); await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: TextButton( style: TextButton.styleFrom( backgroundBuilder: (BuildContext context, Set states, Widget? child) { return const DecoratedBox(decoration: BoxDecoration(color: backgroundColor)); }, foregroundBuilder: (BuildContext context, Set states, Widget? child) { return const DecoratedBox(decoration: BoxDecoration(color: foregroundColor)); }, ), onPressed: () {}, child: const Text('button'), ), ), ); final Finder background = find.descendant( of: find.byType(TextButton), matching: find.byType(DecoratedBox), ); expect(background, findsOneWidget); expect(find.text('button'), findsNothing); }, ); testWidgets('TextButton foregroundBuilder drops button child', (WidgetTester tester) async { const foregroundColor = Color(0xFF000022); await tester.pumpWidget( Directionality( textDirection: TextDirection.ltr, child: TextButton( style: TextButton.styleFrom( foregroundBuilder: (BuildContext context, Set states, Widget? child) { return const DecoratedBox(decoration: BoxDecoration(color: foregroundColor)); }, ), onPressed: () {}, child: const Text('button'), ), ), ); final Finder foreground = find.descendant( of: find.byType(TextButton), matching: find.byType(DecoratedBox), ); expect(foreground, findsOneWidget); expect(find.text('button'), findsNothing); }); testWidgets('TextButton foreground and background builders are applied to the correct states', ( WidgetTester tester, ) async { var foregroundStates = {}; var backgroundStates = {}; final focusNode = FocusNode(); await tester.pumpWidget( MaterialApp( home: Scaffold( body: Center( child: TextButton( style: ButtonStyle( backgroundBuilder: (BuildContext context, Set states, Widget? child) { backgroundStates = states; return child!; }, foregroundBuilder: (BuildContext context, Set states, Widget? child) { foregroundStates = states; return child!; }, ), onPressed: () {}, focusNode: focusNode, child: const Text('button'), ), ), ), ), ); // Default. expect(backgroundStates.isEmpty, isTrue); expect(foregroundStates.isEmpty, isTrue); const focusedStates = {WidgetState.focused}; const focusedHoveredStates = {WidgetState.focused, WidgetState.hovered}; const focusedHoveredPressedStates = { WidgetState.focused, WidgetState.hovered, WidgetState.pressed, }; bool sameStates(Set expectedValue, Set actualValue) { return expectedValue.difference(actualValue).isEmpty && actualValue.difference(expectedValue).isEmpty; } // Focused. focusNode.requestFocus(); await tester.pumpAndSettle(); expect(sameStates(focusedStates, backgroundStates), isTrue); expect(sameStates(focusedStates, foregroundStates), isTrue); // Hovered. final Offset center = tester.getCenter(find.byType(TextButton)); final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.mouse); await gesture.addPointer(); await gesture.moveTo(center); await tester.pumpAndSettle(); expect(sameStates(focusedHoveredStates, backgroundStates), isTrue); expect(sameStates(focusedHoveredStates, foregroundStates), isTrue); // Highlighted (pressed). await gesture.down(center); await tester.pump(); // Start the splash and highlight animations. await tester.pump( const Duration(milliseconds: 800), ); // Wait for splash and highlight to be well under way. expect(sameStates(focusedHoveredPressedStates, backgroundStates), isTrue); expect(sameStates(focusedHoveredPressedStates, foregroundStates), isTrue); focusNode.dispose(); }); testWidgets('TextButton styleFrom backgroundColor special case', (WidgetTester tester) async { // Regression test for an internal Google issue: b/323399158 const backgroundColor = Color(0xFF000022); Widget buildFrame({VoidCallback? onPressed}) { return Directionality( textDirection: TextDirection.ltr, child: TextButton( style: TextButton.styleFrom(backgroundColor: backgroundColor), onPressed: () {}, child: const Text('button'), ), ); } await tester.pumpWidget(buildFrame(onPressed: () {})); // enabled final Material material = tester.widget( find.descendant(of: find.byType(TextButton), matching: find.byType(Material)), ); expect(material.color, backgroundColor); await tester.pumpWidget(buildFrame()); // onPressed: null - disabled expect(material.color, backgroundColor); }); testWidgets('Default TextButton icon alignment', (WidgetTester tester) async { Widget buildWidget({required TextDirection textDirection}) { return MaterialApp( home: Directionality( textDirection: textDirection, child: Center( child: TextButton.icon( onPressed: () {}, icon: const Icon(Icons.add), label: const Text('button'), ), ), ), ); } // Test default iconAlignment when textDirection is ltr. await tester.pumpWidget(buildWidget(textDirection: TextDirection.ltr)); final Offset buttonTopLeft = tester.getTopLeft(find.byType(Material).last); final Offset iconTopLeft = tester.getTopLeft(find.byIcon(Icons.add)); // The icon is aligned to the left of the button. expect(buttonTopLeft.dx, iconTopLeft.dx - 12.0); // 12.0 - padding between icon and button edge. // Test default iconAlignment when textDirection is rtl. await tester.pumpWidget(buildWidget(textDirection: TextDirection.rtl)); final Offset buttonTopRight = tester.getTopRight(find.byType(Material).last); final Offset iconTopRight = tester.getTopRight(find.byIcon(Icons.add)); // The icon is aligned to the right of the button. expect( buttonTopRight.dx, iconTopRight.dx + 12.0, ); // 12.0 - padding between icon and button edge. }); testWidgets('TextButton icon alignment can be customized', (WidgetTester tester) async { Widget buildWidget({ required TextDirection textDirection, required IconAlignment iconAlignment, }) { return MaterialApp( home: Directionality( textDirection: textDirection, child: Center( child: TextButton.icon( onPressed: () {}, icon: const Icon(Icons.add), label: const Text('button'), iconAlignment: iconAlignment, ), ), ), ); } // Test iconAlignment when textDirection is ltr. await tester.pumpWidget( buildWidget(textDirection: TextDirection.ltr, iconAlignment: IconAlignment.start), ); Offset buttonTopLeft = tester.getTopLeft(find.byType(Material).last); Offset iconTopLeft = tester.getTopLeft(find.byIcon(Icons.add)); // The icon is aligned to the left of the button. expect(buttonTopLeft.dx, iconTopLeft.dx - 12.0); // 12.0 - padding between icon and button edge. // Test iconAlignment when textDirection is ltr. await tester.pumpWidget( buildWidget(textDirection: TextDirection.ltr, iconAlignment: IconAlignment.end), ); Offset buttonTopRight = tester.getTopRight(find.byType(Material).last); Offset iconTopRight = tester.getTopRight(find.byIcon(Icons.add)); // The icon is aligned to the right of the button. expect( buttonTopRight.dx, iconTopRight.dx + 16.0, ); // 16.0 - padding between icon and button edge. // Test iconAlignment when textDirection is rtl. await tester.pumpWidget( buildWidget(textDirection: TextDirection.rtl, iconAlignment: IconAlignment.start), ); buttonTopRight = tester.getTopRight(find.byType(Material).last); iconTopRight = tester.getTopRight(find.byIcon(Icons.add)); // The icon is aligned to the right of the button. expect( buttonTopRight.dx, iconTopRight.dx + 12.0, ); // 12.0 - padding between icon and button edge. // Test iconAlignment when textDirection is rtl. await tester.pumpWidget( buildWidget(textDirection: TextDirection.rtl, iconAlignment: IconAlignment.end), ); buttonTopLeft = tester.getTopLeft(find.byType(Material).last); iconTopLeft = tester.getTopLeft(find.byIcon(Icons.add)); // The icon is aligned to the left of the button. expect(buttonTopLeft.dx, iconTopLeft.dx - 16.0); // 16.0 - padding between icon and button edge. }); testWidgets('TextButton icon alignment respects ButtonStyle.iconAlignment', ( WidgetTester tester, ) async { Widget buildButton({IconAlignment? iconAlignment}) { return MaterialApp( home: Center( child: TextButton.icon( style: ButtonStyle(iconAlignment: iconAlignment), onPressed: () {}, icon: const Icon(Icons.add), label: const Text('button'), ), ), ); } await tester.pumpWidget(buildButton()); final Offset buttonTopLeft = tester.getTopLeft(find.byType(Material).last); final Offset iconTopLeft = tester.getTopLeft(find.byIcon(Icons.add)); expect(buttonTopLeft.dx, iconTopLeft.dx - 12.0); await tester.pumpWidget(buildButton(iconAlignment: IconAlignment.end)); final Offset buttonTopRight = tester.getTopRight(find.byType(Material).last); final Offset iconTopRight = tester.getTopRight(find.byIcon(Icons.add)); expect(buttonTopRight.dx, iconTopRight.dx + 16.0); }); testWidgets('treats a hovering stylus like a mouse', (WidgetTester tester) async { final focusNode = FocusNode(); addTearDown(focusNode.dispose); final theme = ThemeData(); var hasBeenHovered = false; await tester.pumpWidget( MaterialApp( theme: theme, home: Scaffold( body: Center( child: Builder( builder: (BuildContext context) { return TextButton( onPressed: () {}, onHover: (bool entered) { hasBeenHovered = true; }, focusNode: focusNode, child: const Text('TextButton'), ); }, ), ), ), ), ); RenderObject overlayColor() { return tester.allRenderObjects.firstWhere( (RenderObject object) => object.runtimeType.toString() == '_RenderInkFeatures', ); } final Offset center = tester.getCenter(find.byType(TextButton)); final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.stylus); await gesture.addPointer(); await tester.pumpAndSettle(); expect(hasBeenHovered, isFalse); await gesture.moveTo(center); await tester.pumpAndSettle(); expect(overlayColor(), paints..rect(color: theme.colorScheme.primary.withOpacity(0.08))); expect(hasBeenHovered, isTrue); }); // Regression test for https://github.com/flutter/flutter/issues/154798. testWidgets('TextButton.styleFrom can customize the button icon', (WidgetTester tester) async { const iconColor = Color(0xFFF000FF); const iconSize = 32.0; const disabledIconColor = Color(0xFFFFF000); Widget buildButton({bool enabled = true}) { return MaterialApp( home: Material( child: Center( child: TextButton.icon( style: TextButton.styleFrom( iconColor: iconColor, iconSize: iconSize, iconAlignment: IconAlignment.end, disabledIconColor: disabledIconColor, ), onPressed: enabled ? () {} : null, icon: const Icon(Icons.add), label: const Text('Button'), ), ), ), ); } // Test enabled button. await tester.pumpWidget(buildButton()); expect(tester.getSize(find.byIcon(Icons.add)), const Size(iconSize, iconSize)); expect(iconStyle(tester, Icons.add).color, iconColor); // Test disabled button. await tester.pumpWidget(buildButton(enabled: false)); await tester.pumpAndSettle(); expect(iconStyle(tester, Icons.add).color, disabledIconColor); final Offset buttonTopRight = tester.getTopRight(find.byType(Material).last); final Offset iconTopRight = tester.getTopRight(find.byIcon(Icons.add)); expect(buttonTopRight.dx, iconTopRight.dx + 16.0); }); // Regression test for https://github.com/flutter/flutter/issues/162839. testWidgets('TextButton icon uses provided foregroundColor over default icon color', ( WidgetTester tester, ) async { const foregroundColor = Color(0xFFFF1234); await tester.pumpWidget( MaterialApp( home: Material( child: Center( child: TextButton.icon( style: TextButton.styleFrom(foregroundColor: foregroundColor), onPressed: () {}, icon: const Icon(Icons.add), label: const Text('Button'), ), ), ), ), ); expect(iconStyle(tester, Icons.add).color, foregroundColor); }); testWidgets('TextButton text and icon respect animation duration', (WidgetTester tester) async { const buttonText = 'Button'; const IconData buttonIcon = Icons.add; const hoveredColor = Color(0xFFFF0000); const idleColor = Color(0xFF000000); Widget buildButton({Duration? animationDuration}) { return MaterialApp( home: Material( child: Center( child: TextButton.icon( style: ButtonStyle( animationDuration: animationDuration, iconColor: const WidgetStateProperty.fromMap({ WidgetState.hovered: hoveredColor, WidgetState.any: idleColor, }), foregroundColor: const WidgetStateProperty.fromMap( { WidgetState.hovered: hoveredColor, WidgetState.any: idleColor, }, ), ), onPressed: () {}, icon: const Icon(buttonIcon), label: const Text(buttonText), ), ), ), ); } // Test default animation duration. await tester.pumpWidget(buildButton()); expect(textColor(tester, buttonText), idleColor); expect(iconStyle(tester, buttonIcon).color, idleColor); final Offset buttonCenter = tester.getCenter(find.text(buttonText)); final TestGesture gesture = await tester.createGesture(kind: PointerDeviceKind.mouse); await gesture.addPointer(); addTearDown(gesture.removePointer); await gesture.moveTo(buttonCenter); await tester.pump(); await tester.pump(const Duration(milliseconds: 100)); expect(textColor(tester, buttonText), hoveredColor.withValues(red: 0.5)); expect(iconStyle(tester, buttonIcon).color, hoveredColor.withValues(red: 0.5)); await tester.pump(); await tester.pump(const Duration(milliseconds: 200)); expect(textColor(tester, buttonText), hoveredColor); expect(iconStyle(tester, buttonIcon).color, hoveredColor); await gesture.removePointer(); // Test custom animation duration. await tester.pumpWidget(buildButton(animationDuration: const Duration(seconds: 2))); await tester.pumpAndSettle(); await gesture.moveTo(buttonCenter); await tester.pump(); await tester.pump(const Duration(seconds: 1)); expect(textColor(tester, buttonText), hoveredColor.withValues(red: 0.5)); expect(iconStyle(tester, buttonIcon).color, hoveredColor.withValues(red: 0.5)); await tester.pump(); await tester.pump(const Duration(seconds: 1)); expect(textColor(tester, buttonText), hoveredColor); expect(iconStyle(tester, buttonIcon).color, hoveredColor); }); // Regression test for https://github.com/flutter/flutter/issues/173944. testWidgets('TextButton.icon does not lose focus when icon is nullified', ( WidgetTester tester, ) async { Widget buildTextButton({required Widget? icon}) { return MaterialApp( home: Center( child: TextButton.icon(onPressed: () {}, icon: icon, label: const Text('button')), ), ); } // Build once with an icon. await tester.pumpWidget(buildTextButton(icon: const Icon(Icons.abc))); FocusNode getButtonFocusNode() { return Focus.of(tester.element(find.text('button'))); } getButtonFocusNode().requestFocus(); await tester.pumpAndSettle(); expect(getButtonFocusNode().hasFocus, true); // Rebuild without icon. await tester.pumpWidget(buildTextButton(icon: null)); // The button should still be focused. expect(getButtonFocusNode().hasFocus, true); }); testWidgets('TextButton does not crash at zero area', (WidgetTester tester) async { await tester.pumpWidget( MaterialApp( home: Center( child: SizedBox.shrink( child: TextButton(onPressed: () {}, child: const Text('X')), ), ), ), ); expect(tester.getSize(find.byType(TextButton)), Size.zero); }); }