快速入门

安装

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-date-picker` plugin in my project.

如果你更想手动设置，请运行以下命令安装插件，并按照下方各平台的说明操作：

bun add @capgo/capacitor-date-picker
bunx cap sync

导入

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

常见坑点

• 隐藏礼物之间的内容: 调用 hide() 用户是否可以在一个选择器可见时打开另一个选择器。
• ISO 字符串: 通过 date, min，以及 max 按文档中说明的字符串格式填写您的 format 选项。
• 范围校验: presentRange() 也应在服务端强制执行业务规则，因为用户可以在离线时选择边界日期。

选择日期

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

选择时间

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

console.log(result.value);

选择日期和时间

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',
});

选择月份

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

选择范围

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

隐藏选择器

await DatePicker.hide();

平台选项

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

常用选项

选项	描述
mode	date, time, dateAndTime, yearAndMonth, countDownTimer，或 range.
date	初始选中值。
min / max	可选的最小值和最大值。
format	输出格式。支持 ISO、Java/Unicode 以及常见的 Moment 风格格式。
title	对话框标题。
locale	在支持的情况下，原生选择器所使用的语言区域。
timezone	用于解析和格式化的时区。
is24h	优先使用 24 小时制。
minuteStep	时间选择器的分钟间隔。
doneText / cancelText	自定义操作标签。

示例 App

该仓库包含一个 Capacitor 示例应用，用于演示如何调用原生日期选择器、时间选择器、范围选择器， hide()以及插件版本调用。

iOS	Android

API 参考

完整的 API 参考文档维护在 package 的 README 和 TypeScript 定义中：

• README
• 类型定义