Skip to content

liuyuqin1991/react-datepicker

Repository files navigation

name route hidden
readme
/readme
true

react-datepicker

Datepicker 基础组件库,react hook + typescript 代码风格,包含 DatePicker,TimePicker,DateRangePicker 三个子组件:

  • DatePicker,标准单日期选择组件,支持日,周,月,季,年,日期时间共 6 种日期类型选择;
  • TimePicker,标准时间选择组件,全新设计,避免滚动选择,特定时间点直观显示
  • DateRangePicker,范围双日期选择组件,支持日,周,月,季,年 5 种日期维度选择;

组件使用的第三方库:lodash,dayjs,classnames,react-popper,rc-slider

试用

Demo 地址

安装

npm i react-datepicker-ts

使用

import { DatePicker } from 'react-datepicker-ts';

<DatePicker />

// or
import { TimePicker } from 'react-datepicker-ts';

<TimePicker />

// or

import { DateRangePicker } from 'react-datepicker-ts';

<DateRangePicker />

主题色变更

组件默认采用的是绿色主题色系,如需变更,只需要在项目 css 中重写两个主题色相关变量即可,如下图改为 antd 主题色

// index.css
:root {
  --c-datepicker-primary: #1890FF;
  --c-datepicker-primary-light: #bae7ff;
}

API

查看 API 参数详细介绍

DatePicker 参数

参数 说明 类型 默认值
selectionMode 日期类型<可选> string day
defaultDate 默认日期<可选> Date
className 类选择器<可选> string
onPick 选择日期回调函数<必选> (d: Date[]) => void
format 显示在输入框符合 dayjs 规范的格式<可选> string 'YYYY-MM-DD'
placeholder 未选日期时的占位符<可选> string '请选择日期'
disabledDateFunc 禁用日期回调函数<可选> (d: Date) => boolean
enableClear 允许日期清除<可选> boolean true
enableShowWeekNum 允许周数显示,仅周选择模式下生效<可选> boolean true

TimePicker 参数

参数 说明 类型 默认值
defaultTime 默认时间<可选> Date
className 类选择器<可选> string
onPick 选择日期回调函数<必选> (d: Date[]) => void
format 显示在输入框符合 dayjs 规范的格式<可选> string 'HH:mm:ss'
placeholder 未选日期时的占位符<可选> string '请选择时间'
enableSecond 允许秒选择<可选> boolean true
enableClear 允许时间清除<可选> boolean true

DateRangePicker 参数

参数 说明 类型 默认值
selectionMode 日期类型<可选> string day
defaultDate 默认日期<可选> Date[]
className 类选择器<可选> string
onPick 选择日期回调函数<必选> (d: Date[]) => void
format 显示在输入框符合 dayjs 规范的格式<可选> string 'YYYY-MM-DD'
placeholder 未选日期时的占位符<可选> string '请选择日期范围'
disabledDateFunc 禁用日期回调函数<可选> (d: Date) => boolean
enableClear 允许日期清除<可选> boolean true
enableShowWeekNum 允许周数显示<可选> boolean true
titleLabel 标题文字<可选> string '请选择日期范围'
contentLabel 内容文字<可选> string[] ['起始日期:', '结束日期:']

About

DatePicker基础组件,react hook + typescript 代码风格,支持日、周、月、季、年、时间、日+时间以及范围日期选择

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published