fbpx

React Native date & time picker component for iOS and Android

React Native date & time picker component for iOS and Android

React Native date & time picker component for iOS and Android

Requirements

  • Xcode >= 11; please open a PR if you need to support building with older Xcode versions – see #133. Please note that we support iOS >= 10 but you need Xcode 11 to build.

Getting started

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.

RN >= 0.60

If you are using RN >= 0.60, only run npx pod-install. Then rebuild your project.

RN < 0.60

For RN < 0.60, you need to link the dependency using react-native link:

react-native link @react-native-community/datetimepicker

Then run npx pod-install and rebuild your project.

If this does not work, see Manual installation.

General Usage

import DateTimePicker from '@react-native-community/datetimepicker';

or

const DateTimePicker = require('@react-native-community/datetimepicker');

Basic usage with state

import React, {useState} from 'react';
import {View, Button, Platform} from 'react-native';
import DateTimePicker from '@react-native-community/datetimepicker';

const App = () => {
  const [date, setDate] = useState(new Date(1598051730000));
  const [mode, setMode] = useState('date');
  const [show, setShow] = useState(false);

  const onChange = (event, selectedDate) => {
    const currentDate = selectedDate || date;
    setShow(Platform.OS === 'ios');
    setDate(currentDate);
  };

  const showMode = currentMode => {
    setShow(true);
    setMode(currentMode);
  };

  const showDatepicker = () => {
    showMode('date');
  };

  const showTimepicker = () => {
    showMode('time');
  };

  return (
    <View>
      <View>
        <Button onPress={showDatepicker} title="Show date picker!" />
      </View>
      <View>
        <Button onPress={showTimepicker} title="Show time picker!" />
      </View>
      {show && (
        <DateTimePicker
          testID="dateTimePicker"
          value={date}
          mode={mode}
          is24Hour={true}
          display="default"
          onChange={onChange}
        />
      )}
    </View>
  );
};

export default App;

Props

Please note that this library currently exposes functionality from UIDatePicker on iOS and DatePickerDialog + TimePickerDialog on Android, and CalendarDatePicker 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 libray 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 those views do not support what you need, such feature requests will be closed as not actionable.

mode (optional)

Defines the type of the picker.

List of possible values:

  • "date" (default for iOS and Android and Windows)
  • "time" (currently unavailable on Windows, work tracked by microsoft/react-native-windows#4695)
  • "datetime" (iOS only)
  • "countdown" (iOS only)
<RNDateTimePicker mode="time" />

display (optionalAndroid only)

Defines the visual display of the picker for Android and will be ignored for iOS.

List of possible values:

  • "default"
  • "spinner"
  • "calendar" (only for date mode)
  • "clock" (only for time mode)
<RNDateTimePicker display="spinner" />

onChange (optional)

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.

setDate = (event, date) => {};

<RNDateTimePicker onChange={this.setDate} />;

value (required)

Defines the date or time value used in the component.

<RNDateTimePicker value={new Date()} />

maximumDate (optional)

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(2300, 10, 20)} />

minimumDate (optional)

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)} />

timeZoneOffsetInMinutes (optionaliOS only)

Allows changing of the timeZone of the date picker. By default it uses the device’s time zone.

// GMT+1
<RNDateTimePicker timeZoneOffsetInMinutes={60} />

timeZoneOffsetInSeconds (optionalWindows only)

Allows changing of the time zone of the date picker. By default it uses the device’s time zone.

// UTC+1
<RNDateTimePicker timeZoneOffsetInSeconds={3600} />

dayOfWeekFormat (optionalWindows only)

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)}'} />

dateFormat (optionalWindows only)

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" />

firstDayOfWeek (optionalWindows only)

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).

textColor (optionaliOS only)

Allows changing of the textColor of the date picker.

<RNDateTimePicker textColor="red" />

locale (optionaliOS only)

Allows changing of the locale of the component. By default it uses the device’s locale.

<RNDateTimePicker locale="es-ES" />

is24Hour (optionalAndroid only)

Allows changing of the time picker to a 24 hour format. By default, this value is decided automatcially based on the user’s chosen locale and other preferences.

<RNDateTimePicker is24Hour={true} />

neutralButtonLabel (optionalAndroid only)

Allows displaying neutral button on picker dialog. Pressing button can be observed in onChange handler as event.type === 'neutralButtonPressed'

<RNDateTimePicker neutralButtonLabel="clear" />

minuteInterval (optionaliOS only)

The interval at which minutes can be selected. Possible values are: 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30

<RNDateTimePicker minuteInterval={10} />

style (optionaliOS only)

Sets style directly on picker component. By default height of picker is fixed to 216px.

<RNDateTimePicker style={{flex: 1}} />

Migration from the older components

RNDateTimePicker is the new common name used to represent the old versions of iOS and Android.

On Android, open picker modals will update the selected date and/or time if the prop value changes. For example, if a HOC holding state, updates the value prop. Previously the component used to close the modal and render a new one on consecutive calls.

DatePickerIOS

  • initialDate is deprecated, use value instead.// Before <DatePickerIOS initialValue={new Date()} />// Now <RNDateTimePicker value={new Date()} />
  • date is deprecated, use value instead.// Before <DatePickerIOS date={new Date()} />// Now <RNDateTimePicker value={new Date()} />
  • onChange now returns also the date.// Before onChange = event => {}; <DatePickerIOS onChange={this.onChange} />;// Now onChange = (event, date) => {}; <RNDateTimePicker onChange={this.onChange} />;
  • onDateChange is deprecated, use onChange instead.// Before setDate = date => {}; <DatePickerIOS onDateChange={this.setDate} />;// Now setDate = (event, date) => {}; <RNDateTimePicker onChange={this.setDate} />;

DatePickerAndroid

  • date is deprecated, use value instead.// Before try { const {action, year, month, day} = await DatePickerAndroid.open({ date: new Date(), }); } catch ({code, message}) { console.warn(‘Cannot open date picker’, message); }// Now <RNDateTimePicker mode=”date” value={new Date()} />
  • minDate and maxDate are deprecated, use minimumDate and maximumDate instead.// Before try { const {action, year, month, day} = await DatePickerAndroid.open({ minDate: new Date(), maxDate: new Date(), }); } catch ({code, message}) { console.warn(‘Cannot open date picker’, message); }// Now <RNDateTimePicker mode=”date” minimumDate={new Date()} maximumDate={new Date()} />
  • dateSetAction is deprecated, use onChange instead.// Before try { const {action, year, month, day} = await DatePickerAndroid.open(); if (action === DatePickerAndroid.dateSetAction) { // Selected year, month (0-11), day } } catch ({code, message}) { console.warn(‘Cannot open date picker’, message); }// Now setDate = (event, date) => { if (date !== undefined) { // timeSetAction } }; <RNDateTimePicker mode=”date” onChange={this.setDate} />;
  • dismissedAction is deprecated, use onChange instead.// Before try { const {action, year, month, day} = await DatePickerAndroid.open(); if (action === DatePickerAndroid.dismissedAction) { // Dismissed } } catch ({code, message}) { console.warn(‘Cannot open date picker’, message); }// Now setDate = (event, date) => { if (date === undefined) { // dismissedAction } }; <RNDateTimePicker mode=”date” onChange={this.setDate} />;

TimePickerAndroid

  • hour and minute are deprecated, use value instead.// Before try { const {action, hour, minute} = await TimePickerAndroid.open({ hour: 14, minute: 0, is24Hour: false, // Will display ‘2 PM’ }); if (action !== TimePickerAndroid.dismissedAction) { // Selected hour (0-23), minute (0-59) } } catch ({code, message}) { console.warn(‘Cannot open time picker’, message); }// Now // It will use the hour and minute defined in date <RNDateTimePicker mode=”time” value={new Date()} />
  • timeSetAction is deprecated, use onChange instead.// Before try { const {action, hour, minute} = await TimePickerAndroid.open(); if (action === TimePickerAndroid.timeSetAction) { // Selected hour (0-23), minute (0-59) } } catch ({code, message}) { console.warn(‘Cannot open time picker’, message); }// Now setTime = (event, date) => { if (date !== undefined) { // Use the hour and minute from the date object } }; <RNDateTimePicker mode=”time” onChange={this.setTime} />;
  • dismissedAction is deprecated, use onChange instead.// Before try { const {action, hour, minute} = await TimePickerAndroid.open(); if (action === TimePickerAndroid.dismissedAction) { // Dismissed } } catch ({code, message}) { console.warn(‘Cannot open time picker’, message); }// Now setTime = (event, date) => { if (date === undefined) { // dismissedAction } }; <RNDateTimePicker mode=”time” onChange={this.setTime} />;

Contributing to the component

Please see CONTRIBUTING.md

Manual installation

iOS

  1. Install CocoaPods, here the installation guide.
  2. Inside the iOS folder run pod init, this will create the initial pod file.
  3. Update your pod file to look like the following ( Remember to replace MyApp with your target name ):# Allowed sources source ‘https://github.com/CocoaPods/Specs.git’ target ‘MyApp’ do # As we use Swift, ensure that `use_frameworks` is enabled. use_frameworks! # Specific iOS platform we are targetting platform :ios, ‘8.0’ # Point to the installed version pod ‘RNDateTimePicker’, :path => ‘../node_modules/@react-native-community/datetimepicker/RNDateTimePicker.podspec’ # React/React-Native specific pods pod ‘React’, :path => ‘../node_modules/react-native’, :subspecs => [ ‘Core’, ‘CxxBridge’, # Include this for RN >= 0.47 ‘DevSupport’, # Include this to enable In-App Devmenu if RN >= 0.43 ‘RCTText’, ‘RCTNetwork’, ‘RCTWebSocket’, # Needed for debugging ] # Explicitly include Yoga if you are using RN >= 0.42.0 pod ‘yoga’, :path => ‘../node_modules/react-native/ReactCommon/yoga’ # Third party deps podspec link pod ‘DoubleConversion’, :podspec => ‘../node_modules/react-native/third-party-podspecs/DoubleConversion.podspec’ pod ‘glog’, :podspec => ‘../node_modules/react-native/third-party-podspecs/glog.podspec’ pod ‘Folly’, :podspec => ‘../node_modules/react-native/third-party-podspecs/Folly.podspec’ end
  4. Run pod install inside the same folder where the pod file was created
  5. npm run start
  6. npm run start:ios

Android

  1. Add the following lines to android/settings.gradle:include ‘:@react-native-community_datetimepicker’ project(‘:@react-native-community_datetimepicker’).projectDir = new File(rootProject.projectDir, ‘../node_modules/@react-native-community/datetimepicker/android’)
  2. Add the compile line to the dependencies in android/app/build.gradle:dependencies { … implementation project(‘:@react-native-community_datetimepicker’) }
  3. Add the import and link the package in MainApplication.java:+ import com.reactcommunity.rndatetimepicker.RNDateTimePickerPackage; public class MainApplication extends Application implements ReactApplication { @Override protected List<ReactPackage> getPackages() { @SuppressWarnings(“UnnecessaryLocalVariable”) List<ReactPackage> packages = new PackageList(this).getPackages(); // Packages that cannot be autolinked yet can be added manually here, for example: + packages.add(new RNDateTimePickerPackage()); return packages; } }

Windows

Add the DateTimePickerWindows project to your solution
  1. Open the solution in Visual Studio 2019
  2. Right-click solution icon in Solution Explorer > Add > Existing Project Select ‘D:\pathToYourApp\node_modules@react-native-community\datetimepicker\windows\DateTimePickerWindows\DateTimePickerWindows.vcxproj’
windows/myapp.sln

Add a reference to DateTimePickerWindows to your main application project. From Visual Studio 2019:

Right-click main application project > Add > Reference… Check ‘DateTimePickerWindows’ from the ‘Project > Solution’ tab on the left.

pch.h

Add #include "winrt/DateTimePicker.h".

app.cpp

Add PackageProviders().Append(winrt::DateTimePicker::ReactPackageProvider()); before InitializeComponent();.

Running the example app

  1. Install required pods in example/ios by running pods install
  2. Run npm start to start Metro Bundler
  3. Run npm run start:ios or npm run start:android or npm run start:windows (or yarn run start:windows)

Github

react-native-community/datetimepicker

React Native date & time picker component for iOS and Android Xcode >= 11; please open a PR if you need to support building with older Xcode versions – see #133. Please note that we support iOS >= 10 but you need Xcode 11 to build.

krissanawat

React Native developer from beautiful Chiangmai, love Americano and travel so much