react-toolbox/components/time_picker/readme.md

1.1 KiB

Time Picker

A dialog picker is used to select a single time (hours:minutes). The selected time is indicated by the filled circle at the end of the clock hand.

import TimePicker from 'react-toolbox/time_picker';

let selectedTime = new Date();
selectedTime.setHours(17);
selectedTime.setMinutes(28);

const TimePickerTest = () => (
  <TimePicker value={selectedTime} />
);

Properties

Name Type Default Description
className String '' Sets a class to give customized styles.
format String 24hr Format to display the clock. It can be 24hr or ampm.
value Date Datetime object with currrently selected time

Methods

The TimePicker is a very easy component from the top level API but quite complex inside. It has state to keep the the currently selected value.

  • getValue is used to retrieve the current value.
  • setValue to force a new value.