Myanmar Calendar Flutter Package #

A comprehensive Flutter package for Myanmar calendar system with full support for date conversions, astrological calculations, holidays, and beautiful UI widgets.

Features #

📅 Complete Myanmar Calendar System: Full support for Myanmar calendar with accurate date conversions
🌙 Astrological Calculations: Buddhist era, sabbath days, moon phases, yatyaza, pyathada, and more
🎯 Multi-language Support: Myanmar, English, Mon, Shan, Karen, and Zawgyi scripts
🎨 Beautiful UI Components: Pre-built calendar widgets and date pickers
🌐 Holiday Support: Myanmar public holidays, religious days, and cultural events
⚙️ Highly Configurable: Customizable themes, date formats, and display options
📱 Responsive Design: Works perfectly on mobile, tablet, and desktop
🔄 Date Arithmetic: Easy date calculations and manipulations
🛡️ Type Safe: Full null safety support with comprehensive error handling

Installation #

Add this to your package's pubspec.yaml file:

dependencies:
  flutter_mmcalendar: any

Then run:

flutter pub get

Quick Start #

Basic Usage #

import 'package:flutter_mmcalendar/flutter_mmcalendar.dart';

void main() {
  // Configure the calendar (optional)
  MyanmarCalendar.configure(
    language: Language.myanmar,
    timezoneOffset: 6.5, // Myanmar Standard Time
  );

  // Get today's date
  final today = MyanmarCalendar.today();
  print('Today: ${today.formatComplete()}');

  // Convert Western date to Myanmar
  final myanmarDate = MyanmarCalendar.fromWestern(2024, 1, 1);
  print('Myanmar: ${myanmarDate.formatMyanmar()}');
  print('Western: ${myanmarDate.formatWestern()}');
}

Using Calendar Widget #

import 'package:flutter/material.dart';
import 'package:flutter_mmcalendar/flutter_mmcalendar.dart';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Myanmar Calendar')),
        body: MyanmarCalendarWidget(
          language: Language.myanmar,
          onDateSelected: (date) {
            print('Selected: ${date.formatComplete()}');
          },
          showHolidays: true,
          showAstrology: true,
        ),
      ),
    );
  }
}

Date Picker Dialog #

Future<void> showDatePicker(BuildContext context) async {
  final selectedDate = await showMyanmarDatePicker(
    context: context,
    initialDate: DateTime.now(),
    firstDate: DateTime(2020),
    lastDate: DateTime(2030),
    language: Language.myanmar,
    showHolidays: true,
  );

  if (selectedDate != null) {
    print('Selected: ${selectedDate.formatComplete()}');
  }
}

Core Classes #

MyanmarCalendar #

The main entry point for all Myanmar calendar operations.

// Configuration
MyanmarCalendar.configure(
  language: Language.myanmar,
  timezoneOffset: 6.5,
  sasanaYearType: 0, // 0, 1, or 2
);

// Factory methods
final today = MyanmarCalendar.today();
final fromWestern = MyanmarCalendar.fromWestern(2024, 1, 1);
final fromMyanmar = MyanmarCalendar.fromMyanmar(1385, 10, 1);
final fromDateTime = MyanmarCalendar.fromDateTime(DateTime.now());

// Parsing
final parsed = MyanmarCalendar.parseMyanmar('1385/10/1');

// Information
final complete = MyanmarCalendar.getCompleteDate(DateTime.now());
final astro = MyanmarCalendar.getAstroInfo(date);
final holidays = MyanmarCalendar.getHolidayInfo(date);

// Validation
final isValid = MyanmarCalendar.isValidMyanmar(1385, 10, 1);
final validation = MyanmarCalendar.validateMyanmar(1385, 10, 1);

// Utilities
final daysBetween = MyanmarCalendar.daysBetween(date1, date2);
final added = MyanmarCalendar.addDays(date, 10);
final sabbathDays = MyanmarCalendar.findSabbathDays(1385, 10);

MyanmarDateTime #

Represents a specific moment in time with both Myanmar and Western calendar information.

final mdt = MyanmarDateTime.now();

// Properties
print('Myanmar Year: ${mdt.myanmarYear}');
print('Myanmar Month: ${mdt.myanmarMonth}');
print('Myanmar Day: ${mdt.myanmarDay}');
print('Western Year: ${mdt.westernYear}');
print('Moon Phase: ${mdt.moonPhase}');
print('Is Sabbath: ${mdt.isSabbath}');
print('Holidays: ${mdt.allHolidays}');

// Date arithmetic
final tomorrow = mdt.addDays(1);
final nextWeek = mdt.addDays(7);
final duration = mdt.difference(other);

// Formatting
final myanmarFormat = mdt.formatMyanmar('&y &M &P &ff');
final westernFormat = mdt.formatWestern('%d-%m-%Y');
final complete = mdt.formatComplete();

// Comparisons
final isBefore = mdt.isBefore(other);
final isAfter = mdt.isAfter(other);
final isSameDay = mdt.isSameDay(other);

Widgets #

MyanmarCalendarWidget #

A full-featured calendar widget with Myanmar date support.

MyanmarCalendarWidget(
  initialDate: DateTime.now(),
  language: Language.myanmar,

  // Callbacks
  onDateSelected: (CompleteDate date) {
    print('Selected: ${date.formatComplete()}');
  },
  onMonthChanged: (DateTime month) {
    print('Month changed to: $month');
  },

  // Display options
  showHolidays: true,
  showAstrology: true,
  showWesternDates: true,
  showMyanmarDates: true,
  showWeekdayHeaders: true,
  showNavigation: true,

  // Customization
  theme: MyanmarCalendarTheme.defaultTheme(),
  firstDayOfWeek: 1, // Sunday
  highlightToday: true,
  highlightWeekends: true,

  // Constraints
  minDate: DateTime(2020),
  maxDate: DateTime(2030),

  // Custom builders
  cellBuilder: (context, date) => CustomDateCell(date),
  headerBuilder: (context, month) => CustomHeader(month),
)

MyanmarDatePickerWidget #

An interactive date picker with multiple view modes.

MyanmarDatePickerWidget(
  initialDate: DateTime.now(),
  language: Language.myanmar,

  // Callbacks
  onDateChanged: (CompleteDate date) {
    print('Date changed: ${date.formatComplete()}');
  },
  onConfirm: (CompleteDate date) {
    print('Date confirmed: ${date.formatComplete()}');
  },

  // Date constraints
  firstDate: DateTime(2020),
  lastDate: DateTime(2030),

  // UI options
  showTodayButton: true,
  showClearButton: true,
  showActionButtons: true,
  helpText: 'Select a date',

  // Theme
  theme: MyanmarCalendarTheme.darkTheme(),
)

Languages #

The package supports multiple languages:

enum Language {
  myanmar,    // မြန်မာ
  english,    // English
  zawgyi,     // Zawgyi Myanmar
  mon,        // Mon
  shan,       // Shan
  karen,      // Karen
}

// Usage
MyanmarCalendar.setLanguage(Language.myanmar);
final currentLang = MyanmarCalendar.currentLanguage;

Themes #

Predefined Themes #

// Light theme (default)
final lightTheme = MyanmarCalendarTheme.defaultTheme();

// Dark theme
final darkTheme = MyanmarCalendarTheme.darkTheme();

// Color-based theme
final customTheme = MyanmarCalendarTheme.fromColor(
  Colors.blue,
  isDark: false,
);

Custom Theme #

final customTheme = MyanmarCalendarTheme(
  backgroundColor: Colors.white,
  headerBackgroundColor: Colors.blue,
  headerTextColor: Colors.white,
  selectedDateBackgroundColor: Colors.blue,
  todayBackgroundColor: Colors.orange.withOpacity(0.3),
  sabbathBackgroundColor: Colors.purple.withOpacity(0.2),
  // ... more properties
);

Date Formatting #

Myanmar Date Patterns #

final date = MyanmarCalendar.today();

// Available patterns
'&y'     // Myanmar year (e.g., ၁၃၈၅)
'&M'     // Myanmar month name (e.g., တပေါင်း)
'&P'     // Moon phase (e.g., လဆုတ်)
'&ff'    // Fortnight day (e.g., ၁၀ ရက်)
'&d'     // Day number
'&w'     // Weekday name

// Example usage
final formatted = date.formatMyanmar('&y ခုနှစ် &M &P &ff');
// Output: ၁၃၈၅ ခုနှစ် တပေါင်း လဆုတ် ၁၀ ရက်

Western Date Patterns #

// Available patterns
'%Y'     // Year (e.g., 2024)
'%M'     // Month name (e.g., January)
'%d'     // Day (e.g., 01)
'%w'     // Weekday name (e.g., Monday)

// Example usage
final formatted = date.formatWestern('%d %M %Y');
// Output: 01 January 2024

Astrological Information #

final date = MyanmarCalendar.today();

// Moon phases
print('Moon Phase: ${date.moonPhase}'); // 0-3
print('Is Full Moon: ${date.isFullMoon}');
print('Is New Moon: ${date.isNewMoon}');

// Buddhist calendar
print('Sasana Year: ${date.sasanaYear}');
print('Is Sabbath: ${date.isSabbath}');
print('Is Sabbath Eve: ${date.isSabbathEve}');

// Astrological days
print('Yatyaza: ${date.yatyaza}');
print('Pyathada: ${date.pyathada}');
print('Nagahle: ${date.nagahle}');
print('Mahabote: ${date.mahabote}');

// Year information
print('Year Type: ${date.yearType}'); // 0=common, 1=little watat, 2=big watat
print('Is Watat Year: ${date.isWatatYear}');

Holiday Information #

final date = MyanmarCalendar.today();

// All holidays
print('Has Holidays: ${date.hasHolidays}');
print('All Holidays: ${date.allHolidays}');

// By category
print('Public Holidays: ${date.publicHolidays}');
print('Religious Holidays: ${date.religiousHolidays}');
print('Cultural Holidays: ${date.culturalHolidays}');

// Get holiday info directly
final holidayInfo = MyanmarCalendar.getHolidayInfo(date.myanmarDate);

Date Arithmetic and Utilities #

Basic Operations #

final date = MyanmarCalendar.today();

// Add/subtract days
final tomorrow = date.addDays(1);
final yesterday = date.subtractDays(1);
final nextWeek = date.addDays(7);

// Add time units
final laterToday = date.addHours(3);
final soon = date.addMinutes(30);

// Duration operations
final duration = const Duration(days: 5, hours: 3);
final future = date.add(duration);

Advanced Utilities #

// Find special days
final sabbathDays = MyanmarCalendar.findSabbathDays(1385, 10);
final nextFullMoon = MyanmarCalendar.findNextMoonPhase(date, 1);

// Month information
final monthDates = MyanmarCalendar.getMyanmarMonth(1385, 10);
final westernDates = MyanmarCalendar.getWesternDatesForMyanmarMonth(1385, 10);

// Year information
final isWatat = MyanmarCalendar.isWatatYear(1385);
final yearType = MyanmarCalendar.getYearType(1385);

// Date calculations
final daysBetween = MyanmarCalendar.daysBetween(date1, date2);
final addedMonths = MyanmarCalendar.addMonths(date, 3);

Configuration Options #

MyanmarCalendar.configure(
  language: Language.myanmar,           // Default language
  timezoneOffset: 6.5,                 // Myanmar Standard Time
  sasanaYearType: 0,                   // Sasana year calculation method
  calendarType: 1,                     // Calendar system (0=British, 1=Gregorian)
  gregorianStart: 2361222,             // Julian Day of Gregorian start
);

// Get current configuration
final config = MyanmarCalendar.config;
final diagnostics = MyanmarCalendar.getDiagnostics();

Error Handling and Validation #

// Validate Myanmar dates
final result = MyanmarCalendar.validateMyanmar(1385, 15, 1);
if (!result.isValid) {
  print('Error: ${result.error}');
}

// Quick validation
final isValid = MyanmarCalendar.isValidMyanmar(1385, 10, 1);

// Safe parsing
final parsed = MyanmarCalendar.parseMyanmar('1385/10/1');
if (parsed != null) {
  print('Parsed successfully: ${parsed.formatMyanmar()}');
} else {
  print('Failed to parse date string');
}

Advanced Examples #

Custom Calendar Cell #

Widget customCellBuilder(BuildContext context, CompleteDate date) {
  return Container(
    decoration: BoxDecoration(
      color: date.hasHolidays ? Colors.red.withOpacity(0.1) : null,
      border: date.isToday
        ? Border.all(color: Colors.blue, width: 2)
        : null,
    ),
    child: Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: [
        Text('${date.westernDay}'),
        if (date.isFullMoon) Icon(Icons.brightness_1, size: 12),
        if (date.hasHolidays) Text('H', style: TextStyle(fontSize: 8)),
      ],
    ),
  );
}

Batch Date Processing #

// Convert multiple dates
final westernDates = [
  DateTime(2024, 1, 1),
  DateTime(2024, 2, 1),
  DateTime(2024, 3, 1),
];

final myanmarDates = MyanmarCalendar.convertWesternDates(westernDates);
final completeDates = MyanmarCalendar.getCompleteDates(westernDates);

// Process Myanmar date data
final dateMaps = [
  {'year': 1385, 'month': 10, 'day': 1},
  {'year': 1385, 'month': 10, 'day': 15},
];
final converted = MyanmarCalendar.convertMyanmarDates(dateMaps);

Using with State Management #

class CalendarController extends ChangeNotifier {
  MyanmarDateTime _selectedDate = MyanmarCalendar.today();
  Language _language = Language.english;

  MyanmarDateTime get selectedDate => _selectedDate;
  Language get language => _language;

  void selectDate(MyanmarDateTime date) {
    _selectedDate = date;
    notifyListeners();
  }

  void changeLanguage(Language language) {
    _language = language;
    MyanmarCalendar.setLanguage(language);
    notifyListeners();
  }
}

Performance Tips #

Caching: The package automatically caches calculated dates and astrological information.

Batch Operations: Use batch methods for processing multiple dates:

// Efficient
final dates = MyanmarCalendar.convertWesternDates(westernDates);

// Less efficient
final dates = westernDates.map((d) => MyanmarCalendar.fromDateTime(d)).toList();

Configuration: Set up configuration once at app startup:

void main() {
  MyanmarCalendar.configure(
    language: Language.myanmar,
    timezoneOffset: 6.5,
  );
  runApp(MyApp());
}

Troubleshooting #

Common Issues #

Date Validation Errors

// Check if date is valid before using
if (MyanmarCalendar.isValidMyanmar(year, month, day)) {
  final date = MyanmarCalendar.fromMyanmar(year, month, day);
}

Language Display Issues

// Ensure proper font support for Myanmar text
MaterialApp(
  theme: ThemeData(
    fontFamily: 'Myanmar3', // Use Myanmar-compatible font
  ),
)

Timezone Issues

// Configure timezone for accurate calculations
MyanmarCalendar.configure(timezoneOffset: 6.5); // Myanmar time

Debugging #

// Get diagnostic information
final diagnostics = MyanmarCalendar.getDiagnostics();
print('Package Info: ${diagnostics['packageInfo']}');
print('Configuration: ${diagnostics['configuration']}');
print('Supported Languages: ${diagnostics['supportedLanguages']}');

// Reset configuration if needed
MyanmarCalendar.reset();

API Reference #

For complete API documentation, visit pub.dev documentation.

Contributing #

We welcome contributions! Please see our Contributing Guide for details.

License #

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

Changelog #

See CHANGELOG.md for version history and updates.

Support #

📧 Email: kyawzayartun.contact@gmail.com
🐛 Issues: GitHub Issues
💬 Discussions: GitHub Discussions

flutter_mmcalendar 3.0.0-dev.3 flutter_mmcalendar: ^3.0.0-dev.3 copied to clipboard

Metadata