gem-hunter
Language: JavaScript
React Native date & time picker component for iOS, Android and Windows
Please support maintenance of the module with a monthly donation or help us with issues and pull requests.
Become a backer on OpenCollective or sponsor us on GitHub Sponsors.
See this issue for context. Thank you!
This repository was moved out of the react native community GH organization, in accordance to this proposal.
The module is still published on npm under the old namespace (as documented) but will be published under a new namespace at some point, with a major version bump.
React Native date & time picker component for iOS, Android and Windows (please note Windows is not actively maintained).
Expand for screenshots| iOS | |
|
|
| Android | |
|
|
|
|
| Windows | |
|
|
|
|
mode (optional)display (optional)design (optional, Android only)initialInputMode (optional, Android only)title (optional, Android only)fullscreen (optional, Android only)startOnYearSelection (optional, Android only)onValueChange (optional)onDismiss (optional)onNeutralButtonPress (optional, Android only)onChange (optional, deprecated)value (required)maximumDate (optional)minimumDate (optional)timeZoneName (optional, iOS or Android only)timeZoneOffsetInMinutes (optional, iOS or Android only)timeZoneOffsetInSeconds (optional, Windows only)dayOfWeekFormat (optional, Windows only)dateFormat (optional, Windows only)firstDayOfWeek (optional, Android and Windows only)textColor (optional, iOS only)accentColor (optional, iOS only)themeVariant (optional, iOS only)locale (optional, iOS only)is24Hour (optional, Windows and Android only)positiveButton (optional, Android only)negativeButton (optional, Android only)neutralButton (optional, Android only)minuteInterval (optional)style (optional, iOS only)disabled (optional, iOS only)view props (optional, iOS only)onError (optional, Android only)The module supports the new React Native architecture (Fabric rendering of iOS components, and turbomodules on Android).
This module is part of Expo Go - see docs. However, Expo Go may not contain the latest version of the module and therefore, the newest features and bugfixes may not be available.
If you use Expo Go, use the command npx expo install @react-native-community/datetimepicker (not yarn or npm) to install this module - Expo will automatically install the latest version compatible with your Expo SDK (which may not be the latest version of the module available).
If you're using a Dev Client, rebuild the Dev Client after installing the dependencies.
If you're using the expo prebuild command and building your native app projects (e.g. with EAS Build or locally), you can use the latest version of the module.
npm install @react-native-community/datetimepicker --save
or
yarn add @react-native-community/datetimepicker
Autolinking is not yet implemented on Windows, so manual installation is needed.
On iOS, run npx pod-install after installing. Then rebuild your project.
import DateTimePicker from '@react-native-community/datetimepicker';
We give two equivalent examples on how to use the package on all supported platforms.
While the component-approach as given in the second paragraph works on Android, the recommended approach is to use the imperative api given in the first paragraph.
Read more about the motivation in Android imperative API.
export const App = () => { const [date, setDate] = useState(new Date(1598051730000)); const showMode = (currentMode) => { DateTimePickerAndroid.open({ value: date, onValueChange: (event, selectedDate) => setDate(selectedDate), mode: currentMode, is24Hour: true, }); }; const showDatepicker = () => { showMode('date'); }; const showTimepicker = () => { showMode('time'); }; return ( <SafeAreaView> <Button onPress={showDatepicker} title="Show date picker!" /> <Button onPress={showTimepicker} title="Show time picker!" /> <Text>selected: {date.toLocaleString()}</Text> </SafeAreaView> ); };
export const App = () => { const [date, setDate] = useState(new Date(1598051730000)); const [mode, setMode] = useState('date'); const [show, setShow] = useState(false); const showMode = (currentMode) => { setShow(true); setMode(currentMode); }; const showDatepicker = () => { showMode('date'); }; const showTimepicker = () => { showMode('time'); }; return ( <SafeAreaView> <Button onPress={showDatepicker} title="Show date picker!" /> <Button onPress={showTimepicker} title="Show time picker!" /> <Text>selected: {date.toLocaleString()}</Text> {show && ( <DateTimePicker testID="dateTimePicker" value={date} mode={mode} is24Hour={true} onValueChange={(event, selectedDate) => setDate(selectedDate)} onDismiss={() => setShow(false)} /> )} </SafeAreaView> ); };
By localization, we refer to the language (names of months and days), as well as order in which date can be presented in a picker (month/day vs. day/month) and 12 / 24 hour-format.
On Android, the picker will be controlled by the system locale. If you wish to change it, see instructions here.
On iOS, use XCode, as documented here to inform the OS about the locales your application supports. iOS will automatically display the correctly localized DateTimePicker as long as the target language is contained in project.pbxproj.
If you use a library like i18next or react-localize-redux to manage your translations, it is sufficient to add your target languages as described in the Apple Documentation - but you are not required to add any localization keys (like, for example, the days of the week). iOS will automatically display the correct localized strings as long as the target language is contained in
project.pbxproj.
For testing your localization setup, refer here.
There is also the iOS-only locale prop that can be used to force locale in some cases but its usage is discouraged due to not working robustly in all picker modes (note the mixed month and day names). To the best of our knowledge, it works reliably in the spinner mode.
For Expo, follow the localization docs.
On Android, you have a choice between using the component API (regular React component) or an imperative api (think of something like ReactNative.alert()).
While the component API has the benefit of writing the same code on all platforms, for start we recommend using the imperative API on Android.
The params is an object with the same properties as the component props documented in the next paragraph. (This is also because the component api internally uses the imperative one.)
import { DateTimePickerAndroid } from '@react-native-community/datetimepicker'; DateTimePickerAndroid.open(params: AndroidNativeProps) DateTimePickerAndroid.dismiss(mode: AndroidNativeProps['mode'], design?: AndroidNativeProps['design'])
The reason we recommend the imperative API is: on Android, the date/time picker opens in a dialog, similar to ReactNative.alert() from core react native. The imperative api models this behavior better than the declarative component api. While the component approach is perfectly functional, based on the issue tracker history, it appears to be more prone to introducing bugs.
If you'd like to use the Material pickers, your app theme will need to inherit from Theme.Material3.DayNight.NoActionBar in styles.xml.
Styling of the dialogs on Android can be easily customized by using the provided config plugin, provided that you use a Expo development build. The plugin allows you to configure color properties that cannot be set at runtime and requires building a new app binary to take effect.
Refer to this documentation for more information: android-styling.md.
Please note that this library currently exposes functionality from
UIDatePickeron iOS and DatePickerDialog + TimePickerDialog on Android, andCalendarDatePicker+ TimePicker on Windows.These native classes offer only limited configuration, while there are dozens of possible options you as a developer may need. It follows that if your requirement is not supported by the backing native views, this library will not be able to implement your requirement. When you open an issue with a feature request, please document if (or how) the feature can be implemented using the aforementioned native views. If the native views do not support what you need, such feature requests will be closed as not actionable.
Defines the type of the picker.
List of possible values:
"date" (default for iOS and Android and Windows)"time""datetime" (iOS only)"countdown" (iOS only)<RNDateTimePicker mode="time" />
Defines the visual display of the picker. The default value is "default".
List of possible values for Android
"default" - Recommended. Show a default date picker (spinner/calendar/clock) based on mode."spinner""calendar" (only for date mode)"clock" (only for time mode)List of possible values for iOS (maps to preferredDatePickerStyle)
"default" - Automatically pick the best style available for the current platform & mode."spinner" - the usual pre-iOS 14 appearance with a wheel from which you choose values"compact" - Affects only iOS 14 and later. Will fall back to "spinner" if not supported."inline" - Affects only iOS 14 and later. Will fall back to "spinner" if not supported.<RNDateTimePicker display="spinner" />
Defines if the picker should use Material 3 components or the default picker. The default value is "default".
List of possible values
"default""material"<RNDateTimePicker design="material" />
Called when the user selects a date or time. Receives an event with nativeEvent: { timestamp, utcOffset } and the selected Date.
<RNDateTimePicker onValueChange={(event, date) => setDate(date)} />
Called when the picker is dismissed without selecting a value. Receives no arguments.
<RNDateTimePicker onDismiss={() => setShow(false)} />
Called when the neutral button is pressed. Receives no arguments. See neutralButton.
<RNDateTimePicker neutralButton={{label: 'Clear', textColor: 'grey'}} onNeutralButtonPress={() => clearDate()} />
Deprecated: Use
onValueChange,onDismiss, andonNeutralButtonPressinstead. If the new specific listeners are provided, they take precedence overonChangefor their respective event types.
Date change handler.
This is called when the user changes the date or time in the UI. It receives the event and the date as parameters.
It is also called when user dismisses the picker, which you can detect by checking the event.type property.
The values can be: 'set' | 'dismissed' | 'neutralButtonPressed'. (neutralButtonPressed is only available on Android).
The utcOffset field is only available on Android and iOS. It is the offset in minutes between the selected date and UTC time.
const setDate = (event: DateTimePickerEvent, date: Date) => { const { type, nativeEvent: {timestamp, utcOffset}, } = event; }; <RNDateTimePicker onChange={this.setDate} />;
Defines the date or time value used in the component.
<RNDateTimePicker value={new Date()} />
Defines the maximum date that can be selected. Note that on Android, this only works for date mode because TimePicker does not support this.
<RNDateTimePicker maximumDate={new Date(2030, 10, 20)} />
Defines the minimum date that can be selected. Note that on Android, this only works for date mode because TimePicker does not support this.
<RNDateTimePicker minimumDate={new Date(1950, 0, 1)} />
Allows changing of the time zone of the date picker. By default, it uses the device's time zone. Use the time zone name from the IANA (TZDB) database name in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
<RNDateTimePicker timeZoneName={'Europe/Prague'} />
Allows changing of the time zone of the date picker. By default, it uses the device's time zone.
We strongly recommend using timeZoneName prop instead; this prop has known issues in the android implementation (eg. #528).
This prop will be removed in a future release.
// GMT+1 <RNDateTimePicker timeZoneOffsetInMinutes={60} />
Allows changing of the time zone of the date picker. By default, it uses the device's time zone.
// UTC+1 <RNDateTimePicker timeZoneOffsetInSeconds={3600} />
Sets the display format for the day of the week headers. Reference: https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.calendarview.dayofweekformat?view=winrt-18362#remarks
<RNDateTimePicker dayOfWeekFormat={'{dayofweek.abbreviated(2)}'} />
Sets the display format for the date value in the picker's text box. Reference: https://docs.microsoft.com/en-us/uwp/api/windows.globalization.datetimeformatting.datetimeformatter?view=winrt-18362#examples
<RNDateTimePicker dateFormat="dayofweek day month" />
Indicates which day is shown as the first day of the week.
<RNDateTimePicker firstDayOfWeek={DAY_OF_WEEK.Wednesday} /> // The native parameter type is an enum defined in defined https://docs.microsoft.com/en-us/uwp/api/windows.globalization.dayofweek?view=winrt-18362 - meaning an integer needs to passed here (DAY_OF_WEEK).
Allows changing of the textColor of the date picker. Has effect only when display is "spinner".
<RNDateTimePicker textColor="red" />
Allows changing the accentColor (tintColor) of the date picker.
Has no effect when display is "spinner".
Allows overriding system theme variant (dark or light mode) used by the date picker. However, we recommend that you instead control the theme of the whole application using react-native-theme-control.
⚠️ Has effect only on iOS 14 and later. On iOS 13 & less, use textColor to make the picker dark-theme compatible
List of possible values:
"light""dark"<RNDateTimePicker themeVariant="light" />
Allows changing the locale of the component. This affects the displayed text and the date / time formatting. By default, the device's locale is used. Please note using this prop is discouraged due to not working reliably in all picker modes. Prefer localization as documented in Localization note.
<RNDateTimePicker locale="es-ES" />
Allows changing of the time picker to a 24-hour format. By default, this value is decided automatically based on the locale and other preferences.
<RNDateTimePicker is24Hour={true} />
⚠️ Has effect only when design is "material". Allows setting the initial input mode of the picker.
List of possible values:
"default" - Recommended. Date pickers will show the calendar view by default, and time pickers will show the clock view by default."keyboard" - Both pickers will show an input where the user can type the date or time.<RNDateTimePicker initialInputMode="default" />
⚠️ Has effect only when design is "material". Allows setting the title of the dialog for the pickers.
<RNDateTimePicker title="Choose anniversary" />
⚠️ Has effect only when design is "material". Allows setting the date picker dialog to be fullscreen.
<RNDateTimePicker fullscreen={true} />
If true, the date picker will open with the year selector first. Not applicable for material picker.
<RNDateTimePicker startOnYearSelection={true} />
Set the positive button label and text color.
<RNDateTimePicker positiveButton={{label: 'OK', textColor: 'green'}} />
Allows displaying neutral button on picker dialog.
Pressing the button can be observed via the onNeutralButtonPress callback.
<RNDateTimePicker neutralButton={{label: 'Clear', textColor: 'grey'}} />
Set the negative button label and text color.
<RNDateTimePicker negativeButton={{label: 'Cancel', textColor: 'red'}} />
The interval at which minutes can be selected.
Possible values are: 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30
On Windows, this can be any number between 0-59.
on iOS, this in only supported when display="spinner"
<RNDateTimePicker minuteInterval={10} />
Sets style directly on picker component. By default, the picker dimensions are determined based on the props.
Please note that by default, picker's text color is controlled by the application theme (light / dark mode). In dark mode, text is white and in light mode, text is black. If you want to control the application theme, we recommend using react-native-theme-control.
This means that e.g. if the device has dark mode turned on, and your screen background color is white, you will not see the picker. Please use the Appearance api to adjust the picker's background color so that it is visible, as we do in the example App.
Alternatively, use the themeVariant prop.
<RNDateTimePicker style={{flex: 1}} />
If true, the user won't be able to interact with the view.
Usually used by app automation frameworks.
Fully supported on iOS. On Android, only supported for mode="date".
<RNDateTimePicker testID="datePicker" />
On iOS, you can pass any View props to the component. Given that the underlying component is a native view, not all of them are guaranteed to be supported, but testID and onLayout are known to work.
Callback that is called when an error occurs inside the date picker native code (such as null activity).
For examples of how you can write your tests, look here.
Please see migration.md
Please see CONTRIBUTING.md
Please see manual-installation.md
yarn in repo rootcd examplenpx pod-installyarn start to start Metro Bundleryarn run start:ios or yarn run start:android or yarn run start:windowsexample folder) in xCode or Android Studio. The example project depends on the library code, which you can edit and observe any changes in the example project.This project is tested with BrowserStack.