easix 1.1.0

easix is a helper package that provide multiple handy function and extensions to use in your flutter project.

Easix - A Flutter Package for Easy Form Validation and Useful Extensions

Easix is a Flutter package designed to simplify common tasks related to form field validation and provide helpful extensions for working with dates, times, widgets, and error handling. With Easix, you can streamline the development of your Flutter applications, making your code more efficient and maintainable.

Demo

Features

Form Field Validation

Easix includes a set of validation functions to ensure the integrity of your form fields. You can use these functions to validate:

• Email
• Passwords
• Confirm passwords
• Normal passwords

Useful Extensions

Easix offers a variety of extensions to make your Flutter development easier and more productive. These extensions include:

• Converting a string date to a human-readable date format
• Converting a Datetime to a human-readable time
• Formatting DateTime objects to yyyy-MM-dd format
• Formatting TimeOfDay objects to HH:mm:ss format
• Adding padding to widgets, allowing customization of height, width, or both
• Adding an extension to the String class to get the first letters of a string
• Checking if a TimeOfDay is before or after another
• Calculating the difference in minutes between two TimeOfDay objects
• Checking if a TimeOfDay is between two others
• Converting time to 12-hour format with optional meridian display
• Get the initials of a string.
• Add extensions for theme, textTheme and colorScheme for easy access to theme properties.
• Add initial extension to get the first letter of a string.

useful functions

• Convert any list with a date property to a sorted list of dates, where it will be sorted by the date property in the list items.
• GetTypeList function to get a list of types from a list of objects.

Error Handling

Easix provides error classes that can help you handle errors in your Flutter applications effectively. These error classes include:

• ServerError: A class to handle server-related errors, making it easier to communicate with APIs and services.
• LocalError: A class to handle local errors within your Flutter app, enhancing error reporting and debugging.

Installation

To get started with Easix, add it to your pubspec.yaml file:

dependencies:
  easix: ^x.y.z

Replace ^x.y.z with the latest version of Easix available on pub.dev.

Usage

Form Field Validation Examples

Easix provides a set of validation functions to ensure the integrity of your form field for Name, Email, password and Confirm password field. You can use these functions to validate:

Validate name example

 TextFormField(
   controller: _nameController,

   /// you can use validator like this
   /// or even add a custom validator error message
   /// validator: (value) => value.validateName(error: 'custom error message'),
   validator: (value) => value.validateName(),
   decoration: const InputDecoration(
     labelText: 'Name',
   ),
 ),

Validate email example

 TextFormField(
   controller: _emailController,

   /// you can use validator like this
   /// or even add a custom validator error message
   /// validator: (value) => value.validateEmail(error: 'custom error message'),
   validator: (value) => value.validateEmail(),
   decoration: const InputDecoration(
     labelText: 'Email',
   ),
 ),

Validate password example

 TextFormField(
   controller: _passwordController,

   /// you can use validator like this
   /// or even add a custom validator error message
   /// validator: (value) => value.validatePassword(error: 'custom error message'),
   validator: (value) => value.validatePassword(),
   decoration: const InputDecoration(
     labelText: 'Password',
   ),
 ),

Validate confirm password example

 TextFormField(
   controller: _confirmPasswordController,

   /// you can use validator like this
   /// or even add a custom validator error message
   /// you can also add error message for not match password
   /// validator: (value) => value.validatePassword(confirmPassword: _passwordController.text, error: 'custom error message' errorNotMatch: 'custom error message'),
   /// with confirm password validator
   validator: (value) => value.validatePassword(
     confirmPassword: _passwordController.text,
     error: 'Password and confirm password not match',
     errorNotMatch: 'Password and confirm password not match',
   ),
   decoration: const InputDecoration(
     labelText: 'Confirm Password',
   ),
 ),

Validate week password example

 TextFormField(
   controller: _weekPasswordController,

   /// you can use validator like this
   /// or even add a custom validator error message
   /// validator: (value) => value.validateWeakPassword(error: 'custom error message'),
   /// with week password validator where it's not necessary to have a number or special character
   validator: (value) => value.validateWeakPassword(),
   decoration: const InputDecoration(
     labelText: 'Week Password',
   ),
 ),

Useful Extensions Examples

Easix offers a variety of extensions to make your Flutter development easier and more productive. These extensions include:

Convert a string date to a human-readable date format

Demo

"Now (English): ${now.toHumanDate()}\n"
"Before 1 Hour (English): ${now.subtract(Duration(hours: 1)).toHumanDate()}\n"
"Before 1 Day (English): ${now.subtract(Duration(days: 1)).toHumanDate()}\n"
"Before 2 Days (English): ${now.subtract(Duration(days: 2)).toHumanDate()}\n"
"Before 10 Days (English, Short): ${now.subtract(Duration(days: 10)).toHumanDate()}\n"
"Before 10 Days (English, Full): ${now.subtract(Duration(days: 10)).toHumanDate(displayType: DateMode.full)}\n"
"Before 1 Month (English): ${now.subtract(Duration(days: 30)).toHumanDate()}\n"
"Before 1 Year (English, full): ${now.subtract(Duration(days: 365)).toHumanDate(displayType: DateMode.full)}\n"
"-----------------------------------\n"
"Before 1 Hour (Arabic): ${now.subtract(Duration(hours: 1)).toHumanDate(language: DateLang.ar)}\n"
"Before 1 Day (Arabic): ${now.subtract(Duration(days: 1)).toHumanDate(language: DateLang.ar)}\n"
"Before 2 Days (Arabic): ${now.subtract(Duration(days: 2)).toHumanDate(language: DateLang.ar)}\n"
"Before 10 Days (Arabic, Short): ${now.subtract(Duration(days: 10)).toHumanDate(language: DateLang.ar)}\n"
"Before 10 Days (Arabic, Full): ${now.subtract(Duration(days: 10)).toHumanDate(displayType: DateMode.full, language: DateLang.ar)}\n"
"Before 1 Month (Arabic): ${now.subtract(Duration(days: 30)).toHumanDate(language: DateLang.ar)}\n"
"Before 1 Year (Arabic, full): ${now.subtract(Duration(days: 365)).toHumanDate(language: DateLang.ar, displayType: DateMode.full)}\n"
"-----------------------------------\n"
"After 1 Hour (English): ${now.add(Duration(hours: 1)).toHumanDate()}\n"
"After 1 Day (English): ${now.add(Duration(days: 1)).toHumanDate()}\n"
"After 2 Days (English): ${now.add(Duration(days: 2)).toHumanDate()}\n"
"After 10 Days (English, Short): ${now.add(Duration(days: 10)).toHumanDate()}\n"
"After 10 Days (English, Full): ${now.add(Duration(days: 10)).toHumanDate(displayType: DateMode.full)}\n"
"After 1 Month (English): ${now.add(Duration(days: 30)).toHumanDate()}\n"
"After 1 Year (English, full): ${now.add(Duration(days: 365)).toHumanDate()}\n"
"-----------------------------------\n"
"After 1 Hour (Arabic): ${now.add(Duration(hours: 1)).toHumanDate(language: DateLang.ar)}\n"
"After 1 Day (Arabic): ${now.add(Duration(days: 1)).toHumanDate(language: DateLang.ar)}\n"
"After 2 Days (Arabic): ${now.add(Duration(days: 2)).toHumanDate(language: DateLang.ar)}\n"
"After 10 Days (Arabic, Short): ${now.add(Duration(days: 10)).toHumanDate(language: DateLang.ar)}\n"
"After 10 Days (Arabic, Full): ${now.add(Duration(days: 10)).toHumanDate(displayType: DateMode.full, language: DateLang.ar)}\n"
"After 1 Month (Arabic): ${now.add(Duration(days: 30)).toHumanDate(language: DateLang.ar)}\n"
"After 1 Year (Arabic, full): ${now.add(Duration(days: 365)).toHumanDate(language: DateLang.ar, displayType: DateMode.full)}\n"

Checking if a TimeOfDay is before or after another

bool isBefore = currentTime.isBefore(otherTime);
bool isAfter = currentTime.isAfter(otherTime);

Calculating the difference in minutes between two TimeOfDay objects

int minutesDifference = currentTime.differenceInMinutes(otherTime);

Checking if a TimeOfDay is between two others

bool isBetween = currentTime.isBetween(startTime, endTime);

Converting time to 12-hour format with optional meridian display

String formattedTime = '12:55:00'.to12Time(showMeridian: true);

Get the first letters of a string

// you can use it like this
final _firstLetters = 'Mustafa Ibrahim'.initials;
// it will return 'MI'

Get the first letter of a string

// you can use it like this
final _firstLetter = 'Mustafa Ibrahim'.initial;
// it will return 'M'

Add extensions for theme, textTheme, and colorScheme for easy access to theme properties

// you can use it like this
final _theme = context.theme;
final _textTheme = context.textTheme;
final _colorScheme = context.colorScheme;

Add padding to widgets, allowing customization of height, width, or both

// normaly when you want to add padding to a widget you do it like this
Padding(
  padding: const EdgeInsets.all(8.0),
  child: Text('Hello World'),
)
// or you can use SizedBox() like this
SizedBox(
  height: 8.0,
)
---------
SizedBox(
  width: 8.0,
)
// but with easix you can do it like this
8.ph // for virtical padding with 8.0 height
---------
8.pw // for horizontal padding with 8.0 width
---------
8.p // for both virtical and horizontal padding with 8.0 height and width

Useful functions example

convert any list with a date property to a sorted list of dates, where it will be sorted by the date property in the list items.

List<ExampleModel> _exampleList = [
  ExampleModel(
    id: 1,
    name: 'Example 1',
    date: DateTime.now().subtract(Duration(days: 1)),
  ),
  ExampleModel(
    id: 2,
    name: 'Example 2',
    date: DateTime.now().subtract(Duration(days: 2)),
  ),
  ExampleModel(
    id: 3,
    name: 'Example 3',
    date: DateTime.now().subtract(Duration(days: 3)),
  ),
  ExampleModel(
    id: 4,
    name: 'Example 4',
    date: DateTime.now().subtract(Duration(days: 4)),
  ),
  ExampleModel(
    id: 5,
    name: 'Example 5',
    date: DateTime.now().subtract(Duration(days: 5)),
  ),
  ExampleModel(
    id: 6,
    name: 'Example 6',
    date: DateTime.now().subtract(Duration(days: 6)),
  ),
];

// you can use it like this
final _sortedDateList = convertToSortedDateList(
  existingList: [],
  newList: _exampleList,
  dateProperty: (item) => item.date,
);

// it will return a list of dates sorted by the date property in the list items.

SortedDateList is a list of SortedDate where SortedDate is a class that has two properties date and list where date is the date property in the list items and list is a list of items that have the same date property.

GetTypeList function to get a list of types from a list of objects.

// you can use it like this
final examples = getTypeList<ExampleModel>(
  _exampleList,
  ExampleModel.fromJson,
);

Error Handling Implementation

Easix provides error classes that can help you handle errors in your Flutter applications effectively. These error classes include:

ServerError: A class to handle server-related errors, making it easier to communicate with APIs and services.

try {
  // your code
} on ServerError catch (e) {
  // handle error
}

LocalError: A class to handle local errors within your Flutter app, enhancing error reporting and debugging.

try {
  // your code
} on LocalError catch (e) {
  // handle error
}

License

Easix is licensed under the MIT License.

MIT License

Copyright (c) 2023 Mustafa Ibrahim.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Author

• Author

Contributors

All contributions are welcome. If you are interested in contributing to this project, please open a pull request.