Skip to content

Latest commit

 

History

History
96 lines (67 loc) · 3.89 KB

README.md

File metadata and controls

96 lines (67 loc) · 3.89 KB

react-bootstrap-daterangepicker

NPM version Dependency Status devDependency Status

Description

A date/time picker for react (using bootstrap). This is a react port of:

bootstrap-daterangepicker

Getting Started

  1. Install the module with: npm install --save react-bootstrap-daterangepicker

  2. Create your module (you need to use something like browserify to build)

var React = require('react');
var moment = require('moment');

var DateRangePicker = require('react-bootstrap-daterangepicker');
var someReactComponent = React.createClass({
    render: function () {
        return (
            <DateRangePicker startDate={moment("2014-04-23T09:54:51")} endDate={moment("2014-08-23T09:54:51")}>
                <div>Click Me To Open Picker!</div>
            </DateRangePicker>
        );
    }
});
  1. Include the daterangepicker CSS in your project somewhere. The CSS file is here: daterangepicker.css (don't hotlink- download and host your own copy)
<link rel="stylesheet" href="daterangepicker.css" type="text/css" />

Documentation

For in depth documentation, see the original bootstrap-daterangepicker project page.

You can pass all the same props as the original plugin:

  • startDate, endDate, minDate, maxDate, dateLimit, timeZone, showDropdowns, showWeekNumbers, timePicker, timePickerIncrement, timePicker24Hour, timePickerSeconds, ranges, opens, drops, buttonClasses, applyClass, cancelClass, locale, singleDatePicker, parentEl

You can also use the following additional prop:

  • alwaysShowCalendar: Defaults to false. If set to true and ranges are added the calendar will always be shown and any selection of the ranges will result in updating the calendars without hiding the control. It is recommended that the styling of the ranges be changed to include a selector when using this options. Change the style .daterangepicker .ranges li:hover to .daterangepicker .ranges li:not(:last-child):hover
  • debug: No value needed. Used to output some debug information from the calendar.

You can listen to the following 7 events:

  • onShow: thrown when the widget is shown
  • onHide: thrown when the widget is hidden
  • onShowCalendar: thrown when the calendar is shown
  • onHideCalendar: thrown when the calendar is hidden
  • onApply: thrown when the apply button is clicked
  • onCancel: thrown when the cancel button is clicked
  • onEvent: thrown when any of the 4 events above are triggered

All 7 of the events above should take a handler that is passed 2 arguments: event and picker

Example event handler:

var someReactComponent = React.createClass({
    handleEvent: function (event, picker) {
        console.log(picker.startDate);
    },
    render: function () {
        return (
            <DateRangePicker onEvent={this.handleEvent} />
        );
    }
});

Links

License

Copyright (c) 2014 skratchdot
Uses the original bootstrap-daterangepicker license.