Welcome to FLUF, the package that provides convenience functions to develop your Flutter app. FLUF means Flutter Leveraging User Functions.

Features

Animated Widgets

These widgets extend from BaseAnimatedWidget which holds a Flutter AnimationController.

• FlingWidget
• RevealWidget

Extensions

AsyncSnapshot extensions

• isReady(): shortcut for snapshot's connection state == done and snapshot has data
• isLoading(): shortcut for snapshot's connection state == waiting
• isComplete():

BoxConstraints extensions

• areMaxConstraintsValid: maximum dimensions are finite
• areMinConstraintsValid: minimum dimensions are finite

BrightnessExtensions

• isDark

BuildContext extensions

• breakpoint : current screen width Breakpoint
• brightness : platform brightness setting
• colorScheme: shortcut for Theme.of(context).colorScheme
• desiredBrightness : desired user-defined brightness through [BuildContextOverride.themeMode]
• devicePixelRatio : number of device pixels for each logical pixel
• fadeTo(Widget): push and replace current widget with given Widget with fade animation
• getHorizontalPadding(bodyWidthRatio) : horizontal padding with desired body width ratio of screen width
• getHorizontalPaddingEdgeInsets(context) : get recommended horizontal padding depeneding on current breakpoint
• locale: shortcut for Localizations.localeOf(this)
• mediaQuerySize : size
• navigator: shortcut for Navigator.of(BuildContext)
• orientation : orientation
• pop(): shortcut for Navigator.of(BuildContext).pop()
• renderRepaintBoundary : return this context's [RenderObject] as [RenderRepaintBoundary?]
• revealFrom(Widget, Duration, Alignment): reveal (scale and translate) Widget from Alignment corner
• showSnackBar(Widget, bool? floating) : show a SnackBar using context`s ScaffoldMessenger
• slideTo(Widget, Duration, Axis): push Widget with slide animation
• textTheme : shortcut for Theme.of(context).textTheme
• theme : shortcut for Theme.of(context)

Color extensions

• minusDelta(int): color with subtracted delta in each of RGB values
• plusDelta(int): color with added delta in each of RGB values
• asPressableProperty(): WidgetStateProperty with reduced opacity for pressed state
• deltaWithBrightnessOf(BuildContext context, int delta, bool? inverse): apply delta depending on platform brightness setting

DateTime extensions

• isDayMonthToday: if this date's day and month match today's ones
• dayOfYear

Duration extensions

• hms(): format as HH:MM:SS String

double extensions

• seconds: equivalent Duration object from seconds value

GlobalKey extensions

• center: global center position as Offset? of this key's Widget

int extensions

• milliseconds : equivalent Duration object from milliseconds value
• ms : shortcut for milliseconds
• seconds : equivalent Duration object from seconds value
• isLeapYear
• daysInYear : number of days in year, depending on leap years

List extensions

• getMainDiagonalIntersections(): indexes list of diagonals intersecting the main diagonal, if the list can be represented as a 2 dimensional array, returns null otherwise. E.g: [0, 1, 2, 3].getMainDiagonalIntersections() returns [[0], [1,2], [3]].

• getHorizontalIntersections(): indexes list of horizontal intersections of the 2 dimensional array.

• containsValue: perform value-based comparison to look for an item in a list, instead of reference-based.

• findClosestIndex(double value): returns index of closest item to value, or -1 if no item can't be found

• findContainingIndexes(double target): finds indexes of items where value lies in between

• randomElement() : returns a random element within this list

TimeOfDay extensions

• inMinutes : in minutes
• toUTC(offset) : in UTC time
• toLocal(offset) : in local time

Object scope extensions

• let(R Function(T)): invoke lambda passing receiver object and return lambda's result
• also(void Function(T)): invoke lambda passing receiver object, and return this object
• asWidgetStateProperty(Map<WidgetState, T>): map object as WidgetStateProperty
• logType(String): log a message using dart:developer's log with name attribute set to object's runtimeType
• tryCast<T> : attempt cast to type, returns null on failure

String extensions

• toParagraph(): map to dart:ui Paragraph
• async color(): compute average color (for emojis)
• sizeOfStyle(TextStyle?): compute size spanned by this string with given style
• captialize : make first character upper case
• captitalizeAll : make first character of all space-separated items uppercase
• toUri : parse this [String] as [Uri]
• splitUpperCase([String delimiter = " "]) : split string at uppercase characters with optional delimiter. E.g: "camelCase" -> "camel Case"
• toClipboardData() : create a ClipboardData object with this as text
• copyToClipboard() : copy this string into the clipboard as clipboard data

TextStyle extensions

• bold(): copy of this TextStlye with bold font weight
• italic(): copy of this TextStlye with italic font style
• underline(): copy of this TextStlye with underline decoration
• toUiTextStyle(): convert a Theme's text style to a Dart ui package's TextStyle

ScrollController extensions

• progress: current progress from 0.0 to 1.0.

PageController extensions

• atomicPage: current page index as non-nullable integer

RenderRepaintBoundary extensions

• toFile(directoryPath, filename, format): save this widget as image file

Route extensions

• isRoot: if the current route name denotes to '/'
• isNamed(String): if the route setting's name matches given value

Widget extensions

• addSemantics(label, hint, value): wrap widget into a Semantics widget
• toHero(Object? tag) : wrap into Hero. Do nothing and return this if tag is null.
• toMaterialHero(Object? tag) : wrap into a transparent Material widget, and into Hero. This extension is useful for Text widgets with different styles, or scenarri where the Hero transition underlines the animated widget with yellow lines, indicating that the source and target widgets differ. Do nothing and return this if tag is null.

UI

CustomPainter

• RayPainter
• WaterfallPainter : Emoji grid painter with waterfall animation

Helpers

Breakpoint :

• enum defining Material 3 screen width breakpoints

FutureHolder :

• Container for Future-s with ability to await/dispose them all on demand

WidgetBuilderFactory:

• buildLoadingState
• buildInfoState
• buildCenterChild(Breakpoint, Widget)

Repositories

AssetRepo:

• loadJsonList
• readFile
• readFileAsBytes

DateTimeRepo:

• now: now as DateTime according to local timezone
• nowDate: same as now with all time-related fields set to 0
• nowUtc: now as UTC DateTime
• epochMs: elapsed milliseconds since Unix epoch
• utcOffset: UTC offset in minutes

RandomRepo:

• nextInt(length)

ThemeRepo:

• lightTheme(): Material 3 light theme data
• darkTheme(): Material 3 dark theme data

ColorRepo

• colorOfEmoji(String): compute tint color of given String emoji

Mixins

AnimateOnPressMixin

• Set a value (origin 1.0) back and forth from press() to release() mixin calls. E.g : Create a widget that animates when it is pressed, and animates back once released.

IsolateMixin

• Use in combination with Isolates to conveniently wait for a return value

HapticFeedbackMixin

• lightHapticFeedback()
• mediumHapticFeedback()
• heavyHapticFeedback()
• selectionHapticFeedback()
• vibrateFeedback()

Widgets

• Shimmer : manages a shimmering shine onto multiple ShimmerLoadingWidget
• ShimmerLoadingWidget : a wrapper for a single widget with a shimmering loading state