showRangePickerDialog function

Future<DateTimeRange<DateTime>?> showRangePickerDialog({
  1. required BuildContext context,
  2. required DateTime maxDate,
  3. required DateTime minDate,
  4. double? width,
  5. double? height,
  6. DateTime? initialDate,
  7. DateTime? currentDate,
  8. DateTimeRange<DateTime>? selectedRange,
  9. EdgeInsets contentPadding = const EdgeInsets.all(16),
  10. EdgeInsets padding = const EdgeInsets.all(36),
  11. PickerType initialPickerType = PickerType.days,
  12. bool barrierDismissible = true,
  13. Color? barrierColor = Colors.black54,
  14. String? barrierLabel,
  15. bool useSafeArea = true,
  16. bool useRootNavigator = true,
  17. RouteSettings? routeSettings,
  18. Offset? anchorPoint,
  19. TextStyle? daysOfTheWeekTextStyle,
  20. TextStyle? enabledCellsTextStyle,
  21. BoxDecoration enabledCellsDecoration = const BoxDecoration(),
  22. TextStyle? disabledCellsTextStyle,
  23. BoxDecoration disabledCellsDecoration = const BoxDecoration(),
  24. TextStyle? currentDateTextStyle,
  25. BoxDecoration? currentDateDecoration,
  26. TextStyle? selectedCellsTextStyle,
  27. BoxDecoration? selectedCellsDecoration,
  28. TextStyle? singleSelectedCellTextStyle,
  29. BoxDecoration? singleSelectedCellDecoration,
  30. double? slidersSize,
  31. Color? slidersColor,
  32. TextStyle? leadingDateTextStyle,
  33. Color? highlightColor,
  34. Color? splashColor,
  35. double? splashRadius,
  36. bool centerLeadingDate = false,
  37. String? previousPageSemanticLabel,
  38. String? nextPageSemanticLabel,
})

Shows a dialog containing a Material Design range picker.

The returned Future resolves to the range selected by the user or null when tap outside the dialog.

When the range picker is first displayed, it will show the initialDate.

The minDate is the earliest allowable date. The maxDate is the latest allowable date. initialDate and selectedRange must either fall between these dates, or be equal to one of them. For each of these DateTime parameters, only their dates are considered. Their time fields are ignored.

initialDate and currentDate, If not specified, they will default to DateTime.now() date.

The locale for the date picker defaults to the ambient locale provided by Localizations.

The context, useRootNavigator and routeSettings arguments are passed to showDialog, the documentation for which discusses how it is used.

An optional initialPickerType argument can be used to have the date picker initially appear in the initialPickerType.year, initialPickerType.month or initialPickerType.day mode. It defaults to initialPickerType.day.

See also:

  • RangeDatePicker, which provides the calendar grid used by the range picker dialog.

Implementation

Future<DateTimeRange?> showRangePickerDialog({
  required BuildContext context,
  required DateTime maxDate,
  required DateTime minDate,
  double? width,
  double? height,
  DateTime? initialDate,
  DateTime? currentDate,
  DateTimeRange? selectedRange,
  EdgeInsets contentPadding = const EdgeInsets.all(16),
  EdgeInsets padding = const EdgeInsets.all(36),
  PickerType initialPickerType = PickerType.days,
  bool barrierDismissible = true,
  Color? barrierColor = Colors.black54,
  String? barrierLabel,
  bool useSafeArea = true,
  bool useRootNavigator = true,
  RouteSettings? routeSettings,
  Offset? anchorPoint,
  TextStyle? daysOfTheWeekTextStyle,
  TextStyle? enabledCellsTextStyle,
  BoxDecoration enabledCellsDecoration = const BoxDecoration(),
  TextStyle? disabledCellsTextStyle,
  BoxDecoration disabledCellsDecoration = const BoxDecoration(),
  TextStyle? currentDateTextStyle,
  BoxDecoration? currentDateDecoration,
  TextStyle? selectedCellsTextStyle,
  BoxDecoration? selectedCellsDecoration,
  TextStyle? singleSelectedCellTextStyle,
  BoxDecoration? singleSelectedCellDecoration,
  double? slidersSize,
  Color? slidersColor,
  TextStyle? leadingDateTextStyle,
  Color? highlightColor,
  Color? splashColor,
  double? splashRadius,
  bool centerLeadingDate = false,
  String? previousPageSemanticLabel,
  String? nextPageSemanticLabel,
}) async {
  return showDialog<DateTimeRange>(
    context: context,
    barrierColor: barrierColor,
    anchorPoint: anchorPoint,
    barrierDismissible: barrierDismissible,
    barrierLabel: barrierLabel,
    routeSettings: routeSettings,
    useRootNavigator: useRootNavigator,
    useSafeArea: useSafeArea,
    builder: (context) {
      return DeviceOrientationBuilder(builder: (context, o) {
        late final Size size;
        switch (o) {
          case Orientation.portrait:
            size = const Size(328.0, 400.0);
            break;
          case Orientation.landscape:
            size = const Size(328.0, 300.0);
            break;
        }
        return Padding(
          padding: padding,
          child: Dialog(
            insetPadding: EdgeInsets.zero,
            child: SizedBox(
              width: width ?? size.width,
              height: height ?? size.height,
              child: CustomRangeDatePicker(
                centerLeadingDate: centerLeadingDate,
                currentDate: currentDate,
                maxDate: maxDate,
                minDate: minDate,
                initialDate: initialDate,
                selectedRange: selectedRange,
                onRangeSelected: (value) => Navigator.pop(context, value),
                initialPickerType: initialPickerType,
                padding: contentPadding,
                currentDateDecoration: currentDateDecoration,
                currentDateTextStyle: currentDateTextStyle,
                disabledCellsDecoration: disabledCellsDecoration,
                disabledCellsTextStyle: disabledCellsTextStyle,
                enabledCellsDecoration: enabledCellsDecoration,
                enabledCellsTextStyle: enabledCellsTextStyle,
                selectedCellsDecoration: selectedCellsDecoration,
                selectedCellsTextStyle: selectedCellsTextStyle,
                daysOfTheWeekTextStyle: daysOfTheWeekTextStyle,
                singleSelectedCellTextStyle: singleSelectedCellTextStyle,
                singleSelectedCellDecoration: singleSelectedCellDecoration,
                leadingDateTextStyle: leadingDateTextStyle,
                slidersColor: slidersColor,
                slidersSize: slidersSize,
                highlightColor: highlightColor,
                splashColor: splashColor,
                splashRadius: splashRadius,
                previousPageSemanticLabel: previousPageSemanticLabel,
                nextPageSemanticLabel: nextPageSemanticLabel,
              ),
            ),
          ),
        );
      });
    },
  );
}