DatePicker日期选择框
输入或选择日期的控件。
何时使用#
当用户需要输入一个日期,可以点击标准输入框,弹出日期面板进行选择。
代码演示
~
import { DatePicker } from 'antd';
const { MonthPicker, RangePicker } = DatePicker;
function onChange(date, dateString) {
console.log(date, dateString);
}
ReactDOM.render(
<div>
<DatePicker onChange={onChange} />
<br />
<MonthPicker onChange={onChange} placeholder="Select month" />
<br />
<RangePicker onChange={onChange} />
</div>
, mountNode);
~
import { DatePicker, Radio } from 'antd';
const { MonthPicker, RangePicker } = DatePicker;
class PickerSizesDemo extends React.Component {
state = {
size: 'default',
};
handleSizeChange = (e) => {
this.setState({ size: e.target.value });
}
render() {
const { size } = this.state;
return (
<div>
<Radio.Group value={size} onChange={this.handleSizeChange}>
<Radio.Button value="large">Large</Radio.Button>
<Radio.Button value="default">Default</Radio.Button>
<Radio.Button value="small">Small</Radio.Button>
</Radio.Group>
<br /><br />
<DatePicker size={size} />
<br />
<MonthPicker size={size} />
<br />
<RangePicker size={size} />
</div>
);
}
}
ReactDOM.render(<PickerSizesDemo />, mountNode);
~
import { DatePicker } from 'antd';
import moment from 'moment';
const { MonthPicker, RangePicker } = DatePicker;
const dateFormat = 'YYYY-MM-DD';
ReactDOM.render(
<div>
<DatePicker defaultValue={moment('2015-06-06', dateFormat)} disabled />
<br />
<MonthPicker defaultValue={moment('2015-06', 'YYYY-MM')} disabled />
<br />
<RangePicker
defaultValue={[moment('2015-06-06', dateFormat), moment('2015-06-06', dateFormat)]}
disabled
/>
</div>
, mountNode);
import { DatePicker } from 'antd';
class DateRange extends React.Component {
state = {
startValue: null,
endValue: null,
endOpen: false,
};
disabledStartDate = (startValue) => {
const endValue = this.state.endValue;
if (!startValue || !endValue) {
return false;
}
return startValue.valueOf() > endValue.valueOf();
}
disabledEndDate = (endValue) => {
const startValue = this.state.startValue;
if (!endValue || !startValue) {
return false;
}
return endValue.valueOf() <= startValue.valueOf();
}
onChange = (field, value) => {
this.setState({
[field]: value,
});
}
onStartChange = (value) => {
this.onChange('startValue', value);
}
onEndChange = (value) => {
this.onChange('endValue', value);
}
handleStartOpenChange = (open) => {
if (!open) {
this.setState({ endOpen: true });
}
}
handleEndOpenChange = (open) => {
this.setState({ endOpen: open });
}
render() {
const { startValue, endValue, endOpen } = this.state;
return (
<div>
<DatePicker
disabledDate={this.disabledStartDate}
showTime
format="YYYY-MM-DD HH:mm:ss"
value={startValue}
placeholder="Start"
onChange={this.onStartChange}
onOpenChange={this.handleStartOpenChange}
/>
<DatePicker
disabledDate={this.disabledEndDate}
showTime
format="YYYY-MM-DD HH:mm:ss"
value={endValue}
placeholder="End"
onChange={this.onEndChange}
open={endOpen}
onOpenChange={this.handleEndOpenChange}
/>
</div>
);
}
}
ReactDOM.render(<DateRange />, mountNode);
~
import { DatePicker } from 'antd';
import moment from 'moment';
const { MonthPicker, RangePicker } = DatePicker;
const dateFormat = 'YYYY/MM/DD';
const monthFormat = 'YYYY/MM';
ReactDOM.render(
<div>
<DatePicker defaultValue={moment('2015/01/01', dateFormat)} format={dateFormat} />
<br />
<MonthPicker defaultValue={moment('2015/01', monthFormat)} format={monthFormat} />
<br />
<RangePicker
defaultValue={[moment('2015/01/01', dateFormat), moment('2015/01/01', dateFormat)]}
format={dateFormat}
/>
</div>
, mountNode);
~
import { DatePicker } from 'antd';
const { RangePicker } = DatePicker;
function onChange(value, dateString) {
console.log('Selected Time: ', value);
console.log('Formatted Selected Time: ', dateString);
}
function onOk(value) {
console.log('onOk: ', value);
}
ReactDOM.render(
<div>
<DatePicker
showTime
format="YYYY-MM-DD HH:mm:ss"
placeholder="Select Time"
onChange={onChange}
onOk={onOk}
/>
<br />
<RangePicker
showTime={{ format: 'HH:mm' }}
format="YYYY-MM-DD HH:mm"
placeholder={['Start Time', 'End Time']}
onChange={onChange}
onOk={onOk}
/>
</div>
, mountNode);
~
import moment from 'moment';
import { DatePicker } from 'antd';
const { MonthPicker, RangePicker } = DatePicker;
function range(start, end) {
const result = [];
for (let i = start; i < end; i++) {
result.push(i);
}
return result;
}
function disabledDate(current) {
// Can not select days before today and today
return current && current.valueOf() < Date.now();
}
function disabledDateTime() {
return {
disabledHours: () => range(0, 24).splice(4, 20),
disabledMinutes: () => range(30, 60),
disabledSeconds: () => [55, 56],
};
}
function disabledRangeTime(_, type) {
if (type === 'start') {
return {
disabledHours: () => range(0, 60).splice(4, 20),
disabledMinutes: () => range(30, 60),
disabledSeconds: () => [55, 56],
};
}
return {
disabledHours: () => range(0, 60).splice(20, 4),
disabledMinutes: () => range(0, 31),
disabledSeconds: () => [55, 56],
};
}
ReactDOM.render(
<div>
<DatePicker
format="YYYY-MM-DD HH:mm:ss"
disabledDate={disabledDate}
disabledTime={disabledDateTime}
showTime={{ defaultValue: moment('00:00:00', 'HH:mm:ss') }}
/>
<br />
<MonthPicker disabledDate={disabledDate} placeholder="Select month" />
<br />
<RangePicker
disabledDate={disabledDate}
disabledTime={disabledRangeTime}
showTime={{
hideDisabledOptions: true,
defaultValue: [moment('00:00:00', 'HH:mm:ss'), moment('11:59:59', 'HH:mm:ss')],
}}
format="YYYY-MM-DD HH:mm:ss"
/>
</div>,
mountNode
);
~
~
~
import { DatePicker } from 'antd';
import moment from 'moment';
const RangePicker = DatePicker.RangePicker;
function onChange(dates, dateStrings) {
console.log('From: ', dates[0], ', to: ', dates[1]);
console.log('From: ', dateStrings[0], ', to: ', dateStrings[1]);
}
ReactDOM.render(
<div>
<RangePicker
ranges={{ Today: [moment(), moment()], 'This Month': [moment(), moment().endOf('month')] }}
onChange={onChange}
/>
<br />
<RangePicker
ranges={{ Today: [moment(), moment()], 'This Month': [moment(), moment().endOf('month')] }}
showTime
format="YYYY/MM/DD HH:mm:ss"
onChange={onChange}
/>
</div>,
mountNode
);
API#
日期类组件包括以下三种形式。
DatePicker
MonthPicker
RangePicker
注意:DatePicker、MonthPicker、RangePicker 部分 locale 是从 value 中读取,所以请先正确设置 moment 的 locale。
import moment from 'moment';
// 推荐在入口文件全局设置 locale
import 'moment/locale/zh-cn';
moment.locale('zh-cn');
<DatePicker defaultValue={moment('2015-01-01', 'YYYY-MM-DD')} />
共同的 API#
以下 API 为 DatePicker、MonthPicker、RangePicker 共享的 API。
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
allowClear | 是否显示清除按钮 | boolean | true |
className | 选择器 className | string | '' |
disabled | 禁用 | boolean | false |
disabledDate | 不可选择的日期 | (currentDate: moment) => boolean | 无 |
getCalendarContainer | 定义浮层的容器,默认为 body 上新建 div | function(trigger) | 无 |
locale | 国际化配置 | object | 默认配置 |
open | 控制弹层是否展开 | boolean | - |
placeholder | 输入框提示文字 | string|RangePicker[] | - |
popupStyle | 格外的弹出日历样式 | object | {} |
size | 输入框大小,large 高度为 32px,small 为 22px,默认是 28px | string | 无 |
style | 自定义输入框样式 | object | {} |
onOpenChange | 弹出日历和关闭日历的回调 | function(status) | 无 |
DatePicker#
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
defaultValue | 默认日期 | moment | 无 |
disabledTime | 不可选择的时间 | function(date) | 无 |
format | 展示的日期格式,配置参考 moment.js | string | "YYYY-MM-DD" |
renderExtraFooter | 在面板中添加额外的页脚 | () => React.ReactNode | - |
showTime | 增加时间选择功能 | Object|boolean | TimePicker Options |
showTime.defaultValue | 设置用户选择日期时默认的时分秒,例子 | moment | moment() |
showToday | 是否展示“今天”按钮 | boolean | true |
value | 日期 | moment | 无 |
onChange | 时间发生变化的回调 | function(date: moment, dateString: string) | 无 |
onOk | 点击确定按钮的回调 | function() | - |
MonthPicker#
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
defaultValue | 默认日期 | moment | 无 |
format | 展示的日期格式,配置参考 moment.js | string | "YYYY-MM" |
monthCellContentRender | 自定义的月份内容渲染方法 | function(date, locale): ReactNode | - |
value | 日期 | moment | 无 |
onChange | 时间发生变化的回调,发生在用户选择时间时 | function(date: moment, dateString: string) | - |
RangePicker#
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
defaultValue | 默认日期 | moment[] | 无 |
disabledTime | 不可选择的时间 | function(dates: moment, moment, partial: 'start'|'end' ) | 无 |
format | 展示的日期格式 | string | "YYYY-MM-DD HH:mm:ss" |
ranges | 预设时间范围快捷选择 | { range: string: moment[] } | 无 |
renderExtraFooter | 在面板中添加额外的页脚 | () => React.ReactNode | - |
showTime | 增加时间选择功能 | Object|boolean | TimePicker Options |
showTime.defaultValue | 设置用户选择日期时默认的时分秒,例子 | moment[] | moment(), moment() |
value | 日期 | moment[] | 无 |
onChange | 时间发生变化的回调,发生在用户选择时间时 | function(dates: moment, moment, dateStrings: string, string) | 无 |
onOk | 点击确定按钮的回调 | function() | - |