velocity_x library Null safety

Classes

AStack
HeightBox
SizedBox widget with specific height
HStack
A widget that displays its children in a horizontal array. [...]
MaterialResponsiveUiData
A class that can be queried for breakpoints based on the guidelines in https://material.io/guidelines/layout/responsive-ui.html .
MobileDeviceInfo
Combines MobileDeviceType and MobileDeviceSize.
PKCardPageSkeleton
PKCardPageSkeleton can be used to provide a Card Page loading card with PKSkeleton cool animation.
PKCardProfileSkeleton
PKCardProfileSkeleton can be used to provide a profile loading card with PKSkeleton cool animation.
RenderVxAppBarTitleBar
SquareBox
SizedBox widget with equal width & height
VelocityTwoIconColumn
Can be used for two widgets and one icon together vertically .
VelocityXTextSpan
VStack
A widget that displays its children in a vertical array. [...]
VxAnimatedBox
VxAnimatedBox is similar to AnimatedContainer with the advantages of VxBox
VxAnimatedHeightView<T extends Widget>
VxAppBar
The VxAppBar displays the toolbar widgets, leading, title, and actions, above the bottom (if any). The bottom is usually used for a TabBar.
VxAppBarTitleBar
VxArc
VxArcClipper
VxBadge
VxBadge widget for using common badges as number or dot.
VxBevel
VxBlock
A widget that displays its children in a one-dimensional array. [...]
VxBox
A convenience widget that combines common painting, positioning, and sizing widgets. [...]
VxBuilder<T>
A stream builder like widget that accepts mutations and rebuilds after their execution.
VxCapsule
VxCard
A material design card: a panel with slightly rounded corners and an elevation shadow. [...]
VxCircle
VxClipShadow
VxClipShadowPainter
VxConditional
Runs a WidgetBuilder's result if the condition is true. [...]
VxConditionalSwitch
Renders widgets based on switch case conditions Example: [...]
VxConsumer<T>
A stream builder like widget that accepts mutations and rebuilds after their execution.
VxContinuousRectangle
VxDash
VelocityX widget to show Dashes with gaps if needed. It can be vertical or horizontal.
VxDecimalList
VxDecimalList is inspired from html where you can have a numeric index with an item (string) Use VxDecimalList to have a list of strings with index.
VxDevice
VxDevice widget can be used for making responsive apps based on if it's mobile or web. In case, if you want more options based on window size, use VxResponsive. You can specify two widgets depends on the screen size mobile and web. They must not be null.
VxDiagonal
VxDiagonalClipper
A widget that clips its child diagonally. Diagonal clipping starts from the position in the axis ends up clipHeight distance from the opposite position
VxDiscList
VxDiscList is inspired from html where you can have a circular disk with an item (string) Use VxDiscList to have a list of strings with circular disk of boxes with a defined color.
VxDivider
VxEllipse
VxEnsureVisibleWhenFocused
Helper class that ensures a Widget is visible when it has the focus For example, for a TextFormField when the keyboard is displayed [...]
VxGlassmorphic
VxHalfClipper
VxInformationParser
VxInlineBlock
VxInnerShadow
VxInterceptor
Implementation of this class can be used to act before or after a mutation execution.
VxLayout
VxLayout is a type of LayoutBuilder with some additional power
VxMarquee
VxMarqueeState
VxMutation<T extends VxStore?>
An implementation of this class holds the logic for updating the VxStore.
VxNavConfig
allow you to interact with the List of pages
VxNavigator
VxNeumorph
VxNeumorph class to accept list of shadows and a Gradient
VxNotifier
Helper widget that executes the provided callbacks with context on execution of the mutations. Useful to show SnackBar or navigate to a different route after a mutation.
VxObserver
An observer of changes in navigation. [...]
VxPasswordPainter
VxPinView
VxPinView to give a widget where OTP or Pin screen can be created easily
VxPinViewState
VxPlatform<A extends Widget, I extends Widget, W extends Widget, D extends Widget>
Sample [...]
VxPopupMenu
VxPopupMenu can help you in creating custom popup menus using overlay entry.
VxPopupMenuController
VxPopupMenuController gives you access to hide the menu or toggle it using showMenu, hideMenu & toggleMenu.
VxRandomBox
A Container Widget that takes up a given width and height and paints itself with a random color.
VxRating
VxRating widget to show ratings to the user and the user can change it too. Fully customizable
VxRelayingNavigatorObserver
Passes on navigation events to a list of NavigatorObserver objects.
VxResponsive
VelocityResponsive widget can be used for making responsive apps based on different window sizes. You can specify multiple widgets depends on the screen size like xsmall, small, medium,large, and xlarge. The fallback must not be null. It will be replaced if you don't specity any above widget.
VxRichText
Creates a AutoSizeText widget with a TextSpan.
VxRoutePage
VxScrollHorizontal
Widget to directly access SingleChildScrollView horizontally.
VxScrollVertical
Widget to directly access SingleChildScrollView vertically.
VxSelectableTextBuilder
A run of selectable text with a single style. [...]
VxShifter
Use it to pin and shift widget useful for making complex ui Eg Container( height: 200, width: 200, decoration: BoxDecoration(shape: BoxShape.circle, color: Color(0xffE0D8F9) ), ).shift(100, alignment: Alignment.bottomRight) ,
VxShimmer
VxShimmer widget can be used to provide shimmer effect to any widget.
VxSizeConfig
VxSkeleton
To show skeleton with any widget.
VxSkeletonState
VxState
The coordinating widget that keeps track of mutations and the notify the same to the listening widgets.
VxStepper
VxStepper widget to have a input enabled counter with 2 buttons, one for addition and one for subtraction with good level of customization.
VxStepperState
VxStore
App's store should extend this class. An instance of this class is given to VxState while initialization only once.
VxSwiper
Use this widget VxSwiper to give your list a swipeable effect with full customization.
VxTable
A widget that uses the table layout algorithm for its children.
VxTextBuilder
Flutter widget that automatically resizes text to fit perfectly within its bounds. [...]
VxTextDropDown
A material design button for selecting from a list of items. [...]
VxTextField
An easy to use implementation of TextField with ready to use props.
VxTicket
VxTimeline
To show a timeline view with filled dot, header and description. Great for showing something like a history
VxTimelineModel
VxTimerButton
Read button
VxTimerButtonState
VxTriangle
VxTwo
Can be used for two texts together vertically or horizontally.
VxTwoColumn
Can be used for two widgets together vertically.
VxTwoRow
Can be used for two widgets together horizontally.
VxZeroCard
VxZeroCard can be used to provide a single loading card with PKSkeleton cool animation.
VxZeroList
VxZeroList can be used to provide a list of loading cards with PKSkeleton cool animation.
WidthBox
SizedBox widget with specific width
ZStack
A widget that positions its children relative to the edges of its box. [...]

Mixins

Vx
Mixin Vx provides basic operations and utilities
VxBottomSheet
VxDialog
VxDrawer
VxEffects<ON>
Secondary mutation executed based on the result of the first. Similar to chaining actions in Redux. For example, an http request will have a success or a fail side effect after request is complete.
VxPreview
VxToast

Extensions

AnimatedContainerWidgetExtension
BadgeExtension
BoolExtension
CardExtension
CenterBuilderExtension
CenterExtension
Center the widget
ContainerWidgetExtension
ContextExtensions
Extensions for general basic Context
DateTimeExtension
Date Time Extension Methods
GestureExtensions
GlassWidgetExtension
IntExtension
Extension method for integers.
IterableBasics
Utility extension methods for the native Iterable class.
IterableBasics2
IterableOfDoubleSC
IterableOfIntSC
ListStringExtension
ListWidgetExtension
Extension Methods for List of widgets.
MarqueeExtension
NullableStringIsEmptyOrNotNullExtension
NullableStringIsEmptyOrNullExtension
NumExtension
Extension Methods & Widgets for the numbers
NumIterableBasics
Utility extension methods for Iterables containing nums.
ObjectExtensions
Extension Methods for Alignment of the objects.
OpacityExtension
Extension method for providing opacity on the top of widgets
PaddingExtensions
Extension to provide Padding to any widget.
RandomContainerWidgetExtension
Random Color box extension method
RoutesWidgetsExtension
ScrollControllerExtension
Extensions for ScrollController
ScrollExtension
Extension method to directly access SingleChildScrollView with any widget without wrapping or with dot operator.
SelectableTextExtensions
ShapesExtension
ShiftWidgetExt
ShimmerExtension
SizedBoxExtension
A box with a specified size. [...]
SkeletonExtension
StringExtension
Extension Methods & Widgets for the strings
StringWidgetsExtension
TableExtensions
TextExtensions
ThemeExtension
Extension method to directly access material Theme with any widget without wrapping or with dot operator.
ToastExtension
TransformExtension
Extension method to directly transform any widget without wrapping or with dot operator.
VelocityXRichTextExtension
VelocityXTextSpanExtension
VxIcon
Extension method to directly access Icon.
WidgetsExtension

Functions

asyncGuard<T>(Future<T> callback(), [T? defaultValue]) Future<T?>
Evaluates the function asynchonically wrapping the body with try/catch and returns default value if error was raised or return value is null Originally available at https://pub.dev/packages/guard
getView(dynamic child) Widget
guard<T>(T callback(), [T? defaultValue]) → T?
Evaluates the function wrapping the body with try/catch and returns default value if error was raised or return value is null Originally available at https://pub.dev/packages/guard
myBoxDec(dynamic animation, {dynamic isCircle = false, dynamic isDark = false}) Decoration
myBoxDesc to reuse with PKSkeleton
withAnimation<T>({required TickerProvider vsync, required Tween<T> tween, required AnimationUpdateCallBack<T?> callBack, Duration duration = const Duration(seconds: 1), double initialValue = 0.0, Curve curve = Curves.linear, Animation? customAnimation}) AnimationController
To perform forward animation in a simpler way
withRepeatAnimation<T>({required TickerProvider vsync, required Tween<T> tween, required AnimationUpdateCallBack<T?> callBack, Duration duration = const Duration(seconds: 1), double initialValue = 0.0, Curve curve = Curves.linear, double? lowerBound, double? upperBound, bool isRepeatReversed = false, Duration? repeatPeriod, Animation? customAnimation}) AnimationController
To perform repeat animation in a simpler way

Enums

MobileDeviceSize
Symbolic sizes of mobile devices. [...]
MobileDeviceType
Types of mobile devices. [...]
VxArcType
VxBadgePosition
VxBadgeType
VxClickType
Provide click type either longClick or singleClick
VxCurve
VxCurve to provide different types of curves to the neumorphic design. concave is default.
VxDiagonalPosition
Defines the corners of the child widget
VxDividerType
VxDrawerType
VxEdge
VxPinBorderType
VxPreviewIndicatorAxis
VxSkeletonAnimationType
VxStatus
Status about the current state
VxTextFieldBorderType
VxToastPosition
Toast position
VxToastType
VxWindowSize
Symbolic window sizes of mobile devices.

Typedefs

AnimationUpdateCallBack<T> = dynamic Function(T animationVal, double controllerVal)
ContextCallback = void Function(BuildContext context, VxMutation<VxStore?> mutation)
Function signature for the callback with context.
FnBuilderCallback = void Function()
VxMutationBuilder = VxMutation<VxStore?> Function()
Function signature for mutations that has deferred execution. VxMutation.next accepts functions with this signature.
VxPageBuilder = Page Function(Uri uri, dynamic params)
VxStateWidgetBuilder<T> = Widget Function(BuildContext context, T store, VxStatus? status)
VxWidgetBuilder gives context and status back. Status are more useful when you use vx effects