Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-date-picker`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/date-picker/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Install

npm install @capgo/capacitor-date-picker
npx cap sync

Import

import { DatePicker } from '@capgo/capacitor-date-picker';

Pick A Date

const result = await DatePicker.present({
  mode: 'date',
  date: '2026-05-27',
  min: '2026-01-01',
  max: '2026-12-31',
  format: 'yyyy-MM-dd',
  title: 'Select date',
});

console.log(result.value);

Pick A Time

const result = await DatePicker.present({
  mode: 'time',
  is24h: true,
  minuteStep: 15,
  format: 'HH:mm',
  title: 'Select time',
});

console.log(result.value);

Pick Date And Time

const result = await DatePicker.present({
  mode: 'dateAndTime',
  date: '2026-05-27T14:30:00',
  format: "yyyy-MM-dd'T'HH:mm:ss",
  title: 'Select date and time',
});

Pick A Month

const result = await DatePicker.present({
  mode: 'yearAndMonth',
  date: '2026-05-01',
  format: 'yyyy-MM',
  title: 'Select month',
});

Pick A Range

const range = await DatePicker.presentRange({
  start: '2026-05-01',
  end: '2026-05-27',
  format: 'yyyy-MM-dd',
  startTitle: 'Start date',
  endTitle: 'End date',
});

console.log(range.start, range.end, range.value);

Hide The Picker

await DatePicker.hide();

Platform Options

await DatePicker.present({
  mode: 'date',
  date: '2026-05-27',
  title: 'Select date',
  ios: {
    style: 'inline',
    theme: 'light',
  },
  android: {
    theme: 'light',
  },
});

Common Options

Option	Description
`mode`	`date`, `time`, `dateAndTime`, `yearAndMonth`, `countDownTimer`, or `range`.
`date`	Initial selected value.
`min` / `max`	Minimum and maximum selectable values.
`format`	Output format. ISO, Java/Unicode, and common Moment-style formats are supported.
`title`	Dialog title.
`locale`	Locale used by native pickers where supported.
`timezone`	Timezone used for parsing and formatting.
`is24h`	Prefer 24-hour time.
`minuteStep`	Time picker minute interval.
`doneText` / `cancelText`	Custom action labels.

Example App

The repository includes a Capacitor example app that opens the native date picker, time picker, range picker, hide(), and plugin version calls.

iOS	Android

API Reference

The complete API reference is maintained in the package README and TypeScript definitions: