CalendarDatePicker class Null safety

Displays a grid of days for a given month and allows the user to select a date.

Days are arranged in a rectangular grid with one column for each day of the week. Controls are provided to change the year and month that the grid is showing.

The calendar picker widget is rarely used directly. Instead, consider using showDatePicker, which will create a dialog that uses this as well as provides a text entry option.

See also:

  • showDatePicker, which creates a Dialog that contains a CalendarDatePicker and provides an optional compact view where the user can enter a date as a line of text.
  • showTimePicker, which shows a dialog that contains a Material Design time picker.


CalendarDatePicker({Key? key, required DateTime initialDate, required DateTime firstDate, required DateTime lastDate, DateTime? currentDate, required ValueChanged<DateTime> onDateChanged, ValueChanged<DateTime>? onDisplayedMonthChanged, DatePickerMode initialCalendarMode =, SelectableDayPredicate? selectableDayPredicate})
Creates a calendar date picker.


currentDate DateTime
The DateTime representing today. It will be highlighted in the day grid.
firstDate DateTime
The earliest allowable DateTime that the user can select.
hashCode int
The hash code for this object.
@nonVirtual, read-only, inherited
initialCalendarMode DatePickerMode
The initial display of the calendar picker.
initialDate DateTime
The initially selected DateTime that the picker should display.
key Key?
Controls how one widget replaces another widget in the tree.
final, inherited
lastDate DateTime
The latest allowable DateTime that the user can select.
onDateChanged ValueChanged<DateTime>
Called when the user selects a date in the picker.
onDisplayedMonthChanged ValueChanged<DateTime>?
Called when the user navigates to a new month/year in the picker.
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
selectableDayPredicate SelectableDayPredicate?
Function to provide full control over which dates in the calendar can be selected.


createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
createState() State<CalendarDatePicker>
Creates the mutable state for this widget at a given location in the tree.
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
toString({DiagnosticLevel minLevel =}) String
A string representation of this object.
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
toStringShort() String
A short, textual description of this widget.


operator ==(Object other) bool
The equality operator.
@nonVirtual, inherited