npm 包 @beisen/upaas-date-time-search 使用教程

阅读时长 4 分钟读完

前言

@beisen/upaas-date-time-search 是由北森教育科技股份有限公司维护的一个 npm 包,它提供了一种方便的方式来实现时间筛选功能。在本文中,我们将详细地介绍如何使用这个 npm 包,并提供一些实际的示例来帮助大家快速上手。

安装

首先需要确保 Node.js 和 npm 已经正确安装在您的机器上。安装方法请参考官方文档。

在安装完 Node.js 和 npm 后,运行以下命令进行安装:

使用

基础使用

-- -------------------- ---- -------
------ -------------- ---- --------------------------------

-- ----
----- --- - --- ----------------
  ------------- ------------
  ----------- ---------
--

-- ----
----- ----------- -------- - ------------------

---------------------- -- ----------- ---------
-------------------- -- ----------- ---------

高级用法

-- -------------------- ---- -------
------ -------------- ---- --------------------------------

----- --- - --- ----------------
  ------------- ------------
  ----------- ----------
  ----------------- ----------- ----------
  --------------- ----------- ----------
  ------------ ---- - -- - -- - ---
  ------------ ---- - -- - -- - -- - ---
  ---------------- ---- - -- - -- - -- - --
  -------------------- --- -- --- --- ---- -----
  ------------- ----------- -------- -- -
    ----------------------
    --------------------
  -
--

----- ----------- -------- - ------------------

---------------------- -- ----------- ---------
-------------------- -- ----------- ---------

---------------------------- ---------- ----------- ----------

---------------------- -- ----------- ---------
-------------------- -- ----------- ---------

参数

startTimeKey

  • 类型:string
  • 必填:是
  • 默认值:无

指定后端接口中开始时间对应的参数名。

endTimeKey

  • 类型:string
  • 必填:是
  • 默认值:无

指定后端接口中结束时间对应的参数名。

defaultStartTime

  • 类型:string
  • 必填:否
  • 默认值:当天凌晨 0 点

指定时间范围的默认开始时间。

defaultEndTime

  • 类型:string
  • 必填:否
  • 默认值:当天晚上 11 点 59 分 59 秒

指定时间范围的默认结束时间。

minInterval

  • 类型:number
  • 必填:否
  • 默认值:0

指定时间范围的最小间隔时间,单位为毫秒。

maxInterval

  • 类型:number
  • 必填:否
  • 默认值:0

指定时间范围的最大间隔时间,单位为毫秒。

defaultInterval

  • 类型:number
  • 必填:否
  • 默认值:0

指定时间范围的默认间隔时间,单位为毫秒。

showIntervalOptions

  • 类型:array
  • 必填:否
  • 默认值:[1, 7, 30, 90, 180, 365]

指定可供用户选择的时间范围的天数列表。

onTimeChange

  • 类型:function
  • 必填:否
  • 默认值:无

指定时间范围修改时触发的回调函数。

结语

@beisen/upaas-date-time-search 旨在为前端开发人员提供一种更加便捷快速的时间筛选方案,减少重复劳动和出错的风险,提高开发效率。如有问题欢迎提出建议,我们正在不断改进和完善。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600560e781e8991b448df23c

纠错
反馈