showRTimePicker function

Future<TimeOfDay> showRTimePicker (
  1. {@required TimeOfDay initialTime,
  2. TransitionBuilder builder}
)

Shows a dialog containing a material design time picker.

The returned Future resolves to the time selected by the user when the user closes the dialog. If the user cancels the dialog, null is returned.

{@tool sample} Show a dialog with initialTime equal to the current time.

Future<TimeOfDay> selectedTime = showTimePicker(
  initialTime: TimeOfDay.now(),
  context: context,
);

{@end-tool}

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

The builder parameter can be used to wrap the dialog widget to add inherited widgets like Localizations.override, Directionality, or MediaQuery.

{@tool sample} Show a dialog with the text direction overridden to be TextDirection.rtl.

Future<TimeOfDay> selectedTimeRTL = showTimePicker(
  context: context,
  initialTime: TimeOfDay.now(),
  builder: (BuildContext context, Widget child) {
    return Directionality(
      textDirection: TextDirection.rtl,
      child: child,
    );
  },
);

{@end-tool}

{@tool sample} Show a dialog with time unconditionally displayed in 24 hour format.

Future<TimeOfDay> selectedTime24Hour = showTimePicker(
  context: context,
  initialTime: TimeOfDay(hour: 10, minute: 47),
  builder: (BuildContext context, Widget child) {
    return MediaQuery(
      data: MediaQuery.of(context).copyWith(alwaysUse24HourFormat: true),
      child: child,
    );
  },
);

{@end-tool}

See also:

  • showDatePicker, which shows a dialog that contains a material design date picker.

Implementation

Future<TimeOfDay> showRTimePicker({
  @required TimeOfDay initialTime,
  TransitionBuilder builder,
}) async {
  BuildContext context = RRouter.context;

  assert(initialTime != null);
  assert(debugCheckHasMaterialLocalizations(context));

  final Widget dialog = _TimePickerDialog(initialTime: initialTime);
  return await showRDialog<TimeOfDay>(
    builder: (BuildContext context) {
      return builder == null ? dialog : builder(context, dialog);
    },
  );
}