A material design "flat button".

A flat button is a section printed on a Material widget that reacts to touches by filling with color.

Use flat buttons on toolbars, in dialogs, or inline with other content but offset from that content with padding so that the button's presence is obvious. Flat buttons intentionally do not have visible borders and must therefore rely on their position relative to other content for context. In dialogs and cards, they should be grouped together in one of the bottom corners. Avoid using flat buttons where they would blend in with other content, for example in the middle of lists.

Material design flat buttons have an all-caps label, some internal padding, and some defined dimensions. To have a part of your application be interactive, with ink splashes, without also committing to these stylistic choices, consider using InkWell instead.

If the onPressed callback is null, then the button will be disabled, will not react to touch, and will be colored as specified by the disabledColor property instead of the color property. If you are trying to change the button's color and it is not having any effect, check that you are passing a non-null onPressed handler.

Requires one of its ancestors to be a Material widget.

See also:

Inheritance

Constructors

FlatButton({Key key, VoidCallback onPressed, Color textColor, Color disabledTextColor, Color color, Color highlightColor, Color splashColor, Color disabledColor, ButtonTextTheme textTheme, Brightness colorBrightness, Widget child })

Creates a flat button.

const

Properties

child Widget

The widget below this widget in the tree.

final
color Color

The primary color of the button, as printed on the Material, while it is in its default (unpressed, enabled) state.

final
colorBrightness Brightness

The theme brightness to use for this button.

final
disabledColor Color

The color of the button when the button is disabled. Buttons are disabled by default. To enable a button, set its onPressed property to a non-null value.

final
disabledTextColor Color

The color to use for this button's text when the button cannot be pressed.

final
enabled bool

Whether the button is enabled or disabled. Buttons are disabled by default. To enable a button, set its onPressed property to a non-null value.

read-only
highlightColor Color

The secondary color of the button when the button is in the down (pressed) state. The higlight color is represented as a solid color that is overlaid over the button color (if any). If the highlight color has transparency, the button color will show through. The highlight fades in quickly as the button is held down.

final
onPressed VoidCallback

The callback that is called when the button is tapped or otherwise activated.

final
splashColor Color

The primary color of the button when the button is in the down (pressed) state. The splash is represented as a circular overlay that appears above the highlightColor overlay. The splash overlay has a center point that matches the hit point of the user touch event. The splash overlay will expand to fill the button area if the touch is held for long enough time. If the splash color has transparency then the highlight and button color will show through.

final
textColor Color

The color to use for this button's text.

final
textTheme ButtonTextTheme

The color scheme to use for this button's text.

final
hashCode int

The hash code for this object.

read-only, inherited
key Key

Controls how one widget replaces another widget in the tree.

final, inherited
runtimeType Type

A representation of the runtime type of the object.

read-only, inherited

Methods

build(BuildContext context) Widget

Describes the part of the user interface represented by this widget.

createElement() StatelessElement

Creates a StatelessElement to manage this widget's location in the tree.

inherited
debugFillDescription(List<String> description) → void

Add additional information to the given description for use by toString.

@mustCallSuper, @protected, inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
toString() String

Returns a string representation of this object.

inherited
toStringShort() String

A short, textual description of this widget.

inherited

Operators

operator ==(other) bool

The equality operator.

inherited