StarMenuParameters class
class which is used to feed StarMenu.params
- Annotations
Constructors
- StarMenuParameters({LinearShapeParams linearShapeParams = const LinearShapeParams(), CircleShapeParams circleShapeParams = const CircleShapeParams(), GridShapeParams gridShapeParams = const GridShapeParams(), BackgroundParams backgroundParams = const BackgroundParams(), MenuShape shape = MenuShape.circle, BoundaryBackground? boundaryBackground, bool useLongPress = false, Duration longPressDuration = const Duration(milliseconds: 500), double onHoverScale = 1.0, int openDurationMs = 400, int closeDurationMs = 150, double rotateItemsAnimationAngle = 0.0, double startItemScaleAnimation = 1.0, Offset centerOffset = Offset.zero, bool useScreenCenter = false, bool useTouchAsCenter = false, bool checkItemsScreenBoundaries = false, bool checkMenuScreenBoundaries = true, Curve animationCurve = Curves.fastOutSlowIn})
-
const
- StarMenuParameters.arc(ArcType type, {double radiusX = 130, double radiusY = 130})
-
preset to display items in an arc shape
factory
- StarMenuParameters.dropdown(BuildContext context)
-
preset to display a dropdown menu like
factory
- StarMenuParameters.panel(BuildContext context, {int columns = 3})
-
preset to display a grid menu inscribed into a card
factory
Properties
- animationCurve → Curve
-
Animation curve kind to use
final
- backgroundParams → BackgroundParams
-
parameters for the background
final
- boundaryBackground → BoundaryBackground?
-
put a background behind all the items boundary
final
- centerOffset → Offset
-
Shift offset of menu center from the center of parent widget
final
- checkItemsScreenBoundaries → bool
-
Checks if the whole menu boundaries exceed screen edges,
if so set it in place to be all visible
final
- checkMenuScreenBoundaries → bool
-
Checks if items exceed screen edges, if so set them in place to be visible
final
- circleShapeParams → CircleShapeParams
-
parameters for the circle shape
final
- closeDurationMs → int
-
Close animation duration
final
- gridShapeParams → GridShapeParams
-
parameters for the grid shape
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- linearShapeParams → LinearShapeParams
-
parameters for the linear shape
final
- longPressDuration → Duration
-
long press duration
final
- onHoverScale → double
-
scale item when mouse is hover (desktop only)
final
- openDurationMs → int
-
Open animation duration
final
- rotateItemsAnimationAngle → double
-
Starting rotation angle of the items that will
reach 0 DEG when animation ends
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shape → MenuShape
-
Menu shape kind: MenuShape.circle, MenuShape.linear, MenuShape.grid
final
- startItemScaleAnimation → double
-
Starting scale of the items that will reach 1 when animation ends
final
- useLongPress → bool
-
Use long press behavior instead of a tap to open the menu
final
- useScreenCenter → bool
-
Use the screen center instead of parent widget center
final
- useTouchAsCenter → bool
-
Use the touch coordinate as the menu center
final
Methods
-
copyWith(
{MenuShape? shape, BoundaryBackground? boundaryBackground, LinearShapeParams? linearShapeParams, CircleShapeParams? circleShapeParams, GridShapeParams? gridShapeParams, BackgroundParams? backgroundParams, bool? useLongPress, double? onHoverScale, Duration? longPressDuration, int? openDurationMs, int? closeDurationMs, double? rotateItemsAnimationAngle, double? startItemScaleAnimation, Offset? centerOffset, bool? useScreenCenter, bool? useTouchAsCenter, bool? checkItemsScreenBoundaries, bool? checkMenuScreenBoundaries, Curve? animationCurve}) → StarMenuParameters -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited