Home

Awesome

<div align="center"> <img src="https://raw.githubusercontent.com/clauderic/react-infinite-calendar/master/.github/logo.png" width="180"/> </div>

React Infinite Calendar

Currently looking for maintainers to help maintain this project, please reach out if you would be interested

npm version downloads license Gitter

Examples available here: <a href="#">http://clauderic.github.io/react-infinite-calendar/</a>

Features

<div style="padding:30px"> <img src="https://raw.githubusercontent.com/clauderic/react-infinite-calendar/master/.github/preview.gif" width="300" /> </div>

Getting Started

Using npm:

npm install react-infinite-calendar --save

ES6, CommonJS, and UMD builds are available with each distribution. For example:

import InfiniteCalendar from 'react-infinite-calendar';
import 'react-infinite-calendar/styles.css'; // Make sure to import the default stylesheet

You can also use a global-friendly UMD build:

<link rel="stylesheet" href="react-infinite-calendar/styles.css">
<script src="react-infinite-calendar/umd/react-infinite-calendar.js"></script>
<script>
var InfiniteCalendar = window.InfiniteCalendar.default;
...
</script>

Usage

Basic Example

import React from 'react';
import { render } from 'react-dom';
import InfiniteCalendar from 'react-infinite-calendar';
import 'react-infinite-calendar/styles.css'; // only needs to be imported once

// Render the Calendar
var today = new Date();
var lastWeek = new Date(today.getFullYear(), today.getMonth(), today.getDate() - 7);

render(
  <InfiniteCalendar
    width={400}
    height={600}
    selected={today}
    disabledDays={[0,6]}
    minDate={lastWeek}
  />,
  document.getElementById('root')
);

For more usage examples, see http://clauderic.github.io/react-infinite-calendar/ or check out some code examples.

Prop Types

PropertyTypeDefaultDescription
selectedDate or Booleannew Date()Value of the date that appears to be selected. Set to false if you don't wish to have a date initially selected.
widthNumber400Width of the calendar, in pixels
heightNumber600Height of the calendar, in pixels
minDatenew Date(1980, 0, 1)The minimum month that can be scrolled to.
maxDatenew Date(2050, 11, 31)The maximum month that can be scrolled to.
minDateDatenew Date(1980, 0, 1)The minimum date that is selectable.
maxDateDatenew Date(2050, 11, 31)The maximum date that is selectable.
disabledDaysArray<Number>Array of days of the week that should be disabled. For example, to disable Monday and Sunday: [0, 6]
disabledDatesArray<Date>Array of dates that should be disabled. For example: [new Date(2017, 1, 8), new Date(), new Date(2017, 5, 17)]
displayString'days'Whether to display the years or days view.
displayOptionsObjectSee default displayOptionsSee display options section for more details.
localeObjectSee default localeBy default, React Infinite Calendar comes with the English locale. You can use this to change the language, or change the first day of the week. See date-fns documentation for more details
themeObjectSee default themeBasic customization of the colors
classNameStringOptional CSS class name to append to the root InfiniteCalendar element.
onSelectFunctionCallback invoked after beforeSelect() returns true, but before the state of the calendar updates
onScrollFunctionCallback invoked when the scroll offset changes. function (scrollTop: number) {}
onScrollEndFunctionCallback invoked 150ms after the last onScroll event is triggered. function (scrollTop: number) {}
rowHeightNumber56Height of each row in the calendar (each week is considered a row)
autoFocusBooleantrueWhether the Calendar root should be auto-focused when it mounts. This is useful when keyboardSupport is enabled (the calendar must be focused to listen for keyboard events)
tabIndexNumber1Tab-index of the calendar

Display Options

PropertyTypeDefaultDescription
layoutString'portrait'Layout of the calendar. Should be one of 'portrait' or 'landscape'
showHeaderBooleantrueShow/hide the header
shouldHeaderAnimateBooleantrueEnable/Disable the header animation
showOverlayBooleantrueShow/hide the month overlay when scrolling
showTodayHelperBooleantrueShow/hide the floating back to Today helper
showWeekdaysBooleantrueShow/hide the weekdays in the header
hideYearsOnSelectBooleantrueWhether to automatically hide the years view on select.
overscanMonthCountNumber4Number of months to render above/below the visible months. Tweaking this can help reduce flickering during scrolling on certain browers/devices.
todayHelperRowOffsetNumber4This controls the number of rows to scroll past before the Today helper appears

Example usage of display options:

<InfiniteCalendar
  displayOptions={{
    layout: 'landscape',
    showOverlay: false,
    shouldHeaderAnimate: false
  }}
/>

Dependencies

React Infinite Calendar has very few dependencies. It relies on react-tiny-virtual-list for virtualization and date-fns for handling date manipulation. It also uses recompose for extending the default functionality. It also has the following peerDependencies: react, and react-transition-group.

Reporting Issues

If you find an issue, please report it along with any relevant details to reproduce it. The easiest way to do so is to fork this sandbox on CodeSandbox.

Contributions

Yes please! Feature requests / pull requests are welcome. Learn how to contribute

Have a suggestion or just want to say hello? Come chat on Gitter!

License

react-infinite-calendar is available under the MIT License.