// 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 'constants.dart'; import 'elevated_button_theme.dart'; import 'ink_ripple.dart'; import 'ink_well.dart'; import 'material_state.dart'; import 'theme.dart'; import 'theme_data.dart'; /// A Material Design "elevated button". /// /// Use elevated buttons to add dimension to otherwise mostly flat /// layouts, e.g. in long busy lists of content, or in wide /// spaces. Avoid using elevated buttons on already-elevated content /// such as dialogs or cards. /// /// An elevated button is a label [child] displayed on a [Material] /// widget whose [Material.elevation] increases when the button is /// pressed. The label's [Text] and [Icon] widgets are displayed in /// [style]'s [ButtonStyle.foregroundColor] and the button's filled /// background is the [ButtonStyle.backgroundColor]. /// /// The elevated button's default style is defined by /// [defaultStyleOf]. The style of this elevated button can be /// overridden with its [style] parameter. The style of all elevated /// buttons in a subtree can be overridden with the /// [ElevatedButtonTheme], and the style of all of the elevated /// buttons in an app can be overridden with the [Theme]'s /// [ThemeData.elevatedButtonTheme] property. /// /// The static [styleFrom] method is a convenient way to create a /// elevated button [ButtonStyle] from simple values. /// /// If [onPressed] and [onLongPress] callbacks are null, then the /// button will be disabled. /// /// {@tool dartpad} /// This sample produces an enabled and a disabled ElevatedButton. /// /// ** See code in examples/api/lib/material/elevated_button/elevated_button.0.dart ** /// {@end-tool} /// /// See also: /// /// * [FilledButton], a filled button that doesn't elevate when pressed. /// * [FilledButton.tonal], a filled button variant that uses a secondary fill color. /// * [OutlinedButton], a button with an outlined border and no 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 ElevatedButton extends ButtonStyleButton { /// Create an ElevatedButton. /// /// The [autofocus] and [clipBehavior] arguments must not be null. const ElevatedButton({ 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 an elevated 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 ElevatedButton.icon({ Key? key, required VoidCallback? onPressed, VoidCallback? onLongPress, ValueChanged<bool>? onHover, ValueChanged<bool>? onFocusChange, ButtonStyle? style, FocusNode? focusNode, bool? autofocus, Clip? clipBehavior, MaterialStatesController? statesController, required Widget icon, required Widget label, }) = _ElevatedButtonWithIcon; /// A static convenience method that constructs an elevated 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]. /// /// The button's elevations are defined relative to the [elevation] /// parameter. The disabled elevation is the same as the parameter /// value, [elevation] + 2 is used when the button is hovered /// or focused, and elevation + 6 is used when the button is pressed. /// /// 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 text and icon colors for a /// [ElevatedButton], as well as its overlay color, with all of the /// standard opacity adjustments for the pressed, focused, and /// hovered states, one could write: /// /// ```dart /// ElevatedButton( /// style: ElevatedButton.styleFrom(foregroundColor: Colors.green), /// onPressed: () { /// // ... /// }, /// child: const Text('Jump'), /// ), /// ``` /// /// And to change the fill color: /// /// ```dart /// ElevatedButton( /// style: ElevatedButton.styleFrom(backgroundColor: Colors.green), /// onPressed: () { /// // ... /// }, /// child: const Text('Meow'), /// ), /// ``` /// 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 backgroundColor instead. ' 'This feature was deprecated after v3.1.0.' ) Color? primary, @Deprecated( 'Use foregroundColor instead. ' 'This feature was deprecated after v3.1.0.' ) Color? onPrimary, @Deprecated( 'Use disabledForegroundColor and disabledBackgroundColor instead. ' 'This feature was deprecated after v3.1.0.' ) Color? onSurface, }) { final Color? background = backgroundColor ?? primary; final Color? disabledBackground = disabledBackgroundColor ?? onSurface?.withOpacity(0.12); final MaterialStateProperty<Color?>? backgroundColorProp = (background == null && disabledBackground == null) ? null : _ElevatedButtonDefaultColor(background, disabledBackground); final Color? foreground = foregroundColor ?? onPrimary; final Color? disabledForeground = disabledForegroundColor ?? onSurface?.withOpacity(0.38); final MaterialStateProperty<Color?>? foregroundColorProp = (foreground == null && disabledForeground == null) ? null : _ElevatedButtonDefaultColor(foreground, disabledForeground); final MaterialStateProperty<Color?>? overlayColor = (foreground == null) ? null : _ElevatedButtonDefaultOverlay(foreground); final MaterialStateProperty<double>? elevationValue = (elevation == null) ? null : _ElevatedButtonDefaultElevation(elevation); final MaterialStateProperty<MouseCursor?>? mouseCursor = (enabledMouseCursor == null && disabledMouseCursor == null) ? null : _ElevatedButtonDefaultMouseCursor(enabledMouseCursor, disabledMouseCursor); return ButtonStyle( textStyle: MaterialStatePropertyAll<TextStyle?>(textStyle), backgroundColor: backgroundColorProp, foregroundColor: foregroundColorProp, overlayColor: overlayColor, shadowColor: ButtonStyleButton.allOrNull<Color>(shadowColor), surfaceTintColor: ButtonStyleButton.allOrNull<Color>(surfaceTintColor), elevation: elevationValue, 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. /// /// 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. /// /// 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 `textScaleFactor` is the value of /// `MediaQuery.textScaleFactorOf(context)` and the names of the /// EdgeInsets constructors and `EdgeInsetsGeometry.lerp` have been /// abbreviated for readability. /// /// The color of the [ButtonStyle.textStyle] is not used, the /// [ButtonStyle.foregroundColor] color is used instead. /// /// ## Material 2 defaults /// /// * `textStyle` - Theme.textTheme.button /// * `backgroundColor` /// * disabled - Theme.colorScheme.onSurface(0.12) /// * others - Theme.colorScheme.primary /// * `foregroundColor` /// * disabled - Theme.colorScheme.onSurface(0.38) /// * others - Theme.colorScheme.onPrimary /// * `overlayColor` /// * hovered - Theme.colorScheme.onPrimary(0.08) /// * focused or pressed - Theme.colorScheme.onPrimary(0.24) /// * `shadowColor` - Theme.shadowColor /// * `elevation` /// * disabled - 0 /// * default - 2 /// * hovered or focused - 4 /// * pressed - 8 /// * `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` - null /// * `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 /// /// The default padding values for the [ElevatedButton.icon] factory are slightly different: /// /// * `padding` /// * `textScaleFactor <= 1` - start(12) end(16) /// * `1 < textScaleFactor <= 2` - lerp(start(12) end(16), horizontal(8)) /// * `2 < textScaleFactor <= 3` - lerp(horizontal(8), horizontal(4)) /// * `3 < textScaleFactor` - horizontal(4) /// /// The default value for `side`, which defines the appearance of the button's /// outline, is null. That means that the outline is defined by the button /// shape's [OutlinedBorder.side]. Typically the default value of an /// [OutlinedBorder]'s side is [BorderSide.none], so an outline is not drawn. /// /// ## Material 3 defaults /// /// If [ThemeData.useMaterial3] is set to true the following defaults will /// be used: /// /// * `textStyle` - Theme.textTheme.labelLarge /// * `backgroundColor` /// * disabled - Theme.colorScheme.onSurface(0.12) /// * others - Theme.colorScheme.surface /// * `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) /// * `shadowColor` - Theme.colorScheme.shadow /// * `surfaceTintColor` - Theme.colorScheme.surfaceTint /// * `elevation` /// * disabled - 0 /// * default - 1 /// * hovered - 3 /// * focused or pressed - 1 /// * `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` - null /// * `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 ? _ElevatedButtonDefaultsM3(context) : styleFrom( backgroundColor: colorScheme.primary, foregroundColor: colorScheme.onPrimary, disabledBackgroundColor: colorScheme.onSurface.withOpacity(0.12), disabledForegroundColor: colorScheme.onSurface.withOpacity(0.38), shadowColor: theme.shadowColor, elevation: 2, textStyle: theme.textTheme.labelLarge, padding: _scaledPadding(context), minimumSize: const Size(64, 36), maximumSize: Size.infinite, 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, ); } /// Returns the [ElevatedButtonThemeData.style] of the closest /// [ElevatedButtonTheme] ancestor. @override ButtonStyle? themeStyleOf(BuildContext context) { return ElevatedButtonTheme.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.textScaleFactorOf(context), ); } @immutable class _ElevatedButtonDefaultColor extends MaterialStateProperty<Color?> with Diagnosticable { _ElevatedButtonDefaultColor(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 _ElevatedButtonDefaultOverlay extends MaterialStateProperty<Color?> with Diagnosticable { _ElevatedButtonDefaultOverlay(this.overlay); final Color overlay; @override Color? resolve(Set<MaterialState> states) { if (states.contains(MaterialState.hovered)) { return overlay.withOpacity(0.08); } if (states.contains(MaterialState.focused) || states.contains(MaterialState.pressed)) { return overlay.withOpacity(0.24); } return null; } } @immutable class _ElevatedButtonDefaultElevation extends MaterialStateProperty<double> with Diagnosticable { _ElevatedButtonDefaultElevation(this.elevation); final double elevation; @override double resolve(Set<MaterialState> states) { if (states.contains(MaterialState.disabled)) { return 0; } if (states.contains(MaterialState.hovered)) { return elevation + 2; } if (states.contains(MaterialState.focused)) { return elevation + 2; } if (states.contains(MaterialState.pressed)) { return elevation + 6; } return elevation; } } @immutable class _ElevatedButtonDefaultMouseCursor extends MaterialStateProperty<MouseCursor?> with Diagnosticable { _ElevatedButtonDefaultMouseCursor(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 _ElevatedButtonWithIcon extends ElevatedButton { _ElevatedButtonWithIcon({ super.key, required super.onPressed, super.onLongPress, super.onHover, super.onFocusChange, super.style, super.focusNode, bool? autofocus, Clip? clipBehavior, super.statesController, required Widget icon, required Widget label, }) : assert(icon != null), assert(label != null), super( autofocus: autofocus ?? false, clipBehavior: clipBehavior ?? Clip.none, child: _ElevatedButtonWithIconChild(icon: icon, label: label), ); @override ButtonStyle defaultStyleOf(BuildContext context) { final EdgeInsetsGeometry scaledPadding = ButtonStyleButton.scaledPadding( const EdgeInsetsDirectional.fromSTEB(12, 0, 16, 0), const EdgeInsets.symmetric(horizontal: 8), const EdgeInsetsDirectional.fromSTEB(8, 0, 4, 0), MediaQuery.textScaleFactorOf(context), ); return super.defaultStyleOf(context).copyWith( padding: MaterialStatePropertyAll<EdgeInsetsGeometry>(scaledPadding), ); } } class _ElevatedButtonWithIconChild extends StatelessWidget { const _ElevatedButtonWithIconChild({ required this.label, required this.icon }); final Widget label; final Widget icon; @override Widget build(BuildContext context) { final double scale = MediaQuery.textScaleFactorOf(context); 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 - ElevatedButton // 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_143 class _ElevatedButtonDefaultsM3 extends ButtonStyle { _ElevatedButtonDefaultsM3(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 => MaterialStateProperty.resolveWith((Set<MaterialState> states) { if (states.contains(MaterialState.disabled)) { return _colors.onSurface.withOpacity(0.12); } return _colors.surface; }); @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 => MaterialStatePropertyAll<Color>(_colors.shadow); @override MaterialStateProperty<Color>? get surfaceTintColor => MaterialStatePropertyAll<Color>(_colors.surfaceTint); @override MaterialStateProperty<double>? get elevation => MaterialStateProperty.resolveWith((Set<MaterialState> states) { if (states.contains(MaterialState.disabled)) { return 0.0; } if (states.contains(MaterialState.hovered)) { return 3.0; } if (states.contains(MaterialState.focused)) { return 1.0; } if (states.contains(MaterialState.pressed)) { return 1.0; } return 1.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); // No default side @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 - ElevatedButton