// 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 'dart:math' as math; import 'dart:ui' show lerpDouble; import 'package:flutter/foundation.dart'; import 'package:flutter/widgets.dart'; import 'button_style.dart'; import 'button_style_button.dart'; import 'color_scheme.dart'; import 'colors.dart'; import 'constants.dart'; import 'ink_ripple.dart'; import 'ink_well.dart'; import 'material_state.dart'; import 'outlined_button_theme.dart'; import 'theme.dart'; import 'theme_data.dart'; /// A Material Design "Outlined Button"; essentially a [TextButton] /// with an outlined border. /// /// Outlined buttons are medium-emphasis buttons. They contain actions /// that are important, but they aren’t the primary action in an app. /// /// An outlined button is a label [child] displayed on a (zero /// elevation) [Material] widget. The label's [Text] and [Icon] /// widgets are displayed in the [style]'s /// [ButtonStyle.foregroundColor] and the outline's weight and color /// are defined by [ButtonStyle.side]. The button reacts to touches /// by filling with the [style]'s [ButtonStyle.overlayColor]. /// /// The outlined button's default style is defined by [defaultStyleOf]. /// The style of this outline button can be overridden with its [style] /// parameter. The style of all text buttons in a subtree can be /// overridden with the [OutlinedButtonTheme] and the style of all of the /// outlined buttons in an app can be overridden with the [Theme]'s /// [ThemeData.outlinedButtonTheme] property. /// /// Unlike [TextButton] or [ElevatedButton], outline buttons have a /// default [ButtonStyle.side] which defines the appearance of the /// outline. Because the default `side` is non-null, it /// unconditionally overrides the shape's [OutlinedBorder.side]. In /// other words, to specify an outlined button's shape _and_ the /// appearance of its outline, both the [ButtonStyle.shape] and /// [ButtonStyle.side] properties must be specified. /// /// {@tool dartpad} /// Here is an example of a basic [OutlinedButton]. /// /// ** See code in examples/api/lib/material/outlined_button/outlined_button.0.dart ** /// {@end-tool} /// /// The static [styleFrom] method is a convenient way to create a /// outlined button [ButtonStyle] from simple values. /// /// See also: /// /// * [ElevatedButton], a filled button whose material elevates when pressed. /// * [FilledButton], a filled button that doesn't elevate when pressed. /// * [FilledButton.tonal], a filled button variant that uses a secondary fill color. /// * [TextButton], a button with no outline or fill color. /// * <https://material.io/design/components/buttons.html> /// * <https://m3.material.io/components/buttons> class OutlinedButton extends ButtonStyleButton { /// Create an OutlinedButton. /// /// The [autofocus] and [clipBehavior] arguments must not be null. const OutlinedButton({ super.key, required super.onPressed, super.onLongPress, super.onHover, super.onFocusChange, super.style, super.focusNode, super.autofocus = false, super.clipBehavior = Clip.none, super.statesController, required super.child, }); /// Create a text button from a pair of widgets that serve as the button's /// [icon] and [label]. /// /// The icon and label are arranged in a row and padded by 12 logical pixels /// at the start, and 16 at the end, with an 8 pixel gap in between. /// /// The [icon] and [label] arguments must not be null. factory OutlinedButton.icon({ Key? key, required VoidCallback? onPressed, VoidCallback? onLongPress, ButtonStyle? style, FocusNode? focusNode, bool? autofocus, Clip? clipBehavior, required Widget icon, required Widget label, }) = _OutlinedButtonWithIcon; /// A static convenience method that constructs an outlined button /// [ButtonStyle] given simple values. /// /// /// The [foregroundColor] and [disabledForegroundColor] colors are used /// to create a [MaterialStateProperty] [ButtonStyle.foregroundColor], and /// a derived [ButtonStyle.overlayColor]. /// /// The [backgroundColor] and [disabledBackgroundColor] colors are /// used to create a [MaterialStateProperty] [ButtonStyle.backgroundColor]. /// /// Similarly, the [enabledMouseCursor] and [disabledMouseCursor] /// parameters are used to construct [ButtonStyle.mouseCursor]. /// /// All of the other parameters are either used directly or used to /// create a [MaterialStateProperty] with a single value for all /// states. /// /// All parameters default to null, by default this method returns /// a [ButtonStyle] that doesn't override anything. /// /// For example, to override the default shape and outline for an /// [OutlinedButton], one could write: /// /// ```dart /// OutlinedButton( /// style: OutlinedButton.styleFrom( /// shape: const StadiumBorder(), /// side: const BorderSide(width: 2, color: Colors.green), /// ), /// child: const Text('Seasons of Love'), /// onPressed: () { /// // ... /// }, /// ), /// ``` static ButtonStyle styleFrom({ Color? foregroundColor, Color? backgroundColor, Color? disabledForegroundColor, Color? disabledBackgroundColor, Color? shadowColor, Color? surfaceTintColor, double? elevation, TextStyle? textStyle, EdgeInsetsGeometry? padding, Size? minimumSize, Size? fixedSize, Size? maximumSize, BorderSide? side, OutlinedBorder? shape, MouseCursor? enabledMouseCursor, MouseCursor? disabledMouseCursor, VisualDensity? visualDensity, MaterialTapTargetSize? tapTargetSize, Duration? animationDuration, bool? enableFeedback, AlignmentGeometry? alignment, InteractiveInkFeatureFactory? splashFactory, @Deprecated( 'Use foregroundColor instead. ' 'This feature was deprecated after v3.1.0.' ) Color? primary, @Deprecated( 'Use disabledForegroundColor instead. ' 'This feature was deprecated after v3.1.0.' ) Color? onSurface, }) { final Color? foreground = foregroundColor ?? primary; final Color? disabledForeground = disabledForegroundColor ?? onSurface?.withOpacity(0.38); final MaterialStateProperty<Color?>? foregroundColorProp = (foreground == null && disabledForeground == null) ? null : _OutlinedButtonDefaultColor(foreground, disabledForeground); final MaterialStateProperty<Color?>? backgroundColorProp = (backgroundColor == null && disabledBackgroundColor == null) ? null : disabledBackgroundColor == null ? ButtonStyleButton.allOrNull<Color?>(backgroundColor) : _OutlinedButtonDefaultColor(backgroundColor, disabledBackgroundColor); final MaterialStateProperty<Color?>? overlayColor = (foreground == null) ? null : _OutlinedButtonDefaultOverlay(foreground); final MaterialStateProperty<MouseCursor>? mouseCursor = (enabledMouseCursor == null && disabledMouseCursor == null) ? null : _OutlinedButtonDefaultMouseCursor(enabledMouseCursor!, disabledMouseCursor!); return ButtonStyle( textStyle: ButtonStyleButton.allOrNull<TextStyle>(textStyle), foregroundColor: foregroundColorProp, backgroundColor: backgroundColorProp, overlayColor: overlayColor, shadowColor: ButtonStyleButton.allOrNull<Color>(shadowColor), surfaceTintColor: ButtonStyleButton.allOrNull<Color>(surfaceTintColor), elevation: ButtonStyleButton.allOrNull<double>(elevation), padding: ButtonStyleButton.allOrNull<EdgeInsetsGeometry>(padding), minimumSize: ButtonStyleButton.allOrNull<Size>(minimumSize), fixedSize: ButtonStyleButton.allOrNull<Size>(fixedSize), maximumSize: ButtonStyleButton.allOrNull<Size>(maximumSize), side: ButtonStyleButton.allOrNull<BorderSide>(side), shape: ButtonStyleButton.allOrNull<OutlinedBorder>(shape), mouseCursor: mouseCursor, visualDensity: visualDensity, tapTargetSize: tapTargetSize, animationDuration: animationDuration, enableFeedback: enableFeedback, alignment: alignment, splashFactory: splashFactory, ); } /// Defines the button's default appearance. /// /// With the exception of [ButtonStyle.side], which defines the /// outline, and [ButtonStyle.padding], the returned style is the /// same as for [TextButton]. /// /// The button [child]'s [Text] and [Icon] widgets are rendered with /// the [ButtonStyle]'s foreground color. The button's [InkWell] adds /// the style's overlay color when the button is focused, hovered /// or pressed. The button's background color becomes its [Material] /// color and is transparent by default. /// /// All of the ButtonStyle's defaults appear below. In this list /// "Theme.foo" is shorthand for `Theme.of(context).foo`. Color /// scheme values like "onSurface(0.38)" are shorthand for /// `onSurface.withOpacity(0.38)`. [MaterialStateProperty] valued /// properties that are not followed by a sublist have the same /// value for all states, otherwise the values are as specified for /// each state and "others" means all other states. /// /// The color of the [ButtonStyle.textStyle] is not used, the /// [ButtonStyle.foregroundColor] is used instead. /// /// ## Material 2 defaults /// /// * `textStyle` - Theme.textTheme.button /// * `backgroundColor` - transparent /// * `foregroundColor` /// * disabled - Theme.colorScheme.onSurface(0.38) /// * others - Theme.colorScheme.primary /// * `overlayColor` /// * hovered - Theme.colorScheme.primary(0.04) /// * focused or pressed - Theme.colorScheme.primary(0.12) /// * `shadowColor` - Theme.shadowColor /// * `elevation` - 0 /// * `padding` /// * `textScaleFactor <= 1` - horizontal(16) /// * `1 < textScaleFactor <= 2` - lerp(horizontal(16), horizontal(8)) /// * `2 < textScaleFactor <= 3` - lerp(horizontal(8), horizontal(4)) /// * `3 < textScaleFactor` - horizontal(4) /// * `minimumSize` - Size(64, 36) /// * `fixedSize` - null /// * `maximumSize` - Size.infinite /// * `side` - BorderSide(width: 1, color: Theme.colorScheme.onSurface(0.12)) /// * `shape` - RoundedRectangleBorder(borderRadius: BorderRadius.circular(4)) /// * `mouseCursor` /// * disabled - SystemMouseCursors.basic /// * others - SystemMouseCursors.click /// * `visualDensity` - theme.visualDensity /// * `tapTargetSize` - theme.materialTapTargetSize /// * `animationDuration` - kThemeChangeDuration /// * `enableFeedback` - true /// * `alignment` - Alignment.center /// * `splashFactory` - InkRipple.splashFactory /// /// ## Material 3 defaults /// /// If [ThemeData.useMaterial3] is set to true the following defaults will /// be used: /// /// * `textStyle` - Theme.textTheme.labelLarge /// * `backgroundColor` - transparent /// * `foregroundColor` /// * disabled - Theme.colorScheme.onSurface(0.38) /// * others - Theme.colorScheme.primary /// * `overlayColor` /// * hovered - Theme.colorScheme.primary(0.08) /// * focused or pressed - Theme.colorScheme.primary(0.12) /// * others - null /// * `shadowColor` - null /// * `surfaceTintColor` - null /// * `elevation` - 0 /// * `padding` /// * `textScaleFactor <= 1` - horizontal(16) /// * `1 < textScaleFactor <= 2` - lerp(horizontal(16), horizontal(8)) /// * `2 < textScaleFactor <= 3` - lerp(horizontal(8), horizontal(4)) /// * `3 < textScaleFactor` - horizontal(4) /// * `minimumSize` - Size(64, 40) /// * `fixedSize` - null /// * `maximumSize` - Size.infinite /// * `side` /// * disabled - BorderSide(color: Theme.colorScheme.onSurface(0.12)) /// * others - BorderSide(color: Theme.colorScheme.outline) /// * `shape` - StadiumBorder() /// * `mouseCursor` /// * disabled - SystemMouseCursors.basic /// * others - SystemMouseCursors.click /// * `visualDensity` - theme.visualDensity /// * `tapTargetSize` - theme.materialTapTargetSize /// * `animationDuration` - kThemeChangeDuration /// * `enableFeedback` - true /// * `alignment` - Alignment.center /// * `splashFactory` - Theme.splashFactory @override ButtonStyle defaultStyleOf(BuildContext context) { final ThemeData theme = Theme.of(context); final ColorScheme colorScheme = theme.colorScheme; return Theme.of(context).useMaterial3 ? _OutlinedButtonDefaultsM3(context) : styleFrom( foregroundColor: colorScheme.primary, disabledForegroundColor: colorScheme.onSurface.withOpacity(0.38), backgroundColor: Colors.transparent, disabledBackgroundColor: Colors.transparent, shadowColor: theme.shadowColor, elevation: 0, textStyle: theme.textTheme.labelLarge, padding: _scaledPadding(context), minimumSize: const Size(64, 36), maximumSize: Size.infinite, side: BorderSide( color: Theme.of(context).colorScheme.onSurface.withOpacity(0.12), ), shape: const RoundedRectangleBorder(borderRadius: BorderRadius.all(Radius.circular(4))), enabledMouseCursor: SystemMouseCursors.click, disabledMouseCursor: SystemMouseCursors.basic, visualDensity: theme.visualDensity, tapTargetSize: theme.materialTapTargetSize, animationDuration: kThemeChangeDuration, enableFeedback: true, alignment: Alignment.center, splashFactory: InkRipple.splashFactory, ); } @override ButtonStyle? themeStyleOf(BuildContext context) { return OutlinedButtonTheme.of(context).style; } } EdgeInsetsGeometry _scaledPadding(BuildContext context) { return ButtonStyleButton.scaledPadding( const EdgeInsets.symmetric(horizontal: 16), const EdgeInsets.symmetric(horizontal: 8), const EdgeInsets.symmetric(horizontal: 4), MediaQuery.maybeOf(context)?.textScaleFactor ?? 1, ); } @immutable class _OutlinedButtonDefaultColor extends MaterialStateProperty<Color?> with Diagnosticable { _OutlinedButtonDefaultColor(this.color, this.disabled); final Color? color; final Color? disabled; @override Color? resolve(Set<MaterialState> states) { if (states.contains(MaterialState.disabled)) { return disabled; } return color; } } @immutable class _OutlinedButtonDefaultOverlay extends MaterialStateProperty<Color?> with Diagnosticable { _OutlinedButtonDefaultOverlay(this.foreground); final Color foreground; @override Color? resolve(Set<MaterialState> states) { if (states.contains(MaterialState.hovered)) { return foreground.withOpacity(0.04); } if (states.contains(MaterialState.focused) || states.contains(MaterialState.pressed)) { return foreground.withOpacity(0.12); } return null; } } @immutable class _OutlinedButtonDefaultMouseCursor extends MaterialStateProperty<MouseCursor> with Diagnosticable { _OutlinedButtonDefaultMouseCursor(this.enabledCursor, this.disabledCursor); final MouseCursor enabledCursor; final MouseCursor disabledCursor; @override MouseCursor resolve(Set<MaterialState> states) { if (states.contains(MaterialState.disabled)) { return disabledCursor; } return enabledCursor; } } class _OutlinedButtonWithIcon extends OutlinedButton { _OutlinedButtonWithIcon({ super.key, required super.onPressed, super.onLongPress, super.style, super.focusNode, bool? autofocus, Clip? clipBehavior, required Widget icon, required Widget label, }) : assert(icon != null), assert(label != null), super( autofocus: autofocus ?? false, clipBehavior: clipBehavior ?? Clip.none, child: _OutlinedButtonWithIconChild(icon: icon, label: label), ); } class _OutlinedButtonWithIconChild extends StatelessWidget { const _OutlinedButtonWithIconChild({ required this.label, required this.icon, }); final Widget label; final Widget icon; @override Widget build(BuildContext context) { final double scale = MediaQuery.maybeOf(context)?.textScaleFactor ?? 1; final double gap = scale <= 1 ? 8 : lerpDouble(8, 4, math.min(scale - 1, 1))!; return Row( mainAxisSize: MainAxisSize.min, children: <Widget>[icon, SizedBox(width: gap), Flexible(child: label)], ); } } // BEGIN GENERATED TOKEN PROPERTIES - OutlinedButton // Do not edit by hand. The code between the "BEGIN GENERATED" and // "END GENERATED" comments are generated from data in the Material // Design token database by the script: // dev/tools/gen_defaults/bin/gen_defaults.dart. // Token database version: v0_132 class _OutlinedButtonDefaultsM3 extends ButtonStyle { _OutlinedButtonDefaultsM3(this.context) : super( animationDuration: kThemeChangeDuration, enableFeedback: true, alignment: Alignment.center, ); final BuildContext context; late final ColorScheme _colors = Theme.of(context).colorScheme; @override MaterialStateProperty<TextStyle?> get textStyle => MaterialStatePropertyAll<TextStyle?>(Theme.of(context).textTheme.labelLarge); @override MaterialStateProperty<Color?>? get backgroundColor => const MaterialStatePropertyAll<Color>(Colors.transparent); @override MaterialStateProperty<Color?>? get foregroundColor => MaterialStateProperty.resolveWith((Set<MaterialState> states) { if (states.contains(MaterialState.disabled)) { return _colors.onSurface.withOpacity(0.38); } return _colors.primary; }); @override MaterialStateProperty<Color?>? get overlayColor => MaterialStateProperty.resolveWith((Set<MaterialState> states) { if (states.contains(MaterialState.hovered)) { return _colors.primary.withOpacity(0.08); } if (states.contains(MaterialState.focused)) { return _colors.primary.withOpacity(0.12); } if (states.contains(MaterialState.pressed)) { return _colors.primary.withOpacity(0.12); } return null; }); @override MaterialStateProperty<Color>? get shadowColor => const MaterialStatePropertyAll<Color>(Colors.transparent); @override MaterialStateProperty<Color>? get surfaceTintColor => const MaterialStatePropertyAll<Color>(Colors.transparent); @override MaterialStateProperty<double>? get elevation => const MaterialStatePropertyAll<double>(0.0); @override MaterialStateProperty<EdgeInsetsGeometry>? get padding => MaterialStatePropertyAll<EdgeInsetsGeometry>(_scaledPadding(context)); @override MaterialStateProperty<Size>? get minimumSize => const MaterialStatePropertyAll<Size>(Size(64.0, 40.0)); // No default fixedSize @override MaterialStateProperty<Size>? get maximumSize => const MaterialStatePropertyAll<Size>(Size.infinite); @override MaterialStateProperty<BorderSide>? get side => MaterialStateProperty.resolveWith((Set<MaterialState> states) { if (states.contains(MaterialState.disabled)) { return BorderSide(color: _colors.onSurface.withOpacity(0.12)); } return BorderSide(color: _colors.outline); }); @override MaterialStateProperty<OutlinedBorder>? get shape => const MaterialStatePropertyAll<OutlinedBorder>(StadiumBorder()); @override MaterialStateProperty<MouseCursor?>? get mouseCursor => MaterialStateProperty.resolveWith((Set<MaterialState> states) { if (states.contains(MaterialState.disabled)) { return SystemMouseCursors.basic; } return SystemMouseCursors.click; }); @override VisualDensity? get visualDensity => Theme.of(context).visualDensity; @override MaterialTapTargetSize? get tapTargetSize => Theme.of(context).materialTapTargetSize; @override InteractiveInkFeatureFactory? get splashFactory => Theme.of(context).splashFactory; } // END GENERATED TOKEN PROPERTIES - OutlinedButton