We give two equivalent examples on how to use the package on all supported platforms.

Recommended imperative api usage on Android

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 onChange = (event, selectedDate) => {
    const currentDate = selectedDate;
    setDate(currentDate);
  };

  const showMode = (currentMode) => {
    DateTimePickerAndroid.open({
      value: date,
      onChange,
      mode: currentMode,
      is24Hour: true
    })
  };

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

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

  return (
    </details>


## Localization note

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](https://stackoverflow.com/a/2900144/2070942).

On iOS, use XCode, as [documented here](https://developer.apple.com/documentation/xcode/adding-support-for-languages-and-regions) 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`.

&gt; If you use a library like [i18next](https://github.com/i18next/react-i18next) or [react-localize-redux](https://github.com/ryandrewjohnson/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](https://developer.apple.com/documentation/xcode/testing-localizations-when-running-your-app).

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](./docs/images/ios_date_new.png) (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](https://docs.expo.dev/distribution/app-stores/#localizing-your-ios-app).


### Android imperative api

On Android, you have a choice between using the component API (regular React component) or an imperative api (think something like `ReactNative.alert()`).

While the component API has the benefit of writing the same code on all platforms, for start we recommend to use 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.)

```js
import { DateTimePickerAndroid } from '@react-native-community/datetimepicker';

DateTimePickerAndroid.open(params: AndroidNativeProps)
DateTimePickerAndroid.dismiss(mode: AndroidNativeProps['mode'])

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.

Component props / params of the Android imperative api

> Please note that this library currently exposes functionality from UIDatePicker on iOS and DatePickerDialog + TimePickerDialog on Android, and CalendarDatePicker +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.

mode (optional)

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)

display (optional)

Defines the visual display of the picker. The default value is "default".

List of possible values for Android

• "default" - Show a default date picker (spinner/calendar/clock) based on mode and Android version.
• "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 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.

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) => {};

;

value (required)

Defines the date or time value used in the component.

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.

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.

timeZoneOffsetInMinutes (optional, iOS and Android only)

Allows changing of the timeZone of the date picker. By default, it uses the device's time zone. We strongly recommend avoiding this prop on android because of known issues in the implementation (eg. #528).

// GMT+1

timeZoneOffsetInSeconds (optional, Windows only)

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

// UTC+1

dayOfWeekFormat (optional, Windows 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

dateFormat (optional, Windows 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

firstDayOfWeek (optional, Windows only)

Indicates which day is shown as the first day of the week.

// 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 (optional, iOS only)

Allows changing of the textColor of the date picker. Has effect only when display is "spinner".

accentColor (optional, iOS only)

Allows changing the accentColor (tintColor) of the date picker. Has no effect when display is "spinner".

themeVariant (optional, iOS only)

Allows overriding system theme variant (dark or light mode) used by the date picker.

⚠️ 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"

locale (optional, iOS only)

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.

is24Hour (optional, Windows and Android only)

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

neutralButtonLabel (optional, Android only)

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

minuteInterval (optional)

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"

style (optional, iOS only)

Sets style directly on picker component. By default, the picker height is determined based on the display prop.

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.

This means that eg. 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 or opt-out from dark mode (discouraged).

disabled (optional, iOS only)

If true, the user won't be able to interact with the view.

onError (optional, Android only)

Callback that is called when an error occurs inside the date picker native code (such as null activity).

Migration from the older components

Please see migration.md

Contributing to the component

Please see CONTRIBUTING.md

Manual installation

Please see manual-installation.md

Running the example app

1. Run yarn in repo root
2. Run cd example
3. Install required pods by running npx pod-install
4. Run yarn start to start Metro Bundler
5. Run yarn run start:ios or yarn run start:android or yarn run start:windows
6. To do any development on the library, open the example project (in the example 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.