IconButton class

A customizable button with an icon as its primary content.

IconButton provides a variety of styles, shapes, and behaviors to match your application's design needs. It offers multiple variants like primary, secondary, outline, ghost, link, text, and destructive styles, along with customizable sizing and interaction handling.

See also:

• doc/component/icon_button.md for more detailed documentation

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• IconButton

Available extensions

• AnimateWidgetExtensions
• DebugContainer
• IconExtension
• SkeletonExtension
• TextExtension
• WidgetExtension
• XAST
• XOnGestureWidget
• XSliverWidget
• XWidget
• XWidgetArcane
• XWidgetEdge
• XWidgetEffect
• XWidgetFrost
• XWidgetInvert
• XWidgetPixelate
• XWidgetPixelateBlur
• XWidgetRGB
• XWidgetWarp

Constructors

IconButton.new({Key? key, required Widget icon, AbstractButtonStyle variance = ButtonVariance.ghost, VoidCallback? onPressed, bool? enabled, Widget? leading, Widget? trailing, AlignmentGeometry? alignment, ButtonSize size = ButtonSize.normal, ButtonDensity density = ButtonDensity.icon, ButtonShape shape = ButtonShape.rectangle, FocusNode? focusNode, bool disableTransition = false, ValueChanged<bool>? onHover, ValueChanged<bool>? onFocus, bool trailingExpanded = false, bool? enableFeedback, GestureTapDownCallback? onTapDown, GestureTapUpCallback? onTapUp, GestureTapCancelCallback? onTapCancel, GestureTapDownCallback? onSecondaryTapDown, GestureTapUpCallback? onSecondaryTapUp, GestureTapCancelCallback? onSecondaryTapCancel, GestureTapDownCallback? onTertiaryTapDown, GestureTapUpCallback? onTertiaryTapUp, GestureTapCancelCallback? onTertiaryTapCancel, GestureLongPressStartCallback? onLongPressStart, GestureLongPressUpCallback? onLongPressUp, GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate, GestureLongPressEndCallback? onLongPressEnd, GestureLongPressUpCallback? onSecondaryLongPress, GestureLongPressUpCallback? onTertiaryLongPress})

Creates an IconButton with customizable properties.

const

IconButton.destructive({Key? key, required Widget icon, VoidCallback? onPressed, bool? enabled, Widget? leading, Widget? trailing, AlignmentGeometry? alignment, ButtonSize size = ButtonSize.normal, FocusNode? focusNode, bool disableTransition = false, ValueChanged<bool>? onHover, ValueChanged<bool>? onFocus, bool trailingExpanded = false, bool? enableFeedback, GestureTapDownCallback? onTapDown, GestureTapUpCallback? onTapUp, GestureTapCancelCallback? onTapCancel, GestureTapDownCallback? onSecondaryTapDown, GestureTapUpCallback? onSecondaryTapUp, GestureTapCancelCallback? onSecondaryTapCancel, GestureTapDownCallback? onTertiaryTapDown, GestureTapUpCallback? onTertiaryTapUp, GestureTapCancelCallback? onTertiaryTapCancel, GestureLongPressStartCallback? onLongPressStart, GestureLongPressUpCallback? onLongPressUp, GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate, GestureLongPressEndCallback? onLongPressEnd, GestureLongPressUpCallback? onSecondaryLongPress, GestureLongPressUpCallback? onTertiaryLongPress, AbstractButtonStyle variance = ButtonVariance.destructive, ButtonDensity density = ButtonDensity.icon, ButtonShape shape = ButtonShape.rectangle})

Creates a destructive IconButton.

const

IconButton.ghost({Key? key, required Widget icon, VoidCallback? onPressed, bool? enabled, Widget? leading, Widget? trailing, AlignmentGeometry? alignment, ButtonSize size = ButtonSize.normal, FocusNode? focusNode, bool disableTransition = false, ValueChanged<bool>? onHover, ValueChanged<bool>? onFocus, bool trailingExpanded = false, bool? enableFeedback, GestureTapDownCallback? onTapDown, GestureTapUpCallback? onTapUp, GestureTapCancelCallback? onTapCancel, GestureTapDownCallback? onSecondaryTapDown, GestureTapUpCallback? onSecondaryTapUp, GestureTapCancelCallback? onSecondaryTapCancel, GestureTapDownCallback? onTertiaryTapDown, GestureTapUpCallback? onTertiaryTapUp, GestureTapCancelCallback? onTertiaryTapCancel, GestureLongPressStartCallback? onLongPressStart, GestureLongPressUpCallback? onLongPressUp, GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate, GestureLongPressEndCallback? onLongPressEnd, GestureLongPressUpCallback? onSecondaryLongPress, GestureLongPressUpCallback? onTertiaryLongPress, AbstractButtonStyle variance = ButtonVariance.ghost, ButtonDensity density = ButtonDensity.icon, ButtonShape shape = ButtonShape.rectangle})

Creates a ghost-styled IconButton.

const

IconButton.link({Key? key, required Widget icon, VoidCallback? onPressed, bool? enabled, Widget? leading, Widget? trailing, AlignmentGeometry? alignment, ButtonSize size = ButtonSize.normal, FocusNode? focusNode, bool disableTransition = false, ValueChanged<bool>? onHover, ValueChanged<bool>? onFocus, bool trailingExpanded = false, bool? enableFeedback, GestureTapDownCallback? onTapDown, GestureTapUpCallback? onTapUp, GestureTapCancelCallback? onTapCancel, GestureTapDownCallback? onSecondaryTapDown, GestureTapUpCallback? onSecondaryTapUp, GestureTapCancelCallback? onSecondaryTapCancel, GestureTapDownCallback? onTertiaryTapDown, GestureTapUpCallback? onTertiaryTapUp, GestureTapCancelCallback? onTertiaryTapCancel, GestureLongPressStartCallback? onLongPressStart, GestureLongPressUpCallback? onLongPressUp, GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate, GestureLongPressEndCallback? onLongPressEnd, GestureLongPressUpCallback? onSecondaryLongPress, GestureLongPressUpCallback? onTertiaryLongPress, AbstractButtonStyle variance = ButtonVariance.link, ButtonDensity density = ButtonDensity.icon, ButtonShape shape = ButtonShape.rectangle})

Creates a link-styled IconButton.

const

IconButton.outline({Key? key, required Widget icon, VoidCallback? onPressed, bool? enabled, Widget? leading, Widget? trailing, AlignmentGeometry? alignment, ButtonSize size = ButtonSize.normal, FocusNode? focusNode, bool disableTransition = false, ValueChanged<bool>? onHover, ValueChanged<bool>? onFocus, bool trailingExpanded = false, bool? enableFeedback, GestureTapDownCallback? onTapDown, GestureTapUpCallback? onTapUp, GestureTapCancelCallback? onTapCancel, GestureTapDownCallback? onSecondaryTapDown, GestureTapUpCallback? onSecondaryTapUp, GestureTapCancelCallback? onSecondaryTapCancel, GestureTapDownCallback? onTertiaryTapDown, GestureTapUpCallback? onTertiaryTapUp, GestureTapCancelCallback? onTertiaryTapCancel, GestureLongPressStartCallback? onLongPressStart, GestureLongPressUpCallback? onLongPressUp, GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate, GestureLongPressEndCallback? onLongPressEnd, GestureLongPressUpCallback? onSecondaryLongPress, GestureLongPressUpCallback? onTertiaryLongPress, AbstractButtonStyle variance = ButtonVariance.outline, ButtonDensity density = ButtonDensity.icon, ButtonShape shape = ButtonShape.rectangle})

Creates an outlined IconButton.

const

IconButton.primary({Key? key, required Widget icon, VoidCallback? onPressed, bool? enabled, Widget? leading, Widget? trailing, AlignmentGeometry? alignment, ButtonSize size = ButtonSize.normal, FocusNode? focusNode, bool disableTransition = false, ValueChanged<bool>? onHover, ValueChanged<bool>? onFocus, bool trailingExpanded = false, bool? enableFeedback, GestureTapDownCallback? onTapDown, GestureTapUpCallback? onTapUp, GestureTapCancelCallback? onTapCancel, GestureTapDownCallback? onSecondaryTapDown, GestureTapUpCallback? onSecondaryTapUp, GestureTapCancelCallback? onSecondaryTapCancel, GestureTapDownCallback? onTertiaryTapDown, GestureTapUpCallback? onTertiaryTapUp, GestureTapCancelCallback? onTertiaryTapCancel, GestureLongPressStartCallback? onLongPressStart, GestureLongPressUpCallback? onLongPressUp, GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate, GestureLongPressEndCallback? onLongPressEnd, GestureLongPressUpCallback? onSecondaryLongPress, GestureLongPressUpCallback? onTertiaryLongPress, AbstractButtonStyle variance = ButtonVariance.primary, ButtonDensity density = ButtonDensity.icon, ButtonShape shape = ButtonShape.rectangle})

Creates a primary colored IconButton.

const

IconButton.secondary({Key? key, required Widget icon, VoidCallback? onPressed, bool? enabled, Widget? leading, Widget? trailing, AlignmentGeometry? alignment, ButtonSize size = ButtonSize.normal, FocusNode? focusNode, bool disableTransition = false, ValueChanged<bool>? onHover, ValueChanged<bool>? onFocus, bool trailingExpanded = false, bool? enableFeedback, GestureTapDownCallback? onTapDown, GestureTapUpCallback? onTapUp, GestureTapCancelCallback? onTapCancel, GestureTapDownCallback? onSecondaryTapDown, GestureTapUpCallback? onSecondaryTapUp, GestureTapCancelCallback? onSecondaryTapCancel, GestureTapDownCallback? onTertiaryTapDown, GestureTapUpCallback? onTertiaryTapUp, GestureTapCancelCallback? onTertiaryTapCancel, GestureLongPressStartCallback? onLongPressStart, GestureLongPressUpCallback? onLongPressUp, GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate, GestureLongPressEndCallback? onLongPressEnd, GestureLongPressUpCallback? onSecondaryLongPress, GestureLongPressUpCallback? onTertiaryLongPress, AbstractButtonStyle variance = ButtonVariance.secondary, ButtonDensity density = ButtonDensity.icon, ButtonShape shape = ButtonShape.rectangle})

Creates a secondary colored IconButton.

const

IconButton.text({Key? key, required Widget icon, VoidCallback? onPressed, bool? enabled, Widget? leading, Widget? trailing, AlignmentGeometry? alignment, ButtonSize size = ButtonSize.normal, FocusNode? focusNode, bool disableTransition = false, ValueChanged<bool>? onHover, ValueChanged<bool>? onFocus, bool trailingExpanded = false, bool? enableFeedback, GestureTapDownCallback? onTapDown, GestureTapUpCallback? onTapUp, GestureTapCancelCallback? onTapCancel, GestureTapDownCallback? onSecondaryTapDown, GestureTapUpCallback? onSecondaryTapUp, GestureTapCancelCallback? onSecondaryTapCancel, GestureTapDownCallback? onTertiaryTapDown, GestureTapUpCallback? onTertiaryTapUp, GestureTapCancelCallback? onTertiaryTapCancel, GestureLongPressStartCallback? onLongPressStart, GestureLongPressUpCallback? onLongPressUp, GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate, GestureLongPressEndCallback? onLongPressEnd, GestureLongPressUpCallback? onSecondaryLongPress, GestureLongPressUpCallback? onTertiaryLongPress, AbstractButtonStyle variance = ButtonVariance.text, ButtonDensity density = ButtonDensity.icon, ButtonShape shape = ButtonShape.rectangle})

Creates a text-styled IconButton.

const

Properties

alignment → AlignmentGeometry?

Alignment of the button content.

final

asBuilder → NeverWidgetBuilder

Available on Widget, provided by the WidgetExtension extension

no setter

asSliver → Widget

Available on Widget, provided by the XWidgetArcane extension

no setter

ast → Widget

Available on Widget, provided by the XAST extension

no setter

base → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

black → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

blockQuote → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

blurIn → Widget

Available on Widget, provided by the XWidgetEffect extension

no setter

bold → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

centered → Widget

Available on Widget, provided by the XWidget extension

no setter

density → ButtonDensity

Density/padding of the button.

final

disableTransition → bool

Whether to disable transition animations.

final

ellipsis → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

enabled → bool?

Whether the button is enabled.

final

enableFeedback → bool?

Whether to enable tap feedback.

final

expand → Widget

Available on Widget, provided by the XWidget extension

no setter

extraBold → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

extraLight → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

firstP → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

flexible → Widget

Available on Widget, provided by the XWidget extension

no setter

focusNode → FocusNode?

Focus node for controlling button focus.

final

foreground → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

h1 → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

h2 → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

h3 → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

h4 → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

hashCode → int

The hash code for this object.

no setter, inherited

icon → Widget

The icon to display in the button.

final

ih → Widget

Available on Widget, provided by the XWidgetArcane extension

no setter

inlineCode → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

intrinsicHeight → Widget

Available on Widget, provided by the XWidget extension

no setter

intrinsicSize → Widget

Available on Widget, provided by the XWidget extension

no setter

intrinsicWidth → Widget

Available on Widget, provided by the XWidget extension

no setter

italic → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

iw → Widget

Available on Widget, provided by the XWidgetArcane extension

no setter

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

large → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

lead → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

leading → Widget?

Widget to display before the icon.

final

li → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

light → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

medium → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

modify → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

mono → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

muted → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

normal → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

onFocus → ValueChanged<bool>?

Function called when focus state changes.

final

onHover → ValueChanged<bool>?

Function called when hover state changes.

final

onLongPressEnd → GestureLongPressEndCallback?

Called when a long press gesture is completed.

final

onLongPressMoveUpdate → GestureLongPressMoveUpdateCallback?

Called when a long press drag moves.

final

onLongPressStart → GestureLongPressStartCallback?

Called when a long press gesture has started.

final

onLongPressUp → GestureLongPressUpCallback?

Called when a long press gesture is ended.

final

onPressed → VoidCallback?

Function to call when the button is pressed.

final

onSecondaryLongPress → GestureLongPressUpCallback?

Called when a secondary long press gesture is ended.

final

onSecondaryTapCancel → GestureTapCancelCallback?

Called when a secondary tap has been canceled.

final

onSecondaryTapDown → GestureTapDownCallback?

Called when a secondary pointer that might cause a tap has contacted the screen.

final

onSecondaryTapUp → GestureTapUpCallback?

Called when a secondary pointer that triggered a tap has stopped contacting the screen.

final

onTapCancel → GestureTapCancelCallback?

Called when a tap has been canceled.

final

onTapDown → GestureTapDownCallback?

Called when a pointer that might cause a tap has contacted the screen.

final

onTapUp → GestureTapUpCallback?

Called when a pointer that triggered a tap has stopped contacting the screen.

final

onTertiaryLongPress → GestureLongPressUpCallback?

Called when a tertiary long press gesture is ended.

final

onTertiaryTapCancel → GestureTapCancelCallback?

Called when a tertiary tap has been canceled.

final

onTertiaryTapDown → GestureTapDownCallback?

Called when a tertiary pointer that might cause a tap has contacted the screen.

final

onTertiaryTapUp → GestureTapUpCallback?

Called when a tertiary pointer that triggered a tap has stopped contacting the screen.

final

p → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

primaryForeground → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

safeArea → Widget

Available on Widget, provided by the XWidget extension

no setter

sans → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

scrollable → Widget

Available on Widget, provided by the XWidget extension

no setter

scrollableHorizontal → Widget

Available on Widget, provided by the XWidget extension

no setter

secondaryForeground → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

semiBold → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

shape → ButtonShape

Shape of the button (rectangle, rounded, circle).

final

singleLine → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

size → ButtonSize

Size of the button (small, normal, large).

final

small → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

textCenter → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

textEnd → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

textJustify → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

textLarge → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

textLeft → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

textMuted → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

textRight → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

textSmall → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

textStart → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

thin → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

trailing → Widget?

Widget to display after the icon.

final

trailingExpanded → bool

Whether the trailing widget should expand.

final

underline → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

variance → AbstractButtonStyle

The style variant of the button.

final

x2Large → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

x3Large → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

x4Large → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

x5Large → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

x6Large → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

x7Large → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

x8Large → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

x9Large → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

xLarge → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

xSmall → TextModifier

Available on Widget, provided by the TextExtension extension

no setter

Methods

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate

Available on Widget, provided by the AnimateWidgetExtensions extension

Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).

asSkeleton({bool enabled = true, bool leaf = false, Widget? replacement, bool unite = false, AsyncSnapshot? snapshot}) → Widget

Available on Widget, provided by the SkeletonExtension extension

asSkeletonSliver({bool enabled = true}) → Widget

Available on Widget, provided by the SkeletonExtension extension

build(BuildContext context) → Widget

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

override

center({Key? key}) → Widget

Available on Widget, provided by the WidgetExtension extension

clip({Clip clipBehavior = Clip.hardEdge}) → Widget

Available on Widget, provided by the WidgetExtension extension

clipOval({Clip clipBehavior = Clip.antiAlias}) → Widget

Available on Widget, provided by the WidgetExtension extension

clipPath({Clip clipBehavior = Clip.antiAlias, required CustomClipper<Path> clipper}) → Widget

Available on Widget, provided by the WidgetExtension extension

clipRRect({BorderRadiusGeometry borderRadius = BorderRadius.zero, Clip clipBehavior = Clip.antiAlias}) → Widget

Available on Widget, provided by the WidgetExtension extension

constrained({double? minWidth, double? maxWidth, double? minHeight, double? maxHeight, double? width, double? height}) → Widget

Available on Widget, provided by the WidgetExtension extension

createElement() → StatelessElement

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

inherited

debugContainer([Color color = Colors.red]) → Widget

Available on Widget, provided by the DebugContainer extension

debugDescribeChildren() → List<DiagnosticsNode>

Returns a list of DiagnosticsNode objects describing this node's children.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

excludeSkeleton({bool exclude = true}) → Widget

Available on Widget, provided by the SkeletonExtension extension

expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetExtension extension

iconDestructiveForeground() → Widget

Available on Widget, provided by the IconExtension extension

iconLarge() → Widget

Available on Widget, provided by the IconExtension extension

iconMedium() → Widget

Available on Widget, provided by the IconExtension extension

iconMutedForeground() → Widget

Available on Widget, provided by the IconExtension extension

iconPrimary() → Widget

Available on Widget, provided by the IconExtension extension

iconPrimaryForeground() → Widget

Available on Widget, provided by the IconExtension extension

iconSecondary() → Widget

Available on Widget, provided by the IconExtension extension

iconSecondaryForeground() → Widget

Available on Widget, provided by the IconExtension extension

iconSmall() → Widget

Available on Widget, provided by the IconExtension extension

iconX2Large() → Widget

Available on Widget, provided by the IconExtension extension

iconX2Small() → Widget

Available on Widget, provided by the IconExtension extension

iconX3Large() → Widget

Available on Widget, provided by the IconExtension extension

iconX3Small() → Widget

Available on Widget, provided by the IconExtension extension

iconX4Large() → Widget

Available on Widget, provided by the IconExtension extension

iconX4Small() → Widget

Available on Widget, provided by the IconExtension extension

iconXLarge() → Widget

Available on Widget, provided by the IconExtension extension

iconXSmall() → Widget

Available on Widget, provided by the IconExtension extension

ignoreSkeleton() → Widget

Available on Widget, provided by the SkeletonExtension extension

intrinsic({double? stepWidth, double? stepHeight}) → Widget

Available on Widget, provided by the WidgetExtension extension

intrinsicHeight() → Widget

Available on Widget, provided by the WidgetExtension extension

intrinsicWidth({double? stepWidth, double? stepHeight}) → Widget

Available on Widget, provided by the WidgetExtension extension

isSliver(BuildContext context) → bool

Available on Widget, provided by the XSliverWidget extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onDoublePressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

Adds a handler for double press/tap gestures.

onHover(void action(bool hovering)) → Widget

Available on Widget, provided by the XOnGestureWidget extension

Adds a handler for hover events.

onLongPressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

Adds a handler for long press gestures with the primary button.

onLongSecondaryPressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

Adds a handler for long press gestures with the secondary button.

onLongTertiaryPressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

Adds a handler for long press gestures with the tertiary button.

onPressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

Adds a handler for primary press/tap gestures (equivalent to onTap).

onSecondaryPressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

Adds a handler for secondary press gestures (equivalent to right-click).

onTertiaryPressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

Adds a handler for tertiary press gestures (equivalent to middle-click).

pad(double all) → Widget

Available on Widget, provided by the XWidget extension

padBottom(double value) → Widget

Available on Widget, provided by the XWidget extension

padLeft(double value) → Widget

Available on Widget, provided by the XWidget extension

padOnly({double left = 0, double top = 0, double right = 0, double bottom = 0}) → Widget

Available on Widget, provided by the XWidget extension

padRight(double value) → Widget

Available on Widget, provided by the XWidget extension

padTop(double value) → Widget

Available on Widget, provided by the XWidget extension

positioned({Key? key, double? left, double? top, double? right, double? bottom}) → Widget

Available on Widget, provided by the WidgetExtension extension

shadeEdge(double radius) → Widget

Available on Widget, provided by the XWidgetEdge extension

shadeFrost(double value) → Widget

Available on Widget, provided by the XWidgetFrost extension

shadeInvert() → Widget

Available on Widget, provided by the XWidgetInvert extension

shadePixelate(double radius) → Widget

Available on Widget, provided by the XWidgetPixelate extension

shadePixelateBlur({int samples = 4, double pixelSize = 8, double radius = 2}) → Widget

Available on Widget, provided by the XWidgetPixelateBlur extension

shadeRGB({double radius = 5, double spin = 1}) → Widget

Available on Widget, provided by the XWidgetRGB extension

shadeWarp({double amplitude = 1, double frequency = 1, double z = 1, int octaves = 2}) → Widget

Available on Widget, provided by the XWidgetWarp extension

shadeWarpAnimation({double amplitude = 1, double frequency = 1, double z = 1, double zSpeed = 1, int octaves = 2}) → Widget

Available on Widget, provided by the XWidgetWarp extension

shimmer({bool loading = true}) → Widget

Available on Widget, provided by the XWidgetArcane extension

sized({double? width, double? height}) → Widget

Available on Widget, provided by the WidgetExtension extension

sized({double? width, double? height}) → Widget

Available on Widget, provided by the XWidget extension

then(InlineSpan span) → Widget

Available on Widget, provided by the TextExtension extension

thenButton({required VoidCallback onPressed, required Widget child}) → Widget

Available on Widget, provided by the TextExtension extension

thenInlineCode(String text) → Widget

Available on Widget, provided by the TextExtension extension

thenText(String text) → Widget

Available on Widget, provided by the TextExtension extension

toBox(BuildContext context, {bool softWarn = true}) → Widget

Available on Widget, provided by the XSliverWidget extension

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

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toSliver(BuildContext context, {bool fillRemaining = false, bool softWarn = true}) → Widget

Available on Widget, provided by the XSliverWidget extension

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

A string representation of this object.

inherited

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → 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

transform({Key? key, required Matrix4 transform}) → Widget

Available on Widget, provided by the WidgetExtension extension

withAlign(AlignmentGeometry alignment) → Widget

Available on Widget, provided by the WidgetExtension extension

withMargin({double? top, double? bottom, double? left, double? right, double? horizontal, double? vertical, double? all}) → Widget

Available on Widget, provided by the WidgetExtension extension

withOpacity(double opacity) → Widget

Available on Widget, provided by the WidgetExtension extension

withPadding({double? top, double? bottom, double? left, double? right, double? horizontal, double? vertical, double? all, EdgeInsetsGeometry? padding}) → Widget

Available on Widget, provided by the WidgetExtension extension

withTooltip(String tooltip) → Widget

Available on Widget, provided by the XWidgetArcane extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited