OutlineButton class

Similar to a FlatButton with a thin grey rounded rectangle border.

This class is obsolete, please use OutlinedButton instead.

FlatButton, RaisedButton, and OutlineButton have been replaced by TextButton, ElevatedButton, and OutlinedButton respectively. ButtonTheme has been replaced by TextButtonTheme, ElevatedButtonTheme, and OutlinedButtonTheme. The original classes will be deprecated soon, please migrate code that uses them. There's a detailed migration guide for the new button and button theme classes in flutter.dev/go/material-button-migration-guide.

The outline button's border shape is defined by shape and its appearance is defined by borderSide, disabledBorderColor, and highlightedBorderColor. By default the border is a one pixel wide grey rounded rectangle that does not change when the button is pressed or disabled. By default the button's background is transparent.

If the onPressed or onLongPress callbacks are null, then the button will be disabled and by default will resemble a flat button in the disabledColor.

The button's highlightElevation, which defines the size of the drop shadow when the button is pressed, is 0.0 (no shadow) by default. If highlightElevation is given a value greater than 0.0 then the button becomes a cross between RaisedButton and FlatButton: a bordered button whose elevation increases and whose background becomes opaque when the button is pressed.

If you want an ink-splash effect for taps, but don't want to use a button, consider using InkWell directly.

Outline buttons have a minimum size of 88.0 by 36.0 which can be overridden with ButtonTheme.

Here is an example of a basic OutlineButton.

To create a local project with this code sample, run:
flutter create --sample=material.OutlineButton.1 mysample

Here is an example of a basic OutlineButton.

  Widget build(BuildContext context) {
    return OutlineButton(
      onPressed: () {
        print('Received click');
      },
      child: Text('Click Me'),
    );
  }

Constructors

OutlineButton({Key key, @required VoidCallback onPressed, VoidCallback onLongPress, MouseCursor mouseCursor, ButtonTextTheme textTheme, Color textColor, Color disabledTextColor, Color color, Color focusColor, Color hoverColor, Color highlightColor, Color splashColor, double highlightElevation, BorderSide borderSide, Color disabledBorderColor, Color highlightedBorderColor, EdgeInsetsGeometry padding, VisualDensity visualDensity, ShapeBorder shape, Clip clipBehavior: Clip.none, FocusNode focusNode, bool autofocus: false, MaterialTapTargetSize materialTapTargetSize, Widget child}): Create an outline button. [...]
const
OutlineButton.icon({Key key, @required VoidCallback onPressed, VoidCallback onLongPress, MouseCursor mouseCursor, ButtonTextTheme textTheme, Color textColor, Color disabledTextColor, Color color, Color focusColor, Color hoverColor, Color highlightColor, Color splashColor, double highlightElevation, Color highlightedBorderColor, Color disabledBorderColor, BorderSide borderSide, EdgeInsetsGeometry padding, VisualDensity visualDensity, ShapeBorder shape, Clip clipBehavior, FocusNode focusNode, bool autofocus, MaterialTapTargetSize materialTapTargetSize, @required Widget icon, @required Widget label}): Create an outline button from a pair of widgets that serve as the button's icon and label. [...]
factory

Properties

animationDuration → Duration: Defines the duration of animated changes for shape and elevation. [...]
final, inherited
autofocus → bool: True if this widget will be selected as the initial focus when no other node in its scope is currently focused. [...]
final, inherited
borderSide → BorderSide: Defines the color of the border when the button is enabled but not pressed, and the border outline's width and style in general. [...]
final
child → Widget: The button's label. [...]
final, inherited
clipBehavior → Clip: The content will be clipped (or not) according to this option. [...]
final, inherited
color → Color: The button's fill color, displayed by its Material, while it is in its default (unpressed, enabled) state. [...]
final, inherited
colorBrightness → Brightness: The theme brightness to use for this button. [...]
final, inherited
disabledBorderColor → Color: The outline border's color when the button is not enabled. [...]
final
disabledColor → Color: The fill color of the button when the button is disabled. [...]
final, inherited
disabledElevation → double: The elevation for the button's Material relative to its parent when the button is not enabled. [...]
final, inherited
disabledTextColor → Color: The color to use for this button's text when the button is disabled. [...]
final, inherited
elevation → double: The z-coordinate at which to place this button relative to its parent. [...]
final, inherited
enabled → bool: Whether the button is enabled or disabled. [...]
read-only, inherited
enableFeedback → bool: Whether detected gestures should provide acoustic and/or haptic feedback. [...]
final, inherited
focusColor → Color: The fill color of the button's Material when it has the input focus. [...]
final, inherited
focusElevation → double: The elevation for the button's Material when the button is enabled and has the input focus. [...]
final, inherited
focusNode → FocusNode: An optional focus node to use as the focus node for this widget. [...]
final, inherited
hashCode → int: The hash code for this object. [...]
@nonVirtual, read-only, inherited
height → double: The vertical extent of the button. [...]
final, inherited
highlightColor → Color: The highlight color of the button's InkWell. [...]
final, inherited
highlightedBorderColor → Color: The outline border's color when the button is enabled and pressed. [...]
final
highlightElevation → double: The elevation for the button's Material relative to its parent when the button is enabled and pressed. [...]
final, inherited
hoverColor → Color: The fill color of the button's Material when a pointer is hovering over it. [...]
final, inherited
hoverElevation → double: The elevation for the button's Material when the button is enabled and a pointer is hovering over it. [...]
final, inherited
key → Key: Controls how one widget replaces another widget in the tree. [...]
final, inherited
materialTapTargetSize → MaterialTapTargetSize: Configures the minimum size of the tap target. [...]
final, inherited
minWidth → double: The smallest horizontal extent that the button will occupy. [...]
final, inherited
mouseCursor → MouseCursor: The cursor for a mouse pointer when it enters or is hovering over the button. [...]
final, inherited
onHighlightChanged → ValueChanged<bool>: Called by the underlying InkWell widget's InkWell.onHighlightChanged callback. [...]
final, inherited
onLongPress → VoidCallback: The callback that is called when the button is long-pressed. [...]
final, inherited
onPressed → VoidCallback: The callback that is called when the button is tapped or otherwise activated. [...]
final, inherited
padding → EdgeInsetsGeometry: The internal padding for the button's child. [...]
final, inherited
runtimeType → Type: A representation of the runtime type of the object.
read-only, inherited
shape → ShapeBorder: The shape of the button's Material. [...]
final, inherited
splashColor → Color: The splash color of the button's InkWell. [...]
final, inherited
textColor → Color: The color to use for this button's text. [...]
final, inherited
textTheme → ButtonTextTheme: Defines the button's base colors, and the defaults for the button's minimum size, internal padding, and shape. [...]
final, inherited
visualDensity → VisualDensity: Defines how compact the button's layout will be. [...]
final, inherited

Methods

build(BuildContext context) → Widget: Describes the part of the user interface represented by this widget. [...]
override
createElement() → StatelessElement: Creates a StatelessElement to manage this widget's location in the tree. [...]
inherited
debugDescribeChildren() → List<DiagnosticsNode>: Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node. [...]
override
noSuchMethod(Invocation invocation) → dynamic: Invoked when a non-existent method or property is accessed. [...]
inherited
toDiagnosticsNode({String name, DiagnosticsTreeStyle style}) → DiagnosticsNode: Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.info}) → String: Returns a string representation of this object.
inherited
toStringDeep({String prefixLineOne: '', String prefixOtherLines, DiagnosticLevel minLevel: DiagnosticLevel.debug}) → String: Returns a string representation of this node and its descendants. [...]
inherited
toStringShallow({String joiner: ', ', DiagnosticLevel minLevel: DiagnosticLevel.debug}) → String: Returns a one-line detailed description of the object. [...]
inherited
toStringShort() → String: A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool: The equality operator. [...]
@nonVirtual, inherited