@handsontable/pikaday

中文文档
1.0.0发布于 2023/12/11(0BSD OR MIT)TypeScriptESM + CJS零依赖近 30 天下载 71.6万

刷新 JavaScript 日期选择器 — 轻量级, 无依赖性, 模块化 CSS

中文使用文档
文档目录21 节
  1. 一个正在刷新的 JavaScript 日期选择器
  2. 安装
  3. 样式
  4. 使用量
  5. 格式化
  6. 配置
  7. 样式
  8. 查询插件
  9. AMD 支持
  10. 通用JS模块支持
  11. 铁路上的Ruby
  12. 方法
  13. 获取和设定日期
  14. 清除并重设日期
  15. 更改当前视图
  16. 显示并隐藏取日期器
  17. 国际化
  18. 扩展
  19. 计时器
  20. 浏览器兼容性
  21. 作者数

@ handsontable/ pikaday (日语)

NPM version GitHub license NPM downloads

一个正在刷新的 JavaScript 日期选择器

  • 重量(小于5克b的精度和克齐普)
  • 没有依附关系( 但玩得好) 时刻.js(中文(简体) )
  • 模块化 CSS 课程,以方便样式

试试Pikaday Demo

Pikaday Screenshot

生产准备好了吗? 1.0.0版本以来 Pikaday是稳定的,用于生产. 如果您确实找到错误或有特性请求, 请提交至 GitHub 问题跟踪器。 。 。 . 另见 更改日志

安装

您可以安装 Pikaday 作为国家防范机制软件包:

npm install @handsontable/pikaday

或直接链接到CDN:

<script src="https://cdn.jsdelivr.net/npm/@handsontable/pikaday/pikaday.js"></script>

样式

您还需要包含 Pikaday CSS 文件 。 这个步骤取决于Pikaday的安装方式. 国家防范机制的进口:

@import '@handsontable/pikaday/css/pikaday.css';

或链接到CDN:

<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@handsontable/pikaday/css/pikaday.css">

使用量

临终纪念日 可绑定到输入字段:

<input type="text" id="datepicker">

在文档末尾添加 JavaScript :

<script src="pikaday.js"></script>
<script>
    var picker = new Pikaday({ field: document.getElementById('datepicker') });
</script>

如果你在用的话 查询 确保只通过第一个元素:

var picker = new Pikaday({ field: $('#datepicker')[0] });

如果 Pikaday 实例没有绑定到字段, 您可以在任何地方附加元素 :

var field = document.getElementById('datepicker');
var picker = new Pikaday({
    onSelect: function(date) {
        field.value = picker.toString();
    }
});
field.parentNode.insertBefore(picker.el, field.nextSibling);

格式化

默认情况下,日期使用标准JavaScript Date对象格式化并解析. 若为 时刻.js 范围,用于格式化和解析输入值。 你可以通过一个额外的 format 选项 moment 建筑师. 见 moment.j 实例 对于一个完整的版本.

<input type="text" id="datepicker" value="9 Oct 2014">

<script src="moment.js"></script>
<script src="pikaday.js"></script>
<script>
    var picker = new Pikaday({
        field: document.getElementById('datepicker'),
        format: 'D MMM YYYY',
        onSelect: function() {
            console.log(this.getMoment().format('Do MMMM YYYY'));
        }
    });
</script>

对于更先进更灵活的格式,你可以通过自己的 toString 函数到用于格式化日期对象的配置. 此函数的签名如下:

toString(date, format = 'YYYY-MM-DD')

你应该把绳子还回去.

不过小心点 如果您返回的格式字符串无法正确解析 Date.parse 方法(或由 moment 如果有的话,你必须自己提供 parse 函数在配置中。 此函数将传递格式化的字符串和格式 :

parse(dateString, format = 'YYYY-MM-DD')

var picker = new Pikaday({
    field: document.getElementById('datepicker'),
    format: 'D/M/YYYY',
    toString(date, format) {
        // you should do formatting based on the passed format,
        // but we will just return 'D/M/YYYY' for simplicity
        const day = date.getDate();
        const month = date.getMonth() + 1;
        const year = date.getFullYear();
        return `${day}/${month}/${year}`;
    },
    parse(dateString, format) {
        // dateString is the result of `toString` method
        const parts = dateString.split('/');
        const day = parseInt(parts[0], 10);
        const month = parseInt(parts[1], 10) - 1;
        const year = parseInt(parts[2], 10);
        return new Date(year, month, day);
    }
});

配置

如上述例子所示 Pikaday有许多有用的选择:

  • field 将取枣者绑入窗体字段
  • trigger 使用不同的元素来触发取日期器的打开,参见 触发示例 (违约) field(中文(简体) )
  • bound 自动显示/隐藏采集日期 field 焦点( 默认) true 若为 field 设置)
  • ariaLabel 输入字段上的数据属性,带有 aria 帮助文本(仅在 bound 设置)
  • position 相对于窗体字段的选取日期者首选位置,例如: top right, (中文(简体) ), bottom right 说明: 可能发生自动调整,以避免取日期器在取景口外显示,见 职位示例 (默认为"从下而左")
  • reposition 可以设定为虚假, 不将取日期器重新定位于视图端口, 从而迫使它带走配置的 position (默认:真实)
  • container DOM 将日历转换为 容器示例 (默认: 未定义)
  • format 默认输出格式 .toString() 财务报告和审定财务报表 field 值( 要求) 时刻.js 用于自定义格式)
  • formatStrict 刻出严格日期解析的默认旗帜( 需要) 时刻.js 用于自定义格式)
  • toString(date, format) 函数,用于自定义格式。 此函数将优先于 moment。 。 。 .
  • parse(dateString, format) 函数用于解析输入字符串并从中获取日期对象。 此函数将优先于 moment。 。 。 .
  • defaultDate 第一次打开时查看的初始日期
  • setDefaultDate 布尔(真/假). 制作 defaultDate 初始选定值
  • firstDay (0:星期日,1:星期一等)
  • minDate 可选择的最小/最早日期( 此处应为本地日期对象 - 例如 ). new Date() 或者说 moment().toDate()(中文(简体) )
  • maxDate 可选择的最大/ 最新日期( 这应该是本地日期对象 - 例如 。). new Date() 或者说 moment().toDate()(中文(简体) )
  • disableWeekends 不允许选择星期六或星期日
  • disableDayFn 调用函数,在视图中每天通过日期对象。 返回真以禁用当天的选择 .
  • yearRange 双方的年数(例如:. 10)或上下范围的数组(例如. [1900,2015](中文(简体) )
  • showWeekNumber 在行首显示 ISO 周号( 默认) false(中文(简体) )
  • pickWholeWeek 选择整个星期而不是一天( 默认) false(中文(简体) )
  • isRTL 右到左语言的日历倒转
  • i18n 月份和工作日名称的语言默认值(见下文国际化)
  • yearSuffix 标题中该年附加的额外文本
  • showMonthAfterYear 使标题中逐年生效(默认) false(中文(简体) )
  • showDaysInNextAndPreviousMonths 将日历网格中下个月或上个月的天数转换成天数( 默认: 假)
  • enableSelectionDaysInNextAndPreviousMonths 允许用户选择下一个月或前几个月的日期( 默认: 假)
  • numberOfMonths 可见日历数
  • mainCalendar 何时 numberOfMonths ,这将帮助您选择主日历的位置(默认) left,可以设置为 right) (中文(简体) ). 仅用于第一次显示或选定日期未可见时
  • events 您想要从平日中区分的日期( 例如) . ['Sat Jun 28 2017', 'Sun Jun 29 2017', 'Tue Jul 01 2017',](中文(简体) )
  • theme 定义可以用作不同主题样式的钩子的类名,参见 主题示例 (默认) null(中文(简体) )
  • blurFieldOnSelect 定义选定日期时的字段是否模糊(默认) true(中文(简体) )
  • onSelect 选择日期时的调用函数
  • onOpen 当拾取器可见时的调用功能
  • onClose 隐藏拾取器时的回调功能
  • onDraw 当采取者绘制新月时的调用函数
  • keyboardInput 启用键盘输入支持( 默认) true(中文(简体) )

样式

如果 reposition 配置选项启用( 默认) , Pikaday 将根据日期选择方式对日期选择器应用 CSS 类 :

  • top-aligned
  • left-aligned
  • right-aligned
  • bottom-aligned

请注意,DOM元素在任何时候通常会有2个CSS级(如:. top-aligned right-aligned (见e/cn.4/sub.2/2000/l.31).

查询插件

Pikaday 的正常版本不需要 jQuery, 但是如果 jQuery 插件会浮出您的船( 见 plugins/pikaday.jquery.js 页:1 此版本自然需要 jQuery, 并且可以像其它插件一样使用 : 见 j 查询示例 对于一个完整的版本.

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
<script src="pikaday.js"></script>
<script src="plugins/pikaday.jquery.js"></script>
<script>

// activate datepickers for all elements with a class of `datepicker`
$('.datepicker').pikaday({ firstDay: 1 });

// chain a few methods for the first datepicker, jQuery style!
$('.datepicker').eq(0).pikaday('show').pikaday('gotoYear', 2042);

</script>

AMD 支持

如果使用模块化的脚本加载器,Pikaday不会被绑定在全局对象上,并且会很好地适合您的构建过程. 你可以像其他模块一样要求Pikaday. 见 AMD 示例 对于一个完整的版本.

require(['@handsontable/pikaday'], function(Pikaday) {
    var picker = new Pikaday({ field: document.getElementById('datepicker') });
});

上述jQuery插件也是如此. 见 j 查询 AMD 实例 对于一个完整的版本.

require(['jquery', 'pikaday.jquery'], function($) {
    $('#datepicker').pikaday();
});

通用JS模块支持

如果您使用通用JS兼容环境,您可以使用需要的函数来导入 Pikaday .

var pikaday = require('@handsontable/pikaday');

当您将所需的模块捆绑在一起时 浏览器 你不使用 时刻.js 指定忽略选项 :

browserify main.js -o bundle.js -i moment

铁路上的Ruby

如果你在用的话 铁路上的Ruby,确保检查出 皮卡戴宝石。 。 。 .

方法

您可以在创建后控制采集日期 :

var picker = new Pikaday({ field: document.getElementById('datepicker') });

获取和设定日期

picker.toString('YYYY-MM-DD')

以字符串格式返回选定的日期。 若为 时刻.js 存在(建议),然后Pikaday可以返回Moment所理解的任何格式. 您也可自行提供 toString 函数并进行格式化。 更多信息 格式化 节.

如果没有 moment 对象不存在 toString 提供了函数, JavaScript 的默认值 .toDateString() 将使用方法.

picker.getDate()

返回一个基本的 JavaScript Date 选定日对象,或 null 如果没有选择.

picker.setDate('2015-01-01')

设置当前选择 。 这将限制在 minDate 财务报告和审定财务报表 maxDate 如果指定了选项。 您可以选择通过布尔作为第二个参数,以防止触发在Select召回(真),允许默定日期.

picker.getMoment()

回返a 时刻.js 选定日期的对象(必须在Pikaday之前加载).

picker.setMoment(moment('14th February 2014', 'DDo MMMM YYYY'))

将当前选择设置为 a 时刻.js 对象(参见 setDate 详细情况请查阅.

清除并重设日期

picker.clear()

将清除并重置 Picker 绑定的输入 .

更改当前视图

picker.gotoDate(new Date(2014, 1))

更改当前视图以查看特定日期 。 这个例子将跳至2014年2月(月份为零指数) (中文(简体) ).

picker.gotoToday()

快捷键 picker.gotoDate(new Date())

picker.gotoMonth(2)

按月份更改当前视图( 0: 1月 1: 二月等).

picker.nextMonth() picker.prevMonth()

转到下一个月或上一个月(如有必要,这将改变年份).

picker.gotoYear()

更改所查看的年份 .

picker.setMinDate()

更新可选择的最小/最小日期 .

picker.setMaxDate()

更新可以选择的最大/ 最新的日期 .

picker.setStartRange()

更新范围起始日期 。 使用两个 Pikaday 实例选择日期范围 .

picker.setEndRange()

更新范围结束日期 。 使用两个 Pikaday 实例选择日期范围 .

显示并隐藏取日期器

picker.isVisible()

回返 true 或者说 false。 。 。 .

picker.show()

使取取者显相.

picker.adjustPosition()

重新计算并更改取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取.

picker.hide()

藏取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取.

picker.destroy()

隐藏拾取器并删除所有事件听众——不再返回!

国际化

默认 i18n 配置格式是这样的 :

i18n: {
    previousMonth : 'Previous Month',
    nextMonth     : 'Next Month',
    months        : ['January','February','March','April','May','June','July','August','September','October','November','December'],
    weekdays      : ['Sunday','Monday','Tuesday','Wednesday','Thursday','Friday','Saturday'],
    weekdaysShort : ['Sun','Mon','Tue','Wed','Thu','Fri','Sat']
}

您必须提供12个月零7个工作日(带有缩写)。 总是按周日顺序指定工作日 。 你可以改变 firstDay 选项,必要时重新排序(0:星期日,1:星期一等)。 您也可以设置 isRTL 改为 true 用于读取从右到左的语言.

扩展

计时器

皮克戴是个纯正的摘枣人. 它不支持选择一天的时间。 然而,已经作出努力,为Pikaday增加时间支持. 见 1号 财务报告和审定财务报表 18号他们住在自己的叉子里.

你可以用这部作品 @owenmead (英语) 最近那个 欧文米德/皮卡日 更简单的时间选择方法 @xeeali (英语) 时间 xeeali/皮卡日 基于1.2.0版本. 还有 @stas (韩语) 有个叉子 锡斯/皮卡日但是现在已经很老了

浏览器兼容性

  • Chrome(最新主要版本)
  • Firefox(最新主要版本)
  • Safari(最新主要版本)

作者数

感谢 @ shoogledes 设计 为名.

版权所有:2014 David Bushell 校对:Soup

版本与发布记录

@handsontable/pikaday 共发布 2 个版本,首次发布于 2023/12/11;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.0latest2023/12/112 年前
1.0.0-beta.1beta2023/12/112 年前

关于 @handsontable/pikaday 的常见问题

@handsontable/pikaday 是什么?

刷新 JavaScript 日期选择器 — 轻量级, 无依赖性, 模块化 CSS

如何安装 @handsontable/pikaday?

在项目目录运行 npm install @handsontable/pikaday,或使用 pnpm add / yarn add / bun add。

@handsontable/pikaday 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@handsontable/pikaday 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@handsontable/pikaday 可以商用吗?

@handsontable/pikaday 使用 (0BSD OR MIT) 许可。可在 0BSD、MIT 中任选其一遵守。选择 0BSD 时,几乎没有限制:可自由使用、修改和分发,连保留版权声明也不要求。以上为概括,不构成法律意见,请以许可原文为准。

@handsontable/pikaday 的下载量有多少?

根据 npm 官方下载统计,@handsontable/pikaday 在 2026/10/17 – 2026/11/15 这 30 天内被下载 715,533 次,日均约 23,851 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@handsontable/pikaday 还在维护吗?

最新版本 1.0.0 发布于 2023/12/11(2 年前);至今共发布 2 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/12/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。