persian_datepicker 1.3.0

Persian DatePicker & DateTime Manipulation

A persian ( farsi ) datepicker for flutter.

to see an example of date conversion and manipulation, refer to DateTime section in this page.

Usage #

A simple example with a TextField which turns into a datepicker

main.dart


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


void main() {
  runApp(Home());
}

class Home extends StatefulWidget {
  @override
  HomeState createState() {
    return new HomeState();
  }
}

class HomeState extends State<Home> {

  // our text controller
  final TextEditingController textEditingController = TextEditingController();

  PersianDatePickerWidget persianDatePicker;

  @override
  void initState() {

    /*Simple DatePicker*/
    persianDatePicker = PersianDatePicker(
      controller: textEditingController,
//      datetime: '1397/06/09',
    ).init();

    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('دیت پیکر ساده'),),
        body: Builder(builder: (BuildContext context) {


          return Container(
            child: TextField(
              enableInteractiveSelection: false, // *** this is important to prevent user interactive selection ***
              onTap: () {
                FocusScope.of(context).requestFocus(new FocusNode()); // to prevent opening default keyboard
                showModalBottomSheet(
                    context: context,
                    builder: (BuildContext context) {
                      return persianDatePicker;
                    });
              },
              controller: textEditingController,
            ),
          );



        }),
      ),
    );
  }
}

HOW IT LOOKS #

Simple DatePicker





Range DatePicker

/*Range DatePicker*/
persianDatePicker = PersianDatePicker(
  controller: textEditingController,
  rangeDatePicker: true,
  // datetime: '1397/06/09',
  // finishDatetime: '1397/06/15',
).init();





Inline DatePicker

/*Inline DatePicker*/
persianDatePicker = PersianDatePicker(
  controller: textEditingController,
  datetime: '1397/06/19',
).init();


....


return Column(
  children: <Widget>[
    // Simple Date Picker
    Container(
      child: persianDatePicker, // just pass `persianDatePicker` variable as child with no ( )
    ),
    
    // you can omit TextField when using datepicker as inline
    TextField(
      enableInteractiveSelection: false,
      controller: textEditingController,
    ),
  ],
);





Customized DatePicker

You can customize datepicker as you wish, there are a lot of options to set, below code is just a few of them.

/*Customized DatePicker*/
persianDatePicker = PersianDatePicker(
    controller: textEditingController,
    outputFormat: 'YYYY/MM/DD',
    datetime: '1397/08/29',
    finishDatetime: '1397/08/30',
    daysBorderWidth: 3,
    weekCaptionsBackgroundColor: Colors.red,
    headerBackgroundColor: Colors.blue.withOpacity(0.5),
    headerTextStyle: TextStyle(color: Colors.blue, fontSize: 17),
    headerTodayIcon: Icon(Icons.access_alarm, size: 15,),
    datePickerHeight: 280
).init();




/*Customized Font Family ( Farsi Digits )*/
persianDatePicker = PersianDatePicker(
    controller: textEditingController,
    farsiDigits: true
).init();

Or if you have a font which supports farsi digits then you can simply pass the font name and everything would be ok

اگر فونتی در برنامه استفاده کرده اید که قابلیت نمایش اعداد فارسی را دارد تنها لازم است اسم فونت را به دیت پیکر بدهید

/*Customized Font Family ( Farsi Digits )*/
persianDatePicker = PersianDatePicker(
    controller: textEditingController,
    fontFamily: 'Vazir' // here I used Vazir font
).init();




Events #

onChange: fires after tapping on a day. It has two arguments, oldText and newText which represents the value of datepicker before-tap and after-tap respectively.

persianDatePicker = PersianDatePicker(
  controller: textEditingController,
  onChange: (String oldText, String newText) {
    print(oldText);
    print(newText);
  }
).init();





DateTime #

in order to use PersianDateTime methods, you need to add following line into your file.

import 'package:persian_datepicker/persian_datetime.dart';

You can now use following methods with PersianDateTime instances
implemented methods:

  • toJalaali( format ) // see output formats
  • toGregorian( format ) // see output formats
  • isAfter
  • isBefore
  • difference
  • isEqual
  • add
  • subtract

All above methods work on persian ( farsi ) dates. if you want to work with gregorian datetime use Dart DateTime class

PersianDateTime persianDate1 = PersianDateTime(jalaaliDateTime: '1397/06/09'); // default is now
/*
  persianDate1 contains following properties

  jalaaliYear               1397
  jalaaliMonth              6
  jalaaliDay                9
  jalaaliShortYear          97
  jalaaliZeroLeadingMonth   06
  jalaaliZeroLeadingDay     09
  jalaaliMonthName          شهریور

  gregorianYear             2018
  gregorianMonth            8
  gregorianDay              31
  gregorianShortYear        18
  gregorianZeroLeadingDay   31
  gregorianZeroLeadingMonth 08
  gregorianMonthName        October
  gregorianShortMonthName   Oct

  datetime                  Dart DateTime class of current persian date

 */
print(persianDate1.toGregorian()); // 2018-08-31
print(persianDate1.datetime); // 2018-08-31 00:00:00.000


PersianDateTime persianDate2 = persianDate1.add(Duration(days: 10));
print(persianDate2.isBefore(persianDate1)); // false
print(persianDate2.isAfter(persianDate1)); // true
print(persianDate2.difference(persianDate1).inDays); // 10
print(persianDate2.difference(persianDate1).inHours); // 240

PersianDateTime persianDate3 = PersianDateTime(); // default is now
print(persianDate3.isEqual(persianDate1)); // false



// you can accept date as gregorian using `.fromGregorian` constructor. it will automatically convert into jalaali date
PersianDateTime persianDate3 = PersianDateTime.fromGregorian(); // default is now
print(persianDate3.toJalaali(format: 'YYYY/MM/DD')); // 1397/11/19





Output formats #

YYYY full year
YY 2 digits year
MMMM full month name ( doesn't work in datepicker )
MMM short month name ( this only works in gregorian dates and also doesn't work in datepicker )
MM leading zero month digit
M month without leading zero
DD leading zero day digit
D day without leading zero





Important Notes نکات مهم #

up to this version all output dates are in persian.

تا این نسخه تمام تاریخ های خروجی پارسی(جلالی) هستند

rangeSeparator and your custom date separator should not be equal, otherwise datepicker will return null

مقدار ورودی rangeSeparator و جداکننده ای که برای فرمت خروجی انتخاب کرده اید نباید یکی باشند در این صورت دیت پیکر خروجی جداکننده های محدوده و خروجی مشابه هستند برمیگرداند


Persian input dates must respect YYYY/MM/DD format. output format is up to you
Gregorian input dates must respect YYYY-MM-DD format. output format is persian and up to you

فرمت تاریخ های ورودی که پارسی (جلالی) هستند باید بصورت YYYY/MM/DD باشد. فرمت خروجی به دلخواه شماست

فرمت تاریخ های ورودی که میلادی هستند باید بصورت YYYY-MM-DD باشد. فرمت تاریخ خروجی، پارسی و به دلخواه شما خواهد بود


Version 1.3 features #

/// حداکثر تاریخی که میتوان در دیت پیکر انتخاب کرد String maxDatetime;

/// حداقل تاریخی که میتوان در دیت پیکر انتخاب کرد String minDatetime;

/// حداکثر فاصله ای که تاریخ شروع و تاریخ پایان میتوانند نسبت به یکدیگر داشته باشند Duration maxSpan;

/// حداقل فاصله ای که تاریخ شروع و تاریخ پایان میتوانند نسبت به یکدیگر داشته باشند Duration minSpan;

in order to update these options programmatically you can use update method, like so

...

  FlatButton(
      onPressed: () {
        minSpan = Duration(days: 10);
        setState(() {
          
          
          // here you can update the options
          persianDatePicker.update(
              minSpan: minSpan,
              minDatetime: '1397/12/19',
              maxDatetime: '1397/12/29');



        });
      },
      child: Container(
        child: Text('Update Datepicker'),
      ),
  )

...

Examples #

You can find the full example in the Git Repository, example directory

[0.1.0] - 01/09/2019.

  • Persian ( Farsi ) Datepicker.

[0.1.1] - 01/09/2019.

  • Added descriptions to read me.

[0.2.0] - 01/09/2019.

  • Added comments

[0.2.1] - 01/09/2019.

  • Added example

[1.0.0] - 01/15/2019.

  • No dependency is needed
  • Inline mode is added
  • Gregorian date as input is supported
  • Bug fixes

[1.0.1] - 01/15/2019.

  • updated read me

[1.0.2] - 01/15/2019.

  • bug fix
  • updated read me

[1.0.4] - 01/15/2019.

  • some options types changed

[1.0.6] - 01/16/2019.

[1.0.7] - 01/16/2019.

  • bug fix

[1.0.9] - 01/16/2019.

[1.1.0] - 01/17/2019.

  • farsi digits support
  • font family support
  • new parameters for customization

[1.1.1] - 01/17/2019.

  • TextField farsi digits support

[1.1.2] - 01/18/2019.

  • bug fix
  • display gregorian days with the ability of changing it's location

[1.1.4] - 01/21/2019.

  • datepicker onChange callback

[1.1.5] - 01/21/2019.

  • bug fix
  • first and last day of range datepicker background - options

[1.1.6] - 01/24/2019.

  • display gregorian years and month names
  • a better design for year and month selection
  • initialize method renamed to init

[1.1.7] - 02/07/2019.

  • jalali-to-gregorian and gregorian-to-jalali methods added to convert dates
  • onChange callback bug fix

[1.2.0] - 02/07/2019.

  • jalali-to-gregorian and gregorian-to-jalali methods added to convert dates ( removed )
  • datetime conversion and manipulation methods added.

[1.3.0] - 03/20/2019.

  • min span feature added
  • max span feature added
  • min datetime feature added
  • max datetime feature added
  • day block border radius feature added

example/example.dart

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

void main() {
  runApp(Home());
}

class Home extends StatefulWidget {
  @override
  HomeState createState() {
    return new HomeState();
  }
}

class HomeState extends State<Home> {
  // our text controller
  final TextEditingController textEditingController = TextEditingController();

  PersianDatePickerWidget persianDatePicker;

  @override
  void initState() {
    /*Simple DatePicker*/
    persianDatePicker = PersianDatePicker(
      controller: textEditingController,
      datetime: '1397/06/09',
    ).init();

    /*Range DatePicker*/
    /*persianDatePicker = PersianDatePicker(
      controller: textEditingController,
      rangeDatePicker: true,
    ).init();*/

    /*Gregorian DatePicker*/
    /*persianDatePicker = PersianDatePicker(
      controller: textEditingController,
      gregorianDatetime: '2018-09-08',
      outputFormat: 'YYYY/MM/DD',
    ).init();*/

    /*Inline DatePicker*/
    /*persianDatePicker = PersianDatePicker(
      controller: textEditingController,
      datetime: '1397/06/19',
      outputFormat: 'YYYY/MM/DD',
    ).init();*/

    /*Custom Format DatePicker*/
    /*persianDatePicker = PersianDatePicker(
      controller: textEditingController,
      datetime: '1397/06/19',
      outputFormat: 'MM - YYYY - DD',
    ).init();*/

    /*Customized DatePicker*/
    /*persianDatePicker = PersianDatePicker(
        controller: textEditingController,
        outputFormat: 'YYYY/MM/DD',
        datetime: '1397/08/13',
        finishDatetime: '1397/08/17',
        daysBorderWidth: 3,
        weekCaptionsBackgroundColor: Colors.red,
        headerBackgroundColor: Colors.blue.withOpacity(0.5),
        headerTextStyle: TextStyle(color: Colors.blue, fontSize: 17),
        headerTodayIcon: Icon(Icons.access_alarm, size: 15,),
        datePickerHeight: 280
    ).init();*/

    /*onChangeEvent*/
    /*persianDatePicker = PersianDatePicker(
      controller: textEditingController,
      onChange: (String oldText, String newText) {
        print(oldText);
        print(newText);
      }
    ).init();*/

    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('دیت پیکر ساده'),
        ),
        body: Builder(builder: (BuildContext context) {
          return Column(
            children: <Widget>[
              // Simple Date Picker
              Container(
                child: persianDatePicker,
              ),
              TextField(
                onTap: () {
                  FocusScope.of(context).requestFocus(new FocusNode());
                },
                enableInteractiveSelection: false,
                controller: textEditingController,
              ),
            ],
          );
        }),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

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


dependencies:
  persian_datepicker: ^1.3.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:persian_datepicker/persian_datepicker.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
80
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
90
Learn more about scoring.

We analyzed this package on Jul 17, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.4.0
  • pana: 0.12.19
  • Flutter: 1.7.8+hotfix.3

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11
meta 1.1.6 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test

Admin