1.0.0 • Published 4 years ago

react-full-event-calendar v1.0.0

Weekly downloads
21
License
MIT
Repository
github
Last release
4 years ago

react-full-event-calendar

React component for events

NPM JavaScript Style Guide

Install

npm install --save react-full-event-calendar

or

yarn add react-full-event-calendar

Usage

import Calendar from "react-full-event-calendar";

const events = [
  {
    startTime: new Date(moment().add(2, "hour")),
    endTime: new Date(moment().add(3, "hour")),
    title: "working in the weekend"
  },
  {
    startTime: new Date(moment().add(-3, "hour")),
    endTime: new Date(moment().add(-2, "hour")),
    title: "working in the weekend"
  },
  {
    startTime: new Date(),
    endTime: new Date(moment().add(1, "hour")),
    title: "working in the weekend"
  }
];

<Calendar events={events} />;

Props

PropertyTypeDefaultDescription
eventsArrayRequiredEvents to display on the calendar
dayOrientationStringhorizontalThe orientation of the day calendar, either 'vertical' or 'horizontal'
defautlCalendarViewStringweekThe default calendar to show, either 'day', 'week' or 'month'
defaultDateDatenew Date()The date to start on when mounted
onDayChangefunc(day, newDay)Callback when the day change on day calendar
onWeekChangefunc(newStartOfTheWeek, newEendOfTheWeek)Callback when the week change on week calendar
onMonthChangefunc(newMonth, newYear)Callback when the month change on month calendar

Event Objects

KeyTypeRequiredDescription
titleStringtrueThe title of the event
startTimeDatetrueThe start time of the event
endTimeDatetrueThe end time of the event

DEMO

Demo

Authors

See the list of all contributors who participated in this project.

License

MIT © Karlmusingo