Giter Club home page Giter Club logo

calendar's Introduction

rc-calendar


React Calendar

NPM version build status Test coverage gemnasium deps node version npm download

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

rc-calendar

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
focused Boolean false whether to focus on render
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/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'] or alignConfig of [dom-align](https://github.com/yiminghe/dom-align)
align Object: alignConfig of [dom-align](https://github.com/yiminghe/dom-align) only valid when placement's type is String. value will be merged into placement's align config. note: can only accept offset and targetOffset
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

http://localhost:8001/node_modules/rc-server/node_modules/node-jscover/lib/front-end/jscoverage.html?w=http://localhost:8001/tests/runner.html?coverage

License

rc-calendar is released under the MIT license.

calendar's People

Contributors

azu avatar benjycui avatar hui avatar popomore avatar xeodou avatar yiminghe avatar zhujun24 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.