shamsi_date 0.3.0

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 89

A Flutter package for using Jalali (Shamsi, Solar or Persian) date. You can convert Jalali and Georgian dates to each other. #

Converted from the popular Javascript library jalaali-js.

Calendar conversion is based on the algorithm provided by Kazimierz M. Borkowski and has a very good performance.

Usage #

Add it to your pubspec.yaml file:

dependencies:
    shamsi_date: ^0.3.0

Jalali class is used for Shamsi (Jalali or Persian) date and Gregorian class is used for Gregorian date. They can be instantiated by using their constructor:

Jalali(year, month, day)
Gregorian(year, month, day)

month and day default to 1

You can convert Jalali date to Gregorian by using toGregorian() method and convert Gregorian to Jalali date by using toJalali() method.

You can check Jalali date validity by isValid() method. And find month length by monthLength getter. And check if the year is a leap year by isLeapYear() method.

You can also convert DateTime object directly to Jalali or Gregorian date by using

Jalali.fromDate(dateTime)
Gregorian.fromDate(dateTime)

Here is an example:

import 'package:shamsi_date/shamsi_date.dart';

main() {
  final g1 = Gregorian(2013, 1, 10);
  final j1 = g1.toJalali();
  print('$g1 in Gregorian is $j1 in Jalali');

  final j2 = Jalali(1391, 10, 21);
  final g2 = j1.toGregorian();
  print('$j2 in Jalali is $g2  in Gregorian');

  // check validity
  print('$j1 is valid? ${j1.isValid()}');

  // check leap year
  print('1390 is leap year? ${Jalali(1390).isLeapYear()}');

  // find month length
  print('1390/12 month length? ${Jalali(1390, 12).monthLength}');
  
  final now = DateTime.now();
  print('now is ${Gregorian.fromDate(now)} in Gregorian');
  print('now is ${Jalali.fromDate(now)} in Jalali');
}

0.1 #

  • Initial version

0.2.0 #

  • CHANGED constructor type

0.2.1 #

  • CHANGED static methods
  • CHANGED monthLength to getter

0.3.0 #

  • ADDED fromDate constructor

example/README.md

An Example for shamsi date package #

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

void main() {
  runApp(MaterialApp(
    title: 'Example for shamsi_date package',
    home: MyHomePage(),
  ));
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  Gregorian get g {
    final now = DateTime.now();
    return Gregorian(now.year, now.month, now.day);
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Example for shamsi_date package'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              '$g in Gregorian is ${g.toJalali()} in Jalali',
            ),
          ],
        ),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

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


dependencies:
  shamsi_date: ^0.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:shamsi_date/shamsi_date.dart';
  
Version Uploaded Documentation Archive
0.5.5 May 5, 2019 Go to the documentation of shamsi_date 0.5.5 Download shamsi_date 0.5.5 archive
0.5.4 May 3, 2019 Go to the documentation of shamsi_date 0.5.4 Download shamsi_date 0.5.4 archive
0.5.3 May 1, 2019 Go to the documentation of shamsi_date 0.5.3 Download shamsi_date 0.5.3 archive
0.5.2 Mar 24, 2019 Go to the documentation of shamsi_date 0.5.2 Download shamsi_date 0.5.2 archive
0.5.1 Feb 21, 2019 Go to the documentation of shamsi_date 0.5.1 Download shamsi_date 0.5.1 archive
0.5.0 Feb 10, 2019 Go to the documentation of shamsi_date 0.5.0 Download shamsi_date 0.5.0 archive
0.4.3 Feb 2, 2019 Go to the documentation of shamsi_date 0.4.3 Download shamsi_date 0.4.3 archive
0.4.2 Jan 24, 2019 Go to the documentation of shamsi_date 0.4.2 Download shamsi_date 0.4.2 archive
0.4.1 Jan 14, 2019 Go to the documentation of shamsi_date 0.4.1 Download shamsi_date 0.4.1 archive
0.3.1 Jan 9, 2019 Go to the documentation of shamsi_date 0.3.1 Download shamsi_date 0.3.1 archive

All 16 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
78
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]
89
Learn more about scoring.

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

  • Dart: 2.3.1
  • pana: 0.12.16
  • Flutter: 1.5.4-hotfix.2

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