showDatePicker function Null safety
- {required BuildContext context,
- required DateTime initialDate,
- required DateTime firstDate,
- required DateTime lastDate,
- DateTime? currentDate,
- DatePickerEntryMode initialEntryMode = DatePickerEntryMode.calendar,
- SelectableDayPredicate? selectableDayPredicate,
- String? helpText,
- String? cancelText,
- String? confirmText,
- Locale? locale,
- RouteSettings? routeSettings,
- TextDirection? textDirection,
- TransitionBuilder? builder,
- DatePickerMode initialDatePickerMode = DatePickerMode.day,
- String? errorFormatText,
- String? errorInvalidText,
- String? fieldHintText,
- String? fieldLabelText,
- TextInputType? keyboardType,
- Offset? anchorPoint}
Shows a dialog containing a Material Design date picker.
The returned Future resolves to the date selected by the user when the user confirms the dialog. If the user cancels the dialog, null is returned.
When the date picker is first displayed, it will show the month of
initialDate
, with initialDate
selected.
The firstDate
is the earliest allowable date. The lastDate
is the latest
allowable date. initialDate
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. They must all
be non-null.
The currentDate
represents the current day (i.e. today). This
date will be highlighted in the day grid. If null, the date of
DateTime.now()
will be used.
An optional initialEntryMode
argument can be used to display the date
picker in the DatePickerEntryMode.calendar (a calendar month grid)
or DatePickerEntryMode.input (a text input field) mode.
It defaults to DatePickerEntryMode.calendar and must be non-null.
An optional selectableDayPredicate
function can be passed in to only allow
certain days for selection. If provided, only the days that
selectableDayPredicate
returns true for will be selectable. For example,
this can be used to only allow weekdays for selection. If provided, it must
return true for initialDate
.
The following optional string parameters allow you to override the default text used for various parts of the dialog:
helpText
, label displayed at the top of the dialog.cancelText
, label on the cancel button.confirmText
, label on the ok button.errorFormatText
, message used when the input text isn't in a proper date format.errorInvalidText
, message used when the input text isn't a selectable date.fieldHintText
, text used to prompt the user when no text has been entered in the field.fieldLabelText
, label for the date text input field.
An optional locale
argument can be used to set the locale for the date
picker. It defaults to the ambient locale provided by Localizations.
An optional textDirection
argument can be used to set the text direction
(TextDirection.ltr or TextDirection.rtl) for the date picker. It
defaults to the ambient text direction provided by Directionality. If both
locale
and textDirection
are non-null, textDirection
overrides the
direction chosen for the locale
.
The context
, useRootNavigator
and routeSettings
arguments are passed to
showDialog, the documentation for which discusses how it is used. context
and useRootNavigator
must be non-null.
The builder
parameter can be used to wrap the dialog widget
to add inherited widgets like Theme.
An optional initialDatePickerMode
argument can be used to have the
calendar date picker initially appear in the DatePickerMode.year or
DatePickerMode.day mode. It defaults to DatePickerMode.day, and
must be non-null.
A DisplayFeature can split the screen into sub-screens. The closest one to
anchorPoint
is used to render the content.
If no anchorPoint
is provided, then Directionality is used:
- for TextDirection.ltr,
anchorPoint
isOffset.zero
, which will cause the content to appear in the top-left sub-screen. - for TextDirection.rtl,
anchorPoint
isOffset(double.maxFinite, 0)
, which will cause the content to appear in the top-right sub-screen.
If no anchorPoint
is provided, and there is no Directionality ancestor
widget in the tree, then the widget asserts during build in debug mode.
State Restoration
Using this method will not enable state restoration for the date picker. In order to enable state restoration for a date picker, use Navigator.restorablePush or Navigator.restorablePushNamed with DatePickerDialog.
For more information about state restoration, see RestorationManager.
To test state restoration on Android:
- Turn on "Don't keep activities", which destroys the Android activity as soon as the user leaves it. This option should become available when Developer Options are turned on for the device.
- Run the code sample on an Android device.
- Create some in-memory state in the app on the phone, e.g. by navigating to a different screen.
- Background the Flutter app, then return to it. It will restart and restore its state.
To test state restoration on iOS:
- Open
ios/Runner.xcworkspace/
in Xcode. - (iOS 14+ only): Switch to build in profile or release mode, as launching an app from the home screen is not supported in debug mode.
- Press the Play button in Xcode to build and run the app.
- Create some in-memory state in the app on the phone, e.g. by navigating to a different screen.
- Background the app on the phone, e.g. by going back to the home screen.
- Press the Stop button in Xcode to terminate the app while running in the background.
- Open the app again on the phone (not via Xcode). It will restart and restore its state.
flutter create --sample=material.showDatePicker.1 mysample
See also:
- showDateRangePicker, which shows a Material Design date range picker used to select a range of dates.
- CalendarDatePicker, which provides the calendar grid used by the date picker dialog.
- InputDatePickerFormField, which provides a text input field for entering dates.
- DisplayFeatureSubScreen, which documents the specifics of how DisplayFeatures can split the screen into sub-screens.
- showTimePicker, which shows a dialog that contains a Material Design time picker.
Implementation
Future<DateTime?> showDatePicker({
required BuildContext context,
required DateTime initialDate,
required DateTime firstDate,
required DateTime lastDate,
DateTime? currentDate,
DatePickerEntryMode initialEntryMode = DatePickerEntryMode.calendar,
SelectableDayPredicate? selectableDayPredicate,
String? helpText,
String? cancelText,
String? confirmText,
Locale? locale,
bool useRootNavigator = true,
RouteSettings? routeSettings,
TextDirection? textDirection,
TransitionBuilder? builder,
DatePickerMode initialDatePickerMode = DatePickerMode.day,
String? errorFormatText,
String? errorInvalidText,
String? fieldHintText,
String? fieldLabelText,
TextInputType? keyboardType,
Offset? anchorPoint,
}) async {
assert(context != null);
assert(initialDate != null);
assert(firstDate != null);
assert(lastDate != null);
initialDate = DateUtils.dateOnly(initialDate);
firstDate = DateUtils.dateOnly(firstDate);
lastDate = DateUtils.dateOnly(lastDate);
assert(
!lastDate.isBefore(firstDate),
'lastDate $lastDate must be on or after firstDate $firstDate.',
);
assert(
!initialDate.isBefore(firstDate),
'initialDate $initialDate must be on or after firstDate $firstDate.',
);
assert(
!initialDate.isAfter(lastDate),
'initialDate $initialDate must be on or before lastDate $lastDate.',
);
assert(
selectableDayPredicate == null || selectableDayPredicate(initialDate),
'Provided initialDate $initialDate must satisfy provided selectableDayPredicate.',
);
assert(initialEntryMode != null);
assert(useRootNavigator != null);
assert(initialDatePickerMode != null);
assert(debugCheckHasMaterialLocalizations(context));
Widget dialog = DatePickerDialog(
initialDate: initialDate,
firstDate: firstDate,
lastDate: lastDate,
currentDate: currentDate,
initialEntryMode: initialEntryMode,
selectableDayPredicate: selectableDayPredicate,
helpText: helpText,
cancelText: cancelText,
confirmText: confirmText,
initialCalendarMode: initialDatePickerMode,
errorFormatText: errorFormatText,
errorInvalidText: errorInvalidText,
fieldHintText: fieldHintText,
fieldLabelText: fieldLabelText,
keyboardType: keyboardType,
);
if (textDirection != null) {
dialog = Directionality(
textDirection: textDirection,
child: dialog,
);
}
if (locale != null) {
dialog = Localizations.override(
context: context,
locale: locale,
child: dialog,
);
}
return showDialog<DateTime>(
context: context,
useRootNavigator: useRootNavigator,
routeSettings: routeSettings,
builder: (BuildContext context) {
return builder == null ? dialog : builder(context, dialog);
},
anchorPoint: anchorPoint,
);
}