Reference version

This is documentation for the next SDK version. For up-to-date documentation, see the latest version (SDK 55).

DateTimePicker

A Jetpack Compose DateTimePicker component for selecting dates and times.

Android

Expo UI DateTimePicker matches the official Jetpack Compose Date Picker and Time Picker APIs and supports date, time, and combined selection.

Installation

Terminal
npx expo install @expo/ui

If you are installing this in an existing React Native app, make sure to install expo in your project.

Usage

Date picker

DatePickerExample.tsx
import { useState } from 'react'; import { Host, DateTimePicker } from '@expo/ui/jetpack-compose'; export default function DatePickerExample() { const [selectedDate, setSelectedDate] = useState(new Date()); return ( <Host matchContents> <DateTimePicker onDateSelected={date => { setSelectedDate(date); }} displayedComponents="date" initialDate={selectedDate.toISOString()} variant="picker" /> </Host> ); }

Time picker

TimePickerExample.tsx
import { useState } from 'react'; import { Host, DateTimePicker } from '@expo/ui/jetpack-compose'; export default function TimePickerExample() { const [selectedDate, setSelectedDate] = useState(new Date()); return ( <Host matchContents> <DateTimePicker onDateSelected={date => { setSelectedDate(date); }} displayedComponents="hourAndMinute" initialDate={selectedDate.toISOString()} variant="picker" /> </Host> ); }

Input variant

Use variant="input" to display the picker as a text input field instead of the default picker UI.

InputVariantExample.tsx
import { useState } from 'react'; import { Host, DateTimePicker } from '@expo/ui/jetpack-compose'; export default function InputVariantExample() { const [selectedDate, setSelectedDate] = useState(new Date()); return ( <Host matchContents> <DateTimePicker onDateSelected={date => { setSelectedDate(date); }} displayedComponents="date" initialDate={selectedDate.toISOString()} variant="input" /> </Host> ); }

API

import { DateTimePicker } from '@expo/ui/jetpack-compose';

Components

DatePickerDialog

Android

Type: React.Element<DatePickerDialogProps>

DatePickerDialogProps

color

Android
Optional • Type: ColorValue

confirmButtonLabel

Android
Optional • Type: string

dismissButtonLabel

Android
Optional • Type: string

elementColors

Android

initialDate

Android
Optional • Literal type: union

Acceptable values are: string | null

onDateSelected

Android
Optional • Type: (date: Date) => void

onDismissRequest

Android
Type: () => void

selectableDates

Android
Optional • Type: { end: Date, start: Date }

showVariantToggle

Android
Optional • Type: boolean

variant

Android
Optional • Type: AndroidVariant

DateTimePicker

Android

Type: React.Element<DateTimePickerProps>

Renders an inline DateTimePicker component.

DateTimePickerProps

color

Android
Optional • Type: ColorValue

The tint color to use on the picker elements. When elementColors is not provided, this color is applied to a subset of picker elements (selected day, title, headline, today border for date picker; selector, selected time segment, clock dial for time picker).

displayedComponents

Android
Optional • Type: DisplayedComponents • Default: 'date'

The components that the picker should display. On Android, you can have a picker that selects just the date or just the time. dateAndTime is only available on iOS and will result in a date picker on Android. On iOS, you can have a picker that selects both date and time.

elementColors

Android

Fine-grained color overrides for individual picker elements. When provided, these take precedence over the color prop. Date picker color keys are used when displayedComponents is 'date' or 'dateAndTime'. Time picker color keys are used when displayedComponents is 'hourAndMinute'. Unset values fall back to Material 3 theme defaults.

initialDate

Android
Optional • Literal type: union

The initial date to display on the picker.

Acceptable values are: string | null

is24Hour

Android
Optional • Type: boolean • Default: true

Determines what format the clock should be displayed in on Android.

modifiers

Android
Optional • Type: ModifierConfig[]

Modifiers for the component.

onDateSelected

Android
Optional • Type: (date: Date) => void

Callback function that is called when a date is selected.

selectableDates

Android
Optional • Type: { end: Date, start: Date }

Constrains which dates can be selected. Mirrors the native Compose selectableDates parameter. start is the earliest selectable date, end is the latest.

showVariantToggle

Android
Optional • Type: boolean • Default: true

Show to button to toggle between variants on Android.

variant

Android
Optional • Type: AndroidVariant • Default: 'picker'

The variant of the picker, which determines its appearance and behavior.

TimePickerDialog

Android

Type: React.Element<TimePickerDialogProps>

TimePickerDialogProps

color

Android
Optional • Type: ColorValue

confirmButtonLabel

Android
Optional • Type: string

dismissButtonLabel

Android
Optional • Type: string

elementColors

Android

initialDate

Android
Optional • Literal type: union

Acceptable values are: string | null

is24Hour

Android
Optional • Type: boolean

onDateSelected

Android
Optional • Type: (date: Date) => void

onDismissRequest

Android
Type: () => void

Types

AndroidVariant

Android

Literal Type: string

Acceptable values are: 'picker' | 'input'

DatePickerElementColors

Android

Color overrides for the Material 3 DatePicker component. All properties are optional — unset values use Material 3 theme defaults.

PropertyTypeDescription
containerColor(optional)ColorValue

The background color of the date picker.

currentYearContentColor(optional)ColorValue

The color used for the current year content.

dayContentColor(optional)ColorValue

The color used for day content (number text).

dayInSelectionRangeContainerColor(optional)ColorValue

The container color for days within a date range selection.

dayInSelectionRangeContentColor(optional)ColorValue

The content color for days within a date range selection.

disabledDayContentColor(optional)ColorValue

The color used for disabled day content.

disabledSelectedDayContainerColor(optional)ColorValue

The color used for a disabled selected day container.

disabledSelectedDayContentColor(optional)ColorValue

The color used for a disabled selected day content.

disabledSelectedYearContainerColor(optional)ColorValue

The color used for a disabled selected year container.

disabledSelectedYearContentColor(optional)ColorValue

The color used for a disabled selected year content.

disabledYearContentColor(optional)ColorValue

The color used for disabled year item content.

dividerColor(optional)ColorValue

The color used for divider lines.

headlineContentColor(optional)ColorValue

The color used for the date picker's headline.

navigationContentColor(optional)ColorValue

The color used for navigation arrows and year selection menu button.

selectedDayContainerColor(optional)ColorValue

The color used for the selected day container/background circle.

selectedDayContentColor(optional)ColorValue

The color used for selected day content.

selectedYearContainerColor(optional)ColorValue

The color used for the selected year container/background.

selectedYearContentColor(optional)ColorValue

The color used for the selected year content.

subheadContentColor(optional)ColorValue

The color used for the month and year subhead labels.

titleContentColor(optional)ColorValue

The color used for the date picker's title.

todayContentColor(optional)ColorValue

The color used for today's date text.

todayDateBorderColor(optional)ColorValue

The color used for today's date border.

weekdayContentColor(optional)ColorValue

The color used for the weekday letters (Mon, Tue, etc.).

yearContentColor(optional)ColorValue

The color used for year item content.

DisplayedComponents

Android

Literal Type: string

Acceptable values are: 'date' | 'hourAndMinute' | 'dateAndTime'

TimePickerElementColors

Android

Color overrides for the Material 3 TimePicker component. All properties are optional — unset values use Material 3 theme defaults.

PropertyTypeDescription
clockDialColor(optional)ColorValue

The background color of the clock dial.

clockDialSelectedContentColor(optional)ColorValue

The color of clock dial numbers when selected or overlapping the selector.

clockDialUnselectedContentColor(optional)ColorValue

The color of clock dial numbers when unselected.

containerColor(optional)ColorValue

The container/background color of the time picker.

periodSelectorBorderColor(optional)ColorValue

The border color of the AM/PM period selector.

periodSelectorSelectedContainerColor(optional)ColorValue

The background color of the selected AM/PM period.

periodSelectorSelectedContentColor(optional)ColorValue

The text color of the selected AM/PM period.

periodSelectorUnselectedContainerColor(optional)ColorValue

The background color of the unselected AM/PM period.

periodSelectorUnselectedContentColor(optional)ColorValue

The text color of the unselected AM/PM period.

selectorColor(optional)ColorValue

The color of the clock dial selector (hand).

timeSelectorSelectedContainerColor(optional)ColorValue

The background color of the selected hour/minute segment.

timeSelectorSelectedContentColor(optional)ColorValue

The text color of the selected hour/minute segment.

timeSelectorUnselectedContainerColor(optional)ColorValue

The background color of the unselected hour/minute segment.

timeSelectorUnselectedContentColor(optional)ColorValue

The text color of the unselected hour/minute segment.