A rectangular area of aMaterial that responds to touch.

For a variant of this widget that does not clip splashes, seeInkResponse.

The following diagram shows how anInkWell looks when tapped, when usingdefault values.

TheInkWell widget must have aMaterial widget as an ancestor. TheMaterial widget is where the ink reactions are actually painted. Thismatches the Material Design premise wherein theMaterial is what isactually reacting to touches by spreading ink.

If a Widget uses this class directly, it should include the following lineat the top of its build function to calldebugCheckHasMaterial:

assert(debugCheckHasMaterial(context));

Troubleshooting

The ink splashes aren't visible!

If there is an opaque graphic, e.g. painted using aContainer,Image, orDecoratedBox, between theMaterial widget and theInkWell widget, thenthe splash won't be visible because it will be under the opaque graphic.This is because ink splashes draw on the underlyingMaterial itself, asif the ink was spreading inside the material.

TheInk widget can be used as a replacement forImage,Container, orDecoratedBox to ensure that the image or decoration also paints in theMaterial itself, below the ink.

If this is not possible for some reason, e.g. because you are using anopaqueCustomPaint widget, alternatively consider using a secondMaterial above the opaque widget but below theInkWell (as anancestor to the ink well). TheMaterialType.transparency materialkind can be used for this purpose.

InkWell isn't clipping properly

If you want to clip an InkWell or anyInk widgets you need to keep in mindthat theMaterial that the Ink will be printed on is responsible for clipping.This means you can't wrap theInk widget in a clipping widget directly,since this will leave theMaterial not clipped (and by extension the printedInk widgets as well).

An easy solution is to deliberately wrap theInk widgets you want to clipin aMaterial, and wrap that in a clipping widget instead. SeeInk foran example.

The ink splashes don't track the size of an animated container

If the size of an InkWell'sMaterial ancestor changes while the InkWell'ssplashes are expanding, you may notice that the splashes aren't clippedcorrectly. This can't be avoided.

An example of this situation is as follows:

An InkWell's splashes will not properly update to conform to changes if thesize of its underlyingMaterial, where the splashes are rendered, changesduring animation. You should avoid using InkWells withinMaterial widgetsthat are changing size.

See also:

• GestureDetector, for listening for gestures without ink splashes.
• ElevatedButton andTextButton, two kinds of buttons in Material Design.
• InkResponse, a variant ofInkWell that doesn't force a rectangularshape on the ink reaction.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• InkResponse
• InkWell

Constructors

InkWell({Key?key,Widget?child,GestureTapCallback?onTap,GestureTapCallback?onDoubleTap,GestureLongPressCallback?onLongPress,GestureLongPressUpCallback?onLongPressUp,GestureTapDownCallback?onTapDown,GestureTapUpCallback?onTapUp,GestureTapCallback?onTapCancel,GestureTapCallback?onSecondaryTap,GestureTapUpCallback?onSecondaryTapUp,GestureTapDownCallback?onSecondaryTapDown,GestureTapCallback?onSecondaryTapCancel,ValueChanged<bool>?onHighlightChanged,ValueChanged<bool>?onHover,MouseCursor?mouseCursor,Color?focusColor,Color?hoverColor,Color?highlightColor,WidgetStateProperty<Color?>?overlayColor,Color?splashColor,InteractiveInkFeatureFactory?splashFactory,double?radius,BorderRadius?borderRadius,ShapeBorder?customBorder,boolenableFeedback =true,boolexcludeFromSemantics =false,FocusNode?focusNode,boolcanRequestFocus =true,ValueChanged<bool>?onFocusChange,boolautofocus =false,MaterialStatesController?statesController,Duration?hoverDuration})

Creates an ink well.

const

Properties

autofocus→bool

True if this widget will be selected as the initial focus when no othernode in its scope is currently focused.

finalinherited

borderRadius→BorderRadius?

The border radius of the containing rectangle. This is effective only ifhighlightShape isBoxShape.rectangle.

finalinherited

canRequestFocus→bool

If true, this widget may request the primary focus.

finalinherited

child→Widget?

The widget below this widget in the tree.

finalinherited

containedInkWell→bool

Whether this ink response should be clipped its bounds.

finalinherited

customBorder→ShapeBorder?

The custom clip border.

finalinherited

enableFeedback→bool

Whether detected gestures should provide acoustic and/or haptic feedback.

finalinherited

excludeFromSemantics→bool

Whether to exclude the gestures introduced by this widget from thesemantics tree.

finalinherited

focusColor→Color?

The color of the ink response when the parent widget is focused. If thisproperty is null then the focus color of the theme,ThemeData.focusColor, will be used.

finalinherited

focusNode→FocusNode?

An optional focus node to use as the focus node for this widget.

finalinherited

hashCode→int

The hash code for this object.

no setterinherited

highlightColor→Color?

The highlight color of the ink response when pressed. If this property isnull then the highlight color of the theme,ThemeData.highlightColor,will be used.

finalinherited

highlightShape→BoxShape

The shape (e.g., circle, rectangle) to use for the highlight drawn aroundthis part of the material when pressed, hovered over, or focused.

finalinherited

hoverColor→Color?

The color of the ink response when a pointer is hovering over it. If thisproperty is null then the hover color of the theme,ThemeData.hoverColor, will be used.

finalinherited

hoverDuration→Duration?

The duration of the animation that animates the hover effect.

finalinherited

key→Key?

Controls how one widget replaces another widget in the tree.

finalinherited

mouseCursor→MouseCursor?

The cursor for a mouse pointer when it enters or is hovering over thewidget.

finalinherited

onDoubleTap→GestureTapCallback?

Called when the user double taps this part of the material.

finalinherited

onFocusChange→ValueChanged<bool>?

Handler called when the focus changes.

finalinherited

onHighlightChanged→ValueChanged<bool>?

Called when this part of the material either becomes highlighted or stopsbeing highlighted.

finalinherited

onHover→ValueChanged<bool>?

Called when a pointer enters or exits the ink response area.

finalinherited

onLongPress→GestureLongPressCallback?

Called when the user long-presses on this part of the material.

finalinherited

onLongPressUp→GestureLongPressUpCallback?

Called when the user lifts their finger after a long press on the button.

finalinherited

onSecondaryTap→GestureTapCallback?

Called when the user taps this part of the material with a secondary button.

finalinherited

onSecondaryTapCancel→GestureTapCallback?

Called when the user cancels a secondary button tap that was started onthis part of the material.

finalinherited

onSecondaryTapDown→GestureTapDownCallback?

Called when the user taps down on this part of the material with asecondary button.

finalinherited

onSecondaryTapUp→GestureTapUpCallback?

Called when the user releases a secondary button tap that was started onthis part of the material.onSecondaryTap is called immediately after.

finalinherited

onTap→GestureTapCallback?

Called when the user taps this part of the material.

finalinherited

onTapCancel→GestureTapCallback?

Called when the user cancels a tap that was started on this part of thematerial.

finalinherited

onTapDown→GestureTapDownCallback?

Called when the user taps down this part of the material.

finalinherited

onTapUp→GestureTapUpCallback?

Called when the user releases a tap that was started on this part of thematerial.onTap is called immediately after.

finalinherited

overlayColor→WidgetStateProperty<Color?>?

Defines the ink response focus, hover, and splash colors.

finalinherited

radius→double?

The radius of the ink splash.

finalinherited

runtimeType→Type

A representation of the runtime type of the object.

no setterinherited

splashColor→Color?

The splash color of the ink response. If this property is null then thesplash color of the theme,ThemeData.splashColor, will be used.

finalinherited

splashFactory→InteractiveInkFeatureFactory?

Defines the appearance of the splash.

finalinherited

statesController→MaterialStatesController?

Represents the interactive "state" of this widget in terms ofa set ofWidgetStates, likeWidgetState.pressed andWidgetState.focused.

finalinherited

Methods

build(BuildContextcontext)→Widget

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

inherited

createElement()→StatelessElement

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

inherited

debugCheckContext(BuildContextcontext)→bool

Asserts that the given context satisfies the prerequisites forthis class.

inherited

debugDescribeChildren()→List<DiagnosticsNode>

Returns a list ofDiagnosticsNode objects describing this node'schildren.

inherited

debugFillProperties(DiagnosticPropertiesBuilderproperties)→ void

Add additional properties associated with the node.

inherited

getRectCallback(RenderBoxreferenceBox)→RectCallback?

The rectangle to use for the highlight effect and for clippingthe splash effects ifcontainedInkWell is true.

inherited

noSuchMethod(Invocationinvocation)→ dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDiagnosticsNode({String?name,DiagnosticsTreeStyle?style})→DiagnosticsNode

Returns a debug representation of the object that is used by debuggingtools and byDiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevelminLevel =DiagnosticLevel.info})→String

A string representation of this object.

inherited

toStringDeep({StringprefixLineOne ='',String?prefixOtherLines,DiagnosticLevelminLevel =DiagnosticLevel.debug,intwrapWidth =65})→String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({Stringjoiner =', ',DiagnosticLevelminLevel =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 ==(Objectother)→bool

The equality operator.

inherited