Package Exports
- rc-calendar
- rc-calendar/assets/index.css
- rc-calendar/lib/MonthCalendar
- rc-calendar/lib/Picker
- rc-calendar/lib/RangeCalendar
- rc-calendar/lib/locale/en_US
- rc-calendar/lib/locale/zh_CN
- rc-calendar/lib/locale/zh_CN.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rc-calendar) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
rc-calendar
React Calendar
Screenshots




Feature
- support ie8,ie8+,chrome,firefox,safari
- support date, month, year, decade select panel
- support week number
- support en_US and zh_CN locale (ui and timeOffset)
- support aria and keyboard accessibility
Keyboard
- Previous month (PageUp)
- Next month (PageDown)
- tab into hour input: Last hour(Up), Next hour(Down)
- tab into hour input: Last minute(Up), Next minute(Down)
- tab into hour input: Last second(Up), Next second(Down)
- Last year (Control + left)
- Next year (Control + right)
install
Usage
import Calendar from 'rc-calendar';
import React from 'react';
import ReactDOM from 'react-dom';
ReactDOM.render(<Calendar />, container);
Development
npm install
npm start
Example
http://localhost:8001/examples/
online example:
http://react-component.github.io/calendar/examples/index.html
API
Calendar props
name | type | default | description |
---|---|---|---|
prefixCls | String | prefixCls of this component | |
className | String | additional css class of root dom node | |
style | Object | additional style of root dom node | |
value | GregorianCalendar | current value like input's value | |
defaultValue | GregorianCalendar | defaultValue like input's defaultValue | |
locale | Object | import from 'rc-calendar/lib/locale/en_US' | calendar locale |
formatter | GregorianCalendarFormatter | use to format/parse value to/from input | |
disabledDate | Function(current:GregorianCalendar):Boolean | null | whether to disable select of current date |
showWeekNumber | Boolean | false | whether to show week number of year |
showToday | Boolean | true | whether to show today button |
showTime | Boolean | true | whether to support time select |
onSelect | Function(date: GregorianCalendar) | function(){} | called when a date is selected from calendar |
onChange | Function(date: GregorianCalendar) | function(){} | called when a date is changed inside calendar (next year/next month/keyboard) |
dateInputPlaceholder | String | '' | date input's placeholder |
rc-calendar/lib/RangeCalendar props
name | type | default | description |
---|---|---|---|
prefixCls | String | prefixCls of this component | |
className | String | additional css class of root dom node | |
style | Object | additional style of root dom node | |
selectedValue | GregorianCalendar[] | current selected value range. with two elements. | |
defaultSelectedValue | GregorianCalendar[] | default selected value range | |
locale | Object | import from 'rc-calendar/lib/locale/en_US' | calendar locale |
formatter | String|GregorianCalendarFormatter. see GregorianCalendarFormatter spec | yyyy-MM-dd or yyyy-MM-dd HH:mm:ss | use to format/parse value to/from input |
disabledDate | Function(current:GregorianCalendar):Boolean | null | whether to disable select of current date |
showWeekNumber | Boolean | false | whether to show week number of year |
showTime | Boolean | true | whether to support time select |
onSelect | Function(date: GregorianCalendar[]) | function(){} | called when a date range is selected from calendar |
onChange | Function(date: GregorianCalendar[]) | function(){} | called when a date range is changed inside calendar (next year/next month/keyboard) |
rc-calendar/lib/MonthCalendar props
name | type | default | description |
---|---|---|---|
prefixCls | String | prefixCls of this component | |
className | String | additional css class of root dom node | |
style | Object | additional style of root dom node | |
value | GregorianCalendar | current value like input's value | |
defaultValue | GregorianCalendar | defaultValue like input's defaultValue | |
locale | Object | import from 'rc-calendar/lib/locale/en_US' | calendar locale |
disabledDate | Function(current:GregorianCalendar):Boolean | null | whether to disable select of current month |
getCalendarContainer | Function():Element | function(){return document.body;} | dom node where calendar to be rendered into |
onSelect | Function(date: GregorianCalendar) | function(){} | called when a date is selected from calendar |
onChange | Function(date: GregorianCalendar) | function(){} | called when a date is changed inside calendar (next year/next month/keyboard) |
rc-calendar/lib/Picker props
name | type | default | description |
---|---|---|---|
prefixCls | String | prefixCls of this component | |
calendar | Calendar React Element | ||
disabled | Boolean | whether picker is disabled | |
placement | String|Object | one of ['left','right','top','bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'] | |
align | Object: alignConfig of [dom-align](https://github.com/yiminghe/dom-align) | value will be merged into placement's align config. | |
animation | String | index.css support 'slide-up' | |
transitionName | String | css class for animation | |
value | GregorianCalendar|GregorianCalendar[] | current value like input's value | |
defaultValue | GregorianCalendar|GregorianCalendar[] | defaultValue like input's defaultValue | |
onChange | Function | called when select a different value | |
onOpen | Function | called when open picker | |
onClose | Function | called when close picker | |
open | Boolean | current open state of picker. controlled prop |
Test Case
http://localhost:8001/tests/runner.html?coverage
Coverage
License
rc-calendar is released under the MIT license.