CalendarDatePicker2 #

A lightweight and customizable calendar picker based on Flutter CalendarDatePicker, with support for single date picker, range picker and multi picker.

single mode	multi mode	range mode	dialog function

Intro #

CalendarDatePicker2 consists of two main widgets:

• CalendarDatePicker2, this widget only includes the calendar UI and will emit event whenever user taps a different date.
• CalendarDatePicker2WithActionButtons, this widget includes calendar UI and the action buttons (CANCEL & OK). This widget will only emit the updated value when user taps 'OK' button.

Features #

• Extended CalendarDatePicker allows null initialDate
• Highly Customizable UI
• Supports three modes: single, multi and range
• Built-in showCalendarDatePicker2Dialog

How to use #

Make sure to check out examples for more details.

Installation #

Add the following line to pubspec.yaml:

dependencies:
  calendar_date_picker2: ^0.3.9

Basic setup #

The complete example is available here.

CalendarDatePicker2 requires you to provide config and initialValue:

• config contains the configurations for your calendar setup and UI.
• initialValue is initial values passed into your calendar picker, initial value must be a List.

The minimum working sample #

CalendarDatePicker2(
  config: CalendarDatePicker2Config(),
  initialValue: [],
);

Single Date Picker Configuration #

During the initialization of CalendarDatePicker2Config the calendarType of the config instance will by default set to CalendarDatePicker2Type.single, so you don't have to set the calendar type specifically.

Multi Date Picker Configuration #

In order to use multi mode date picker, you will need to set the calendarType of config to CalendarDatePicker2Type.multi:

CalendarDatePicker2(
  config: CalendarDatePicker2Config(
      calendarType: CalendarDatePicker2Type.multi,
  ),
  onValueChanged: (dates) => _yourHandler(dates),
  initialValue: [],
);

Range Date Picker Configuration #

In order to use range mode date picker, you will need to set the calendarType of config to CalendarDatePicker2Type.range:

CalendarDatePicker2(
  config: CalendarDatePicker2Config(
      calendarType: CalendarDatePicker2Type.range,
  ),
  onValueChanged: (dates) => _yourHandler(dates),
  initialValue: [],
);

Use built-in dialog display method #

This package includes built-in support to display calendar as a dialog. To use it, you will need to call showCalendarDatePicker2Dialog, which takes three required arguments: context, config, dialogSize:

...
var results = await showCalendarDatePicker2Dialog(
  context: context,
  config: CalendarDatePicker2WithActionButtonsConfig(),
  dialogSize: const Size(325, 400),
  initialValue: _dialogCalendarPickerValue,
  borderRadius: BorderRadius.circular(15),
);
...

Config options #

For CalendarDatePicker2Config: #

In addition to the configurations above, CalendarDatePicker2WithActionButtonsConfig has 9 extra options #

Custom UI #

By using the configs above, you could make your own custom calendar picker as your need.

CalendarDatePicker2WithActionButtons(
  config: CalendarDatePicker2WithActionButtonsConfig(
    firstDayOfWeek: 1,
    calendarType: CalendarDatePicker2Type.range,
    selectedDayTextStyle: TextStyle(color: Colors.white, fontWeight: FontWeight.w700),
    selectedDayHighlightColor: Colors.purple[800],
    centerAlignModePickerButton: true,
    customModePickerButtonIcon: SizedBox(),
    dayBuilder: _yourDayBuilder,
  ),
  initialValue: _yourDatesVariable,
  onValueChanged: (dates) => setState(() => _yourDatesVariable = dates),
);

Contributions #

Feel free to contribute to this project. 🍺 Pull requests are welcome!

There are some tips before creating a PR:

• Please use the official Dart Extension as your formatter or use flutter format . if you are not using VS Code
• Please keep your changes to its minimum needed scope (avoid introducing unrelated changes)
• Please follow this git commit convention by adding feat: or fix: to your PR commit