flutter_helper_utils 4.4.0 flutter_helper_utils: ^4.4.0 copied to clipboard
The Flutter Helper Utils Package offers various extensions and helper methods that can make development more efficient.
4.4.0 #
-
Added
copy
methods to all TextStyle properties in ThemeData (e.g.,displayLargeCopy
,headlineMediumCopy
, etc.). This allows to quickly use copyWith on text style with minimal code for example: Usetheme.displayLargeCopy(color: Colors.red)
instead oftheme.displayLarge?.copyWith(color: Colors.red)
-
Added
refresh
method to all specialized notifiers to allow forcenotifyListeners
without changing value ofValueNotifier
. -
Updated
dart_helper_util
to v1.2.0.
4.3.0 #
-
Added
setDart
,setLight
, andsetSystem
toBrightnessNotifier
, andThemeModeNotifier
. -
Added
modalRoute()
to the context extension for convenient access to the current ModalRoute. -
Added the
usePopUntil
parameter to thecontext.dismissActivePopup
(default:true
):- If
true
, usespopUntil
for efficient dismissal of multiple pop-ups. - If
false
, usesrecursion
(might be needed for compatibility reasons). - This provides flexibility for different navigation scenarios and compatibility needs.
- If
-
Updated
dart_helper_util
to v1.1.0.
4.2.0 #
- Enhancement to the
context.dismissActivePopup()
.
4.1.1 #
- Updated the README
4.1.0 #
Introducing dart_helper_utils
We've refactored the Dart-specific utilities into a new
package, dart_helper_utils
, to allow Dart projects to use these
utilities without depending on Flutter.
- No changes are needed from your side as
flutter_helper_utils
now exportsdart_helper_utils
internally.
New Features:
- BrightnessNotifier and ThemeModeNotifier for easy creation of
ValueNotifier
instances. - New extensions on
ThemeData
for quick access to common text styles (theme.bodySmall
) and brightness checks (isDark
,isLight
).
NOTES:
- All the Dart-specific utilities documentations moved to
the
dart_helper_utils
readme. - Future updates for Dart-specific utilities will be available in
the
dart_helper_utils
changelog. - Do NOT use the older versions (under 4.1.0) of this package
with
dart_helper_utils
as it may conflict with it.
4.0.1 #
- Fixed mime checks not exported.
4.0.0 #
New Features
- JSON Handling
- Encoding: Easily encode any object to JSON using the new
.encode()
method on any object. - Decoding: Decode JSON effortlessly with the
.decode()
method on String, e.g."[1,3,4]".decode();
.
- Encoding: Easily encode any object to JSON using the new
- ValueNotifier Helpers
- A comprehensive suite of tools for working with
ValueNotifier
- Specialized Notifiers: Type-safe notifiers like
BoolNotifier
,IntNotifier
, and more. .notifier
Extension: Quickly create notifiers from various types.- Enhanced Functionality: Added extension methods like
toggle
,round
, andincrement
toValueNotifier
subclasses. - Reactive Integration: Easily convert
ValueNotifier
into aStream
with thestream
extension. - Concise UI Building: The
.listenableBuilder
extension offers a shorter and more readable syntax compared to the traditionalValueListenableBuilder
.
- Specialized Notifiers: Type-safe notifiers like
- A comprehensive suite of tools for working with
Enhancements
-
Map Extension Improvements:
-
BREAKING CHANGE: Removed global functions
formattedJsonString
andmakeMapEncodable
. Introduced more intuitively named methods within a Map extension:makeEncodable
,safelyEncodedJson
, andencodedJson
forMap<K, V>
types.Migration Guide:
final myMap = { ... }; // BEFORE: makeMapEncodable(myMap); formattedJsonString(myMap); // NOW: myMap.makeEncodable; myMap.safelyEncodedJson;
-
-
MIME Type Checks on String:
- BREAKING CHANGE: Replaced
isValidVideo
,isValidHTML
,isValidAudio
,isValidImage
, andisValidSVG
with more streamlined methods:isVideo
,isHTML
,isAudio
,isImage
, andisSVG
. - Added a new
mimeType()
function that returns the MIME type for any given file path or URL, e.g.,'path.mp4'.mimeType()
returns'video/mp4'
. - Introduced new getters for various file types, enhancing the way file types are detected based on file paths or
URLs.
- These include checks for:
- Videos:
isVideo
,isMP4
,isMOV
, etc. - Images:
isImage
,isPNG
,isJPEG
, etc. - Documents:
isPDF
,isDOCX
,isTXT
, etc. - Audio:
isAudio
,isMP3
,isWAV
, etc. - Archives:
isArchive
,isZIP
,isRAR
, etc. - And more, allowing for straightforward usage like
'file.mp4'.isMP4
returningtrue
.
- Videos:
- These include checks for:
- BREAKING CHANGE: Replaced
Breaking Changes Summary
- Removed
formattedJsonString
andmakeMapEncodable
in favor of new methods within the Map extension. - Replaced various
isValid
MIME type checks with simpler and more intuitiveis
methods, e.g.isValidVideo -> isVideo
3.1.0 #
- UPDATE: Updated
asBool
in the objects.
3.0.7 #
- NEW: Added
getRandom
that can be used with any number to get random number from it.final random = 1000.getRandom;
3.0.6 #
- IMPORTANT fix to for the convert objects helper and static methods which makes the app freeze, if you are at '3.0.4' or '3.0.5', I encourage you to upgrade.
3.0.5 #
- Added isEqual to the
Set
,List
,Map
, and as global method.
3.0.4 #
- The
asGreeks
is no longer a getter, it's a function now that takes optionalfractionDigits
which lets you specify number of digits after the decimal point in the generated greek number. (asGreeks
used to Convert a number to a format that includes Greek symbols for thousands, millions, and beyond. e.g. '1000' asGreek is '1k')
3.0.3 #
NEW:
-
Introduced
formattedJsonString
global function for converting maps to a formatted/indented JSON strings, ensuring compatibility with complex types and ready to be used in logs output files. -
Added new
local
optional argument to thetoDateTime
andtryToDateTime
in both the static and global functions.
3.0.2 #
- UPDATE: Update docs for README, all ConvertObject's static methods, and add docs to all global functions.
3.0.0 #
-
BREAKING CHANGE:
-
NEW FEATURE:
- Added new
toUri
andtryToUri
in both theConvertObject
class and the global functions. - Introducing a new getter
domainName
in theUri
extension.
- Added new
-
ENHANCEMENTS: The
indexOfOrNull
method under Iterable Extensions now supports taking null values.
2.0.1 #
- NEW: Introducing Watcher state management, It's designed to be efficient, lightweight, and leverages native Flutter state management mechanisms. more here
1.6.0 #
-
BREAKING CHANGE: Upgraded to Flutter 3.16 and resolved a deprecation on the BuildContext extension for MediaQuery by changing
context.textScaleFactor
tocontext.textScaler
. -
NEW: added New getters to the BuildContext extension for MediaQuery to support all properties on MediaQuery even the nullable.
1.5.8 #
-
NEW: Added
makeMapEncodable
to our global helper methods. This function provides a convenient way to ensure all elements within a map are encodable to JSON format. -
UPDATE: Updated the
isValidUrl
function's regular expression to handle URLs with special characters like[]
and()
. This update addresses the issue of catastrophic backtracking, Which might cause freezing or performance issues.
1.5.7 #
- added
maybePop
to the Navigation extension to respectonWillPop
widget action. - Hosted new documentation website
1.5.6 #
- Added New Uri extension to help convert string (supports nullable strings) link to uri,
toUri
andtoPhoneUri
.
1.5.4 #
- Added a new
format
argument to thetoDateTime
andtryDateTime
methods, allowing you to specify the converted date format. - Updated and enhanced the entire documentation.
1.5.3 #
- Added global conversion functions mirroring the static methods in
ConvertObject
, providing alternative easy less code usage options.
For example:
// Use this shorter way to convert values.
final stringList = toList<String>(dynamicValue);
// If 'toList' name is already defined in your code, use this way to avoid conflicts.
final stringList = ConvertObject.toList<String>(dynamicValue);
1.5.1 #
- NEW: Added
dismissActivePopup
method to theNavigatorExtension
extension onBuildContext
. This method programmatically and recursively dismisses any active pop-up elements like dialogs, modal bottom sheets, and Cupertino modal popups. It checks for the typesPopupRoute
,DialogRoute
,RawDialogRoute
,ModalBottomSheetRoute
, andCupertinoModalPopupRoute
to determine if a pop-up is currently displayed and closes it. If multiple pop-ups are stacked, the method will recursively close all of them.
1.5.0 #
- UPDATE: update flutter version boundaries to be
sdk: '>=3.0.6 <4.0.0'
1.4.9 #
- FIX: Fixed
isTomorrow
,isToday
,isYesterday
getters in DateTime extensions.
1.4.8 #
-
BREAKING CHANGE: Renamed the
delay
function in the Duration extension to bedelayed
to avoid conflicts with other packages -
UPDATE: Updated the
remainingDays
,passedDays
getter in the DateTime extension to correctly consider the day ending at midnight. -
NEW: Added the
remainingDuration
,passedDuration
getter to the DateTime extension for calculating the remaining duration between two dates.
For example:
final date = DateTime(2030);
final remainingDuration = date.remainingDuration(DateTime.now());
1.4.7 #
- NEW: Added new function
toTitle
on String Extension which is similar totoTitleCase
but ignores the '-' and '_' characters. This is useful when users name events, products, etc. and want these characters to be shown in the correct format. For example,flutter-and-dart
becomesFlutter-And-Dart
when usingtoTitle
.
1.4.6 #
- FIX: Fixed a bug when using
listIndex
on ConvertObject functions that may cause the list return null.
1.4.5 #
- UPDATE: Enhanced the
asGreeks
getter to include all available Greek symbols for converting large numbers. Now, the symbols used are['K', 'M', 'B', 'T', 'Q', 'P', 'E', 'Z', 'Y']
. This allows for more accurate representation of large numbers, such as converting 1000000000 to 1.0B.
1.4.4 #
-
NEW: Added new extensions to the
String?
class:isValidIp4
,isValidIp6
, andisValidUrl
. These extensions provide convenient methods to check the validity of IPv4 addresses, IPv6 addresses, and URLs respectively. -
NEW: Introduced a new method called
popRoot
to theNavigatorExtension
. This method calls the normalpop
method but with therootNavigator
parameter set totrue
under the hood. This feature proves to be useful in scenarios where dialogs need to be dismissed.
1.4.3 #
-
NEW: The convert object methods now include an optional
listIndex
parameter, enabling the conversion of specific values within aList
. This enhancement provides flexibility by allowing developers to extract and convert targeted values based on the specifiedlistIndex
.For example:
dynamic object1 = ['John', '30', 'yes'];
final double age = ConvertObject.toDouble(object1, listIndex: 1); // 30.0
- NEW: The
List
extension now includes thefromIndex
method, providing null-safe retrieval of values at specific indices within a list. It returns null if the index is out of bounds or if the list is empty or null.
1.4.2 #
- UPDATE: Updated Documentation.
1.4.1 #
-
NEW: The convert object methods now include an optional
mapKey
parameter, enabling the conversion of specific values within a Map object. This enhancement provides flexibility by allowing developers to extract and convert targeted values based on the specifiedmapKey
.For example:
dynamic object1 = {'name': 'John', 'age': '30', 'isHuman': 'yes'};
final double age = ConvertObject.toDouble(object1, mapKey: 'age'); // 30.0
final bool isHuman = ConvertObject.toBool(object1, mapKey: 'isHuman'); // true
1.4.0 #
-
UPDATE: Removing support of Iterables and Maps from
toType
andtryToType
functions due to some restrictions in dart generics. Here is the list of the supported conversion types:bool
int
BigInt
double
num
String
DateTime
-
For Iterables and Maps, use the preferred methods from the
ConvertObject
class:- To convert to a
List
, useConvertObject.toList<String>(dynamicIterableData)
. - To convert to a
Set
, useConvertObject.toSet<String>(dynamicIterableData)
. - To convert to a
Map
, useConvertObject.toMap<String, int>(dynamicMapData)
.
- To convert to a
1.3.8 #
- BREAKING CHANGES: The navigation extension methods have been renamed to avoid conflicts with other packages, such
as
go_router
. Please update your codebase to use the new method names accordingly. - Renamed navigation extension methods:
context.push
changed tocontext.pushPage
context.pushReplacement
changed tocontext.pReplacement
context.pushAndRemoveUntil
changed tocontext.pAndRemoveUntil
context.pushNamedAndRemoveUntil
changed tocontext.pNamedAndRemoveUntil
context.pushNamed
changed tocontext.pNamed
context.pushReplacementNamed
changed tocontext.pReplacementNamed
- The
context.popPage
method remains unchanged since it has already been resolved in a previous version.
We apologize for any inconvenience caused by this breaking change. If you encounter any issues or need assistance, please don't hesitate to reach out.
1.3.7 #
- NEW: Introducing
toType
andtryToType
global functions. They allow converting a dynamic object to a specific typeT
and automatically detect the type, invoking the appropriate function from theConvertObject
class.
Sample:
dynamic data = 12.4;
final myInt = toType<int>(data); // tryToType behaves similarly but is null-safe
- NEW: Added
BigInt
andtryBigInt
in the ConvertObject class.BigInt
represents arbitrarily large integers. It is used when you need to perform operations on integers that exceed the maximum value that can be represented by the int type. It's IMPORTANT to note that BigInt operations can be computationally expensive, especially for very large integers. Therefore, use BigInt only when necessary, and be mindful of performance implications.
Sample:
String largeNum = '12434535367326235634';
final BigInt myBigInt = ConvertObject.toBigInt(largeNum);
// OR
final BigInt myBigInt = toType<BigInt>(largeNum);
- UPDATE: The
toList<T>
,tryToList<T>
,toSet<T>
andtryToSet<T>
functions now support converting any type ofIterable
.
1.3.6 #
- UPDATE: The
toList<T>
andtryToList<T>
functions now support converting map values to a list if the value's type matchesT
. This enhancement adds more flexibility and convenience when working with collections.
1.3.5 #
-
NEW: Added
showMaterialBanner
,showSnackBar
,hideCurrentMaterialBanner
,hideCurrentSnackBar
,removeCurrentMaterialBanner
,removeCurrentSnackBar
,clearMaterialBanners
,clearSnackBars
onBuildContext
. Usage example could be as easy ascontext.removeCurrentSnackBar
. -
NEW: Added
focusScope
,hasFocus
,unFocus
, andrequestFocus
call back on BuildContext.requestFocus
is commonly used to hide keyboard on onTap/onPress call. Usage could beonTap: () => context.requestFocus
oronTap: context.requestFocusCall
. -
NEW: Added new enum called
HttpResStatus
that contains all http response codes with description to each one, and also some helper getters such asisSuccessful
. Usage with http package could be:final res = await http.post(...); // assume it retrun res code 505 print(res.statusCode.toHttpResStatus); // will print "Insufficient Storage"
-
UPDATE: Used MediaQuery as InheritedModel to improve performance, see this pull in flutter for more info.
1.3.4 #
- NEW: Added
isValidHttpCode
innum?
extension that returns true if the http response code is 200 or 201. - NEW: Added
toDateWithFormat
in String extension that converts string toDateTime
with specific format e.g.,d-M-y
.
Usage:
final dateTime = '14-12-2030'.toDateWithFormat('d-M-y');
1.3.3 #
- NEW: Added
binary
in bool extension that returns1
if true and0
if false asint
.
1.3.2 #
- FIX: Fixed a bug when detecting
isIOSWeb
andisAndroidWeb
usingTargetPlatform
. - NEW: Added
isApple
that detects if the running device is made by apple e.g. MacOS, iPadOS, or iOS.
Usage:
context.isApple
// OR without context
defaultTargetPlatform.isApple // import 'package:flutter/foundation.dart';
1.3.1 #
- NEW: Added
toBool
to nullableObject?
.
Rules:
- Object is true only if
- Object is bool and true.
- Object is num and is greater than zero.
- Object is string and is equal to 'yes', 'true', or '1'.
- any other conditions including null will return false.
1.3.0 #
- HOT FIX: Fixed bool extension is not exported.
1.2.9 #
- NEW: Added
isTrue
, andisFalse
on nullable boolean, now if bool? is null the check will always return false instead of showing compile error.
1.2.8 #
- UPDATE: replace
isNegativeOrNull
,isPositiveOrNull
,isNotNegativeOrNull
,isNotPositiveOrNull
, andisNotZeroOrNull
with justisNegative
,isPositive
, andisZeroOrNull
in nullable numbers.
1.2.7 #
- NEW: Added an option to check the device type when running on web, e.g.
isMobileWeb
orisDesktopWeb
.
1.2.6 #
- NEW: Added
local
getter in datetime that call toLocal() on any dat, but it respects null safety.
1.2.5 #
- NEW: Added
tryRemoveAt
,indexOfOrNull
,indexWhereOrNull
, andtryRemoveWhere
onList<T>?
extension. - UPDATE: Update the package to FlutterSDK 3.10.
- FIX: Fixed a bug with
isNotNull
onObject
extension.
1.2.4 #
- NEW: Added
DatesHelper
class that provide a set of static methods for DateTime such asisSameHour
,diffInDays
, anddaysInRange
. - NEW: Added the getters
isPresent
,isPast
,passedDuration
,remainingDays
, and more to theDateTime
extension.- Now you can get formatted date using the format method directly in any date e.g
DateTime.now().format('EEE')
- Now you can get formatted date using the format method directly in any date e.g
1.2.3 #
- NEW: Added
scaffoldMessenger
getter in theBuildContext
extension to easily callScaffoldMessenger.of(context)
- UPDATE: Improved implementation of the
toList
andtryToList
in theConvertObject
class.
1.2.2 #
- NEW: Added
toUtcIso
(supports null safety) that convert any datetoUtc()
andtoIso8601String()
in the Date extensions.
1.2.1 #
- NEW: Added
isEmptyOrNull
andisNotEmptyOrNull
to Map and Set extensions.
1.2.0 #
- UPDATE: Update documentation.
1.1.9 #
- FIX: Fixed a bug with
isZero
bool in numbers extensions. - UPDATE:
asBool
support null safety on numbers extensions. - UPDATE: Updated
ParsingException
implementation.
1.1.8 #
- NEW: Added
isPositiveOrNull
,isZeroOrNull
, andisNegativeOrNull
to all numbers extensions. - UPDATE: on String extension,
isEmptyOrNull
now returns true if string has only empty lines.
1.1.7 #
- NEW: Added
toDateTime
andtryToDateTime
inConvertObject
class.
1.1.6 #
- NEW: Added
toMap
andtryToMap
inConvertObject
class, and addisValidSVG
in String extension.
1.1.5 #
- NEW: Added
toBool
andtryToBool
inConvertObject
class. - UPDATE: Improved all implementations of static methods in
ConvertObject
class.
1.1.4 #
- NEW: Supported converting timestamp milliseconds to
DateTime
and addedtryToString
inConvertObject
class.
1.1.3 #
- FIX: Added missing
pushNamedAndRemoveUntil
in the navigation extension.
1.1.2 #
- UPDATE: Improved
asBool
implementation in the string extension.
1.1.1 #
- FIX: Fixed a bug in
camelCase
conversion algorithm.
1.1.0 #
- FIX: Fixed logo does not appear in readme file.
1.0.9 #
- UPDATE: Re-organized changelog and updated readme file.
1.0.8 #
- FIX: Fixed bug with
isHexColor
in color extension.
1.0.7 #
- NEW: Added new color extension to support converting hex string to color and checking if string is a hex color.
1.0.6 #
- UPDATE: Supported null safety to ThemeMode and Brightness.
1.0.5 #
- UPDATE: Changed
pop
topopPage
to solve conflicts withgo_router
package extensions.
1.0.4 #
- UPDATE: Updated readme file.
1.0.3 #
- NEW: Added
capitalizeFirstLetter
,toPascalCase
,toTitleCase
, andtoCamelCase
to String extension.
1.0.2 #
- UPDATE: Renamed some getters to fix conflicts with the
get
package.
1.0.1 #
- UPDATE: Updated readme file.
1.0.0 #
- INITIAL: Initial release.