flutter_speed_dial 6.1.0+1
flutter_speed_dial: ^6.1.0+1 copied to clipboard
Flutter plugin to implement a beautiful and dynamic Material Design Speed Dial with labels, animated icons, multi-directional children and much more.
Flutter Speed Dial
Flutter package to render a Material Design Speed Dial.
Usage #
The SpeedDial widget is built to be placed in the Scaffold.floatingActionButton argument, replacing the FloatingActionButton widget.
You can set its position using Scaffold.floatingActionButtonLocation argument.
It can also be used with Scaffold.bottomNavigationBar and Snackbar.
Null safety is available from version 3.0.5 ( It is also backward compatible, meaning you can use it with non null safe code too )
Labels
SpeedDial can take any Widget as label SpeedDial will use Extended FloatingActionButton property if label is specified. It also have activeLabel property by which you can specify the label which is shown when SpeedDial is open. It also comes with its labelTransitionBuilder which defaults to fade transition.
Also Every child's button have label property which accepts String which can be styled by using labelStyle. If you want to specify a widget then you can use labelWidget.
If the label parameter is not provided, then the label will be not rendered.
Types of child for SpeedDial (Ordered by their priority)
Animated Icon using animatedIcon property
SpeedDial's AnimatedIcon has two specific parameters:
animatedIcontakes anAnimatedIconDatawidgetanimatedIconThemetakesIconThemeData
Widget using child & activeChild property
SpeedDial's Widget has two specific parameters:
childtakes a widget and is the default placeholder if dial is not open.activeChildtakes a widget and is the child's Widget which is used when dial is open, not required.
IconData using icon & activeIcon property
SpeedDial's IconData has three specific parameters:
icontakes aIconDataand is the default placeholder if dial is not open.activeIcontakes aIconDataand is the child's IconData which is used when dial is open, not required.iconThemetakes itsIconThemeDatawhich includes color and size.
The package will handle the animation by itself.
Handle spacing
There are various properties for SpeedDial by which you can adjust the spacing:
-
spacing- This parameter handles the space b/w speed dial and its children. -
spaceBetweenChildren- As the name suggests, this is used to adjust the space b/w every child element -
childPadding- This will adjust the padding of children speed dial button, this will help you to control the size of the children button more effectively. -
childMargin- This will help you to adjust the margin b/w children speed dial button and its label.
Close on WillPop
Closes automatically on back button press, if dial is open.
If you don't want this behaviour then simply change the value of closeDialOnPop to false.
How to use openCloseDial property:
- Create a value notifier named
isDialOpen:
ValueNotifier<bool> isDialOpen = ValueNotifier(false);
- Then set
openCloseDialtoisDialOpenin yourSpeedDial:
SpeedDial(
...
openCloseDial: isDialOpen,
...
)
- Now you can change the state of dial open:
isDialOpen.value = false;
Example Usage
See Example Code for more info.
Issues & Feedback #
Please file an issue to send feedback or report a bug,
If you want to ask a question or suggest an idea then you can open an discussion.
Thank you!
Contributing #
Every pull request is welcome.