Skip to main content

TimePicker

A scroll-wheel time picker.

When to use it

Use TimePicker when the user needs to pick an hour and minute — scheduling forms, alarms, or reminders. Shows drum-roll columns for hours and minutes, plus an AM/PM column when use24HourFormat is false. The hour on the emitted PickerTime is always in 24-hour format regardless of use24HourFormat.

Import

import 'package:catalyst_ui/catalyst_ui.dart';

Usage

TimePicker(
initialTime: const PickerTime(hour: 9, minute: 30),
onTimeChanged: (t) => setState(() => _time = t),
)

Parameters

ParameterTypeDefaultDescription
onTimeChangedValueChanged<PickerTime>requiredCalled whenever the selected time changes.
initialTimePickerTime?nullThe initially displayed time. Defaults to midnight (00:00) when null.
use24HourFormatbooltrueWhen false, shows 1-12 hours and an AM/PM column.

PickerTime

An hour-and-minute pair produced by TimePicker.

ParameterTypeDefaultDescription
hourintrequiredHour in 24-hour format (0-23).
minuteintrequiredMinute (0-59).

PickerTime implements value equality (==/hashCode) based on hour and minute, and its toString() renders as zero-padded HH:mm.