Jiffy

.github/workflows/release.yml codecov License: MIT Pub Version Platform

Jiffy is a Flutter (Android, IOS and Web) date time package inspired by momentjs for parsing, manipulating, querying and formatting dates

Full Documentation | Installation | ChangeLog | Examples

Usage

Format Dates

Jiffy([2021, 1, 19]).format("MMMM do yyyy, h:mm:ss a"); // January 1st 2021, 12:00:00 AM
Jiffy().format("EEEE"); // Tuesday
Jiffy().format("MMM do yy"); // Mar 2nd 21
Jiffy().format("yyyy [escaped] yyyy"); // 2021 escaped 2021
Jiffy().format(); // 2021-03-02T15:18:29.922343

Jiffy([2020, 10, 19]).yMMMMd; // January 19, 2021

Jiffy({
  "year": 2020,
  "month": 10,
  "day": 19,
  "hour": 19
}).yMMMMEEEEdjm; // Monday, October 19, 2020 7:14 PM

//  You can also use default formats
Jiffy("19, Jan 2021", "dd, MMM yyyy").yMMMMd; // January 19, 2021

Jiffy().yMMMMEEEEdjm; // Tuesday, March 2, 2021 3:20 PM

Relative Time

Jiffy("2011-10-31", "yyyy-MM-dd").fromNow(); // 9 years ago

var jiffy1 = Jiffy().startOf(Units.DAY).fromNow(); // 19 hours ago

var jiffy2 = Jiffy().endOf(Units.DAY).fromNow(); // in 5 hours

var jiffy3 = Jiffy().startOf(Units.HOUR).add(hours: 2, minutes: 20).fromNow(); // in 2 hours

Manipulation

var jiffy1 = Jiffy().add(duration: Duration(days: 1));
jiffy1.yMMMMd; // March 3, 2021

var jiffy2 = Jiffy().subtract(days: 1).yMMMMd; // March 1, 2021

var jiffy3 = Jiffy()
    .add(hours: 3, days: 1)
    .subtract(minutes: 30, months: 1);
    .yMMMMEEEEdjm; // Wednesday, February 3, 2021 6:07 PM

// Months and year are added in respect to how many 
// days there are in a months and if is a year is a leap year
Jiffy("2010/1/31", "yyyy-MM-dd"); // This is January 31
Jiffy([2010, 1, 31]).add(months: 1); // This is February 28

Locale Support

//  The locale method always return a future
//  To get locale (The default locale is English)
await (Jiffy.locale()).code; // en

//  To set locale
await Jiffy.locale("fr");
Jiffy().yMMMMEEEEdjm; // samedi 19 octobre 2019 19:25

await Jiffy.locale("ar");
Jiffy().yMMMMEEEEdjm; // السبت، ١٩ أكتوبر ٢٠١٩ ٧:٢٧ م

await Jiffy.locale("zh_cn");
Jiffy().yMMMMEEEEdjm; // 2019年10月19日星期六 下午7:28

Contributing

To contribute, follow the following easy steps

Step 1
  • Fork this repo!
Step 2
  • Make your own updates
Step 3
  • Create a new pull request

Support

Reach out to me at one of the following places!

License

MIT License

Copyright (c) 2019 Jama Mohamed

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.

Libraries

jiffy
Support for doing something awesome. [...]