Flutter Date Formatter #

A Flutter package for formatting dates and times in various locales. This package provides utilities for formatting relative dates, ordinal numbers, and more.

Installation 💻 #

Install via flutter pub add:

dart pub add flutter_date_formatter

Usage 📖 #

Import the package:

import 'package:flutter_date_formatter/flutter_date_formatter.dart';

Prerequisites #

Install the intl package:

dart pub add intl

Add initializeDateFormatting() to the main function and import it from package:intl/date_symbol_data_local.dart:

import 'package:intl/date_symbol_data_local.dart'; // Add this import

void main() async {
  await initializeDateFormatting(); // Initialize date formatting
  // Your app initialization code here
}

Formatting Dates #

You can format dates using the FlutterDateFormatter class:

DateTime now = DateTime.now();
String pattern = 'do MMMM yyyy';
String formattedDate = FlutterDateFormatter(pattern, 'en').format(now);
print(formattedDate); // Output: 13th February 2025

Formatting Relative Dates #

You can format dates relative to the current time using the formatRelativeDateTime function:

DateTime now = DateTime.now();
DateTime pastDate = now.subtract(Duration(days: 5));
String formattedRelativeDate = FlutterDateFormatter.formatRelativeDateTime(
  pastDate,
  locale: 'en',
);
print(formattedRelativeDate); // Output: 5 days ago

Ordinal Numbers #

You can get the ordinal representation of a number using the ordinal method in the locale classes:

int number = 1;
String ordinal = EnLocale().ordinal(number);
print(ordinal); // Output: 1st

Contributing 🤝 #

Contributions are welcome! Please open an issue or submit a pull request.

License 📄 #

This project is licensed under the MIT License - see the LICENSE file for details.