SpeedDial class

Builds the Speed Dial

Inheritance

Constructors

SpeedDial({Key? key, List<SpeedDialChild> children = const [], bool visible = true, Color? backgroundColor, Color? foregroundColor, Color? activeBackgroundColor, Color? activeForegroundColor, Gradient? gradient, BoxShape gradientBoxShape = BoxShape.rectangle, double elevation = 6.0, double buttonSize = 56.0, Widget? dialRoot, bool useInkWell = false, double overlayOpacity = 0.8, Color? overlayColor, String? tooltip, String? heroTag, AnimatedIconData? animatedIcon, IconThemeData? animatedIconTheme, IconData? icon, IconData? activeIcon, Widget? child, Widget? activeChild, bool useRotationAnimation = true, IconThemeData? iconTheme, Widget? label, Widget? activeLabel, Widget labelTransitionBuilder(Widget, Animation<double>)?, double marginBottom = 16, double marginEnd = 16, VoidCallback? onOpen, VoidCallback? onClose, SpeedDialOrientation orientation = SpeedDialOrientation.Up, bool closeManually = false, bool renderOverlay = false, ShapeBorder shape = const CircleBorder(), Curve curve = Curves.linear, VoidCallback? onPress, int animationSpeed = 150, ValueNotifier<bool>? openCloseDial, double childMarginBottom = 0, double childMarginTop = 0})

Properties

activeBackgroundColor → Color?
final
activeChild → Widget?
This is the active child of the FAB, if specified it will animate b/w this and the child.
final
activeForegroundColor → Color?
final
activeIcon → IconData?
The active icon of the main button, Defaults to icon if not specified, ignored if animatedIcon is non null.
final
activeLabel → Widget?
The active label of the main button, Defaults to label if not specified.
final
animatedIcon → AnimatedIconData?
The animated icon to show as the main button child. If this is provided the child is ignored.
final
animatedIconTheme → IconThemeData?
The theme for the animated icon.
final
animationSpeed → int
The speed of the animation in milliseconds
final
backgroundColor → Color?
final
buttonSize → double
final
child → Widget?
This is the child of the FAB, if specified it will ignore icon, activeIcon.
final
childMarginBottom → double
The bottom margin of each child
final
childMarginTop → double
The top margin of each child
final
children → List<SpeedDialChild>
Children buttons, from the lowest to the highest.
final
closeManually → bool
If true user is forced to close dial manually by tapping main button. WARNING: If true, overlay is not rendered.
final
curve → Curve
The curve used to animate the button on scrolling.
final
dialRoot → Widget?
If Provided then it will replace the default Floating Action Button and will show the Widget Specified as dialRoot instead, it will also ignore backgroundColor, foregroundColor or any other property that was specific to FAB before like onPress, you will have to provide it again to your dialRoot button.
final
elevation → double
final
foregroundColor → Color?
final
gradient → Gradient?
final
gradientBoxShape → BoxShape
final
hashCode → int
The hash code for this object.
no setterinherited
heroTag → String?
final
icon → IconData?
The icon of the main button, ignored if animatedIcon is non null.
final
iconTheme → IconThemeData?
The theme for the icon generally includes color and size.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label → Widget?
The label of the main button.
final
labelTransitionBuilder → (Widget Function(Widget, Animation<double>)?)
Transition Builder between label and activeLabel, defaults to FadeTransition.
final
marginBottom → double
final
marginEnd → double
final
onClose → VoidCallback?
Executed when the dial is closed.
final
onOpen → VoidCallback?
Executed when the dial is opened.
final
onPress → VoidCallback?
Executed when the dial is pressed. If given, the dial only opens on long press!
final
openCloseDial → ValueNotifier<bool>?
Open or close the dial via a notification
final
orientation → SpeedDialOrientation
The orientation of the children. Default is SpeedDialOrientation.Up
final
overlayColor → Color?
The color of the background overlay.
final
overlayOpacity → double
The opacity of the background overlay when the dial is open.
final
renderOverlay → bool
If true overlay is rendered, no matter if closeManually is true or false.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shape → ShapeBorder
final
tooltip → String?
final
useInkWell → bool
If Provided then it will use Inkwell for onLongPress instead of GestureDetector on Top of Root Widget
final
useRotationAnimation → bool
If true then rotation animation will be used when animating b/w activeIcon and icon.
final
visible → bool
Used to get the button hidden on scroll. See examples for more info.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _SpeedDialState
Creates the mutable state for this widget at a given location in the tree.
override
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
noSuchMethod(Invocation invocation) → 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 debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
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.
inherited