styleFrom method Null safety

ButtonStyle styleFrom(
  1. {Color? foregroundColor,
  2. Color? backgroundColor,
  3. Color? disabledForegroundColor,
  4. Color? disabledBackgroundColor,
  5. Color? shadowColor,
  6. Color? surfaceTintColor,
  7. double? elevation,
  8. TextStyle? textStyle,
  9. EdgeInsetsGeometry? padding,
  10. Size? minimumSize,
  11. Size? fixedSize,
  12. Size? maximumSize,
  13. BorderSide? side,
  14. OutlinedBorder? shape,
  15. MouseCursor? enabledMouseCursor,
  16. MouseCursor? disabledMouseCursor,
  17. VisualDensity? visualDensity,
  18. MaterialTapTargetSize? tapTargetSize,
  19. Duration? animationDuration,
  20. bool? enableFeedback,
  21. AlignmentGeometry? alignment,
  22. InteractiveInkFeatureFactory? splashFactory,
  23. @Deprecated('Use foregroundColor instead. ' 'This feature was deprecated after v3.1.0.') Color? primary,
  24. @Deprecated('Use disabledForegroundColor and disabledForegroundColor instead. ' 'This feature was deprecated after v3.1.0.') Color? onSurface}
)

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

The primary, and onSurface colors are used to create a MaterialStateProperty ButtonStyle.foregroundColor value in the same way that defaultStyleOf uses the ColorScheme colors with the same names. Specify a value for primary to specify the color of the button's text and icons as well as the overlay colors used to indicate the hover, focus, and pressed states. Use onSurface to specify the button's disabled text and icon color.

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 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(primary: Colors.green),
)

Implementation

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 and 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
    : _TextButtonDefaultColor(foreground, disabledForeground);
  final MaterialStateProperty<Color?>? backgroundColorProp = (backgroundColor == null && disabledBackgroundColor == null)
    ? null
    : disabledBackgroundColor == null
      ? ButtonStyleButton.allOrNull<Color?>(backgroundColor)
      : _TextButtonDefaultColor(backgroundColor, disabledBackgroundColor);
  final MaterialStateProperty<Color?>? overlayColor = (foreground == null)
    ? null
    : _TextButtonDefaultOverlay(foreground);
  final MaterialStateProperty<MouseCursor>? mouseCursor = (enabledMouseCursor == null && disabledMouseCursor == null)
    ? null
    : _TextButtonDefaultMouseCursor(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,
  );
}