|
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495 |
- # react-big-calendar
-
- An events calendar component built for React and made for modern browsers (read: IE10+) and uses flexbox over the classic tables-ception approach.
-
- [**DEMO and Docs**](http://intljusticemission.github.io/react-big-calendar/examples/index.html)
-
- Inspired by [Full Calendar](http://fullcalendar.io/).
-
- ## Use and Setup
-
- `yarn add react-big-calendar` or `npm install --save react-big-calendar`
-
- Include `react-big-calendar/lib/css/react-big-calendar.css` for styles, and make sure your calendar's container
- element has a height, or the calendar won't be visible. To provide your own custom styling, see the [Custom Styling](#custom-styling) topic.
-
- ## Starters
-
- - [react-big-calendar](https://github.com/arecvlohe/rbc-starter)
- - [react-big-calendar with drag and drop](https://github.com/arecvlohe/rbc-with-dnd-starter)
-
- ## Run examples locally
-
- ```sh
- $ git clone git@github.com:intljusticemission/react-big-calendar.git
- $ cd react-big-calendar
- $ yarn
- $ yarn examples
- ```
-
- - Open [localhost:3000/examples/index.html](http://localhost:3000/examples/index.html).
-
- ### Localization and Date Formatting
-
- `react-big-calendar` includes two options for handling the date formatting and culture localization, depending
- on your preference of DateTime libraries. You can use either the [Moment.js](http://momentjs.com/) or [Globalize.js](https://github.com/jquery/globalize) localizers.
-
- Regardless of your choice, you **must** choose a localizer to use this library:
-
- #### Moment.js
-
- ```js
- import { Calendar, momentLocalizer } from 'react-big-calendar'
- import moment from 'moment'
-
- const localizer = momentLocalizer(moment)
-
- const MyCalendar = props => (
- <div>
- <Calendar
- localizer={localizer}
- events={myEventsList}
- startAccessor="start"
- endAccessor="end"
- />
- </div>
- )
- ```
-
- #### Globalize.js v0.1.1
-
- ```js
- import { Calendar, globalizeLocalizer } from 'react-big-calendar'
- import globalize from 'globalize'
-
- const localizer = globalizeLocalizer(globalize)
-
- const MyCalendar = props => (
- <div>
- <Calendar
- localizer={localizer}
- events={myEventsList}
- startAccessor="start"
- endAccessor="end"
- />
- </div>
- )
- ```
-
- ## Custom Styling
-
- Out of the box you can include the compiled css files and be up and running. But, sometimes, you may want to style
- Big Calendar to match your application styling. For this reason SASS files are included with Big Calendar.
-
- ```
- @import 'react-big-calendar/lib/sass/styles';
- @import 'react-big-calendar/lib/addons/dragAndDrop/styles'; // if using DnD
- ```
-
- SASS implementation provides a `variables` file containing color and sizing variables that you can
- update to fit your application. _Note:_ Changing and/or overriding styles can cause rendering issues with your
- Big Calendar. Carefully test each change accordingly.
-
- ## Join us on Reactiflux Discord
-
- Join us on [Reactiflux Discord](https://discord.gg/uJsgpkC) community under the channel #react-big-calendar if you have any questions.
|