CupertinoDatePicker class

A date picker widget in iOS style.

There are several modes of the date picker listed in CupertinoDatePickerMode.

The class will display its children as consecutive columns. Its children order is based on internationalization, or the dateOrder property if specified.

Example of the picker in date mode:

  • US-English: | July | 13 | 2012 |
  • Vietnamese: | 13 | Tháng 7 | 2012 |

Can be used with showCupertinoModalPopup to display the picker modally at the bottom of the screen.

Sizes itself to its parent and may not render correctly if not given the full screen width. Content texts are shown with CupertinoTextThemeData.dateTimePickerTextStyle.

{@tool dartpad} This sample shows how to implement CupertinoDatePicker with different picker modes. We can provide intiial dateTime value for the picker to display. When user changes the drag the date or time wheels, the picker will call onDateTimeChanged callback.

CupertinoDatePicker can be displayed directly on a screen or in a popup.

** See code in examples/api/lib/cupertino/date_picker/cupertino_date_picker.0.dart ** {@end-tool}

See also:

Inheritance
Available extensions

Constructors

CupertinoDatePicker({Key? key, CupertinoDatePickerMode mode = CupertinoDatePickerMode.dateAndTime, required ValueChanged<DateTime> onDateTimeChanged, DateTime? initialDateTime, DateTime? minimumDate, DateTime? maximumDate, int minimumYear = 1, int? maximumYear, int minuteInterval = 1, bool use24hFormat = false, DatePickerDateOrder? dateOrder, Color? backgroundColor, bool? hideDay})
Constructs an iOS style date picker.

Properties

backgroundColor → Color?
Background color of date picker.
final
cardWidget → Widget

Available on Widget, provided by the WidgetExt extension

no setter
center → Widget

Available on Widget, provided by the WidgetExt extension

no setter
circleWidget → Widget

Available on Widget, provided by the CircleExt extension

no setter
dateOrder → DatePickerDateOrder?
Determines the order of the columns inside CupertinoDatePicker in date mode. Defaults to the locale's default date format/order.
final
editPage → Widget

Available on Widget, provided by the WidgetExt extension

no setter
expanded → Widget

Available on Widget, provided by the WidgetExt extension

no setter
hashCode → int
The hash code for this object.
no setterinherited
hideDay → bool?
隐藏日期
final
initialDateTime → DateTime
The initial date and/or time of the picker. Defaults to the present date and time and must not be null. The present must conform to the intervals set in minimumDate, maximumDate, minimumYear, and maximumYear.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
materialRouter → Route

Available on Widget, provided by the WidgetExt extension

no setter
maximumDate → DateTime?
The maximum selectable date that the picker can settle on.
final
maximumYear → int?
Maximum year that the picker can be scrolled to in CupertinoDatePickerMode.date mode. Null if there's no limit.
final
maxWidthButton → Widget

Available on Widget, provided by the WidgetExt extension

no setter
minimumDate → DateTime?
The minimum selectable date that the picker can settle on.
final
minimumYear → int
Minimum year that the picker can be scrolled to in CupertinoDatePickerMode.date mode. Defaults to 1 and must not be null.
final
minuteInterval → int
The granularity of the minutes spinner, if it is shown in the current mode. Must be an integer factor of 60.
final
mode → CupertinoDatePickerMode
The mode of the date picker as one of CupertinoDatePickerMode. Defaults to CupertinoDatePickerMode.dateAndTime. Cannot be null and value cannot change after initial build.
final
onDateTimeChanged → ValueChanged<DateTime>
Callback called when the selected date and/or time changes. If the new selected DateTime is not valid, or is not in the minimumDate through maximumDate range, this callback will not be called.
final
positionedFill → Widget

Available on Widget, provided by the WidgetExt extension

no setter
removeScrollViewSplash → Widget

Available on Widget, provided by the WidgetExt extension

no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
topBorder → Widget

Available on Widget, provided by the WidgetExt extension

no setter
toSliverWidget → Widget

Available on Widget, provided by the WidgetExt extension

no setter
use24hFormat → bool
Whether to use 24 hour format. Defaults to false.
final

Methods

addScrollbar({ScrollController? controller}) → Widget

Available on Widget, provided by the WidgetExt extension

添加滚动条
addTap(VoidCallback onTap) → Widget

Available on Widget, provided by the WidgetTa extension

aspectRatio(double v) → Widget

Available on Widget, provided by the WidgetExt extension

bg(Color color) → Widget

Available on Widget, provided by the CircleExt extension

border(BuildContext context, {BoxDecoration? decoration, Color? borderColor, BorderRadius? borderRadius, double width = 1.0}) → Widget

Available on Widget, provided by the WidgetExt extension

click(VoidCallback onTap) → Widget

Available on Widget, provided by the WidgetExt extension

clipRadius(double radius) → Widget

Available on Widget, provided by the CircleExt extension

constraintBox(BuildWidget buildWidget) → Widget

Available on Widget, provided by the CircleExt extension

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<StatefulWidget>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
disableTextScaling(BuildContext context, ValueCopyWith<MediaQueryData> copyWith) → Widget

Available on Widget, provided by the WidgetExt extension

ifShow(bool show) → Widget

Available on Widget, provided by the WidgetExt extension

ifTrue(bool value, Widget trueWidget, [Duration? duration]) → Widget

Available on Widget, provided by the WidgetExt extension

如果value为true, 则展示trueWidget,否则展示为本身this
loading(bool value) → Widget

Available on Widget, provided by the WidgetExt extension

longClick({required VoidCallback onLongPress}) → Widget

Available on Widget, provided by the WidgetExt extension

marginOnly({double left = 0.0, double right = 0.0, double top = 0.0, double bottom = 0.0}) → Widget

Available on Widget, provided by the WidgetExt extension

maxHeight(double height) → Widget

Available on Widget, provided by the WidgetExt extension

maxWidth(double width) → Widget

Available on Widget, provided by the WidgetExt extension

minHeight(double height) → Widget

Available on Widget, provided by the WidgetExt extension

minWidth(double width) → Widget

Available on Widget, provided by the WidgetExt extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paddingOnly({double left = 0.0, double right = 0.0, double top = 0.0, double bottom = 0.0}) → Widget

Available on Widget, provided by the WidgetExt extension

paddingWithObj(EdgeInsets edgeInsets) → Widget

Available on Widget, provided by the WidgetExt extension

sizeBox(double w, double h) → Widget

Available on Widget, provided by the CircleExt extension

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited
visible(bool value) → Widget

Available on Widget, provided by the WidgetExt extension

visibleOrNull(bool value) → Widget?

Available on Widget, provided by the WidgetExt extension

Operators

operator ==(Object other) → bool
The equality operator.
inherited