styleFrom static method

ButtonStyle styleFrom({
  1. Color? foregroundColor,
  2. Color? backgroundColor,
  3. Color? disabledForegroundColor,
  4. Color? disabledBackgroundColor,
  5. Color? shadowColor,
  6. Color? surfaceTintColor,
  7. Color? iconColor,
  8. double? iconSize,
  9. IconAlignment? iconAlignment,
  10. Color? disabledIconColor,
  11. Color? overlayColor,
  12. double? elevation,
  13. TextStyle? textStyle,
  14. EdgeInsetsGeometry? padding,
  15. Size? minimumSize,
  16. Size? fixedSize,
  17. Size? maximumSize,
  18. BorderSide? side,
  19. OutlinedBorder? shape,
  20. MouseCursor? enabledMouseCursor,
  21. MouseCursor? disabledMouseCursor,
  22. VisualDensity? visualDensity,
  23. MaterialTapTargetSize? tapTargetSize,
  24. Duration? animationDuration,
  25. bool? enableFeedback,
  26. AlignmentGeometry? alignment,
  27. InteractiveInkFeatureFactory? splashFactory,
  28. ButtonLayerBuilder? backgroundBuilder,
  29. ButtonLayerBuilder? foregroundBuilder,
})

A static convenience method that constructs a text button ButtonStyle given simple values.

The foregroundColor and disabledForegroundColor colors are used to create a WidgetStateProperty ButtonStyle.foregroundColor, and a derived ButtonStyle.overlayColor if overlayColor isn't specified.

The backgroundColor and disabledBackgroundColor colors are used to create a WidgetStateProperty ButtonStyle.backgroundColor.

Similarly, the enabledMouseCursor and disabledMouseCursor parameters are used to construct ButtonStyle.mouseCursor.

The iconColor, disabledIconColor are used to construct ButtonStyle.iconColor and iconSize is used to construct ButtonStyle.iconSize.

If iconColor is null, the button icon will use foregroundColor. If foregroundColor is also null, the button icon will use the default icon color.

If overlayColor is specified and its value is Colors.transparent then the pressed/focused/hovered highlights are effectively defeated. Otherwise a WidgetStateProperty with the same opacities as the default is created.

All of the other parameters are either used directly or used to create a WidgetStateProperty 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 TextButton, as well as its overlay color, with all of the standard opacity adjustments for the pressed, focused, and hovered states, one could write:

TextButton(
  style: TextButton.styleFrom(foregroundColor: Colors.green),
  child: const Text('Give Kate a mix tape'),
  onPressed: () {
    // ...
  },
),

Implementation

static ButtonStyle styleFrom({
  Color? foregroundColor,
  Color? backgroundColor,
  Color? disabledForegroundColor,
  Color? disabledBackgroundColor,
  Color? shadowColor,
  Color? surfaceTintColor,
  Color? iconColor,
  double? iconSize,
  IconAlignment? iconAlignment,
  Color? disabledIconColor,
  Color? overlayColor,
  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,
  ButtonLayerBuilder? backgroundBuilder,
  ButtonLayerBuilder? foregroundBuilder,
}) {
  final MaterialStateProperty<Color?>? backgroundColorProp = switch ((
    backgroundColor,
    disabledBackgroundColor,
  )) {
    (_?, null) => MaterialStatePropertyAll<Color?>(backgroundColor),
    (_, _) => ButtonStyleButton.defaultColor(backgroundColor, disabledBackgroundColor),
  };
  final MaterialStateProperty<Color?>? iconColorProp = switch ((iconColor, disabledIconColor)) {
    (_?, null) => MaterialStatePropertyAll<Color?>(iconColor),
    (_, _) => ButtonStyleButton.defaultColor(iconColor, disabledIconColor),
  };
  final MaterialStateProperty<Color?>? overlayColorProp = switch ((
    foregroundColor,
    overlayColor,
  )) {
    (null, null) => null,
    (_, Color(a: 0.0)) => WidgetStatePropertyAll<Color?>(overlayColor),
    (_, final Color color) ||
    (final Color color, _) => WidgetStateProperty<Color?>.fromMap(<WidgetState, Color?>{
      WidgetState.pressed: color.withOpacity(0.1),
      WidgetState.hovered: color.withOpacity(0.08),
      WidgetState.focused: color.withOpacity(0.1),
    }),
  };

  return ButtonStyle(
    textStyle: ButtonStyleButton.allOrNull<TextStyle>(textStyle),
    foregroundColor: ButtonStyleButton.defaultColor(foregroundColor, disabledForegroundColor),
    backgroundColor: backgroundColorProp,
    overlayColor: overlayColorProp,
    shadowColor: ButtonStyleButton.allOrNull<Color>(shadowColor),
    surfaceTintColor: ButtonStyleButton.allOrNull<Color>(surfaceTintColor),
    iconColor: iconColorProp,
    iconSize: ButtonStyleButton.allOrNull<double>(iconSize),
    iconAlignment: iconAlignment,
    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: WidgetStateProperty<MouseCursor?>.fromMap(<WidgetStatesConstraint, MouseCursor?>{
      WidgetState.disabled: disabledMouseCursor,
      WidgetState.any: enabledMouseCursor,
    }),
    visualDensity: visualDensity,
    tapTargetSize: tapTargetSize,
    animationDuration: animationDuration,
    enableFeedback: enableFeedback,
    alignment: alignment,
    splashFactory: splashFactory,
    backgroundBuilder: backgroundBuilder,
    foregroundBuilder: foregroundBuilder,
  );
}