Skip to content

Latest commit

 

History

History
90 lines (63 loc) · 3.28 KB

README.md

File metadata and controls

90 lines (63 loc) · 3.28 KB
Raw

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 DateRangePicker = require('react-bootstrap-daterangepicker');
var someReactComponent = React.createClass({
    render: function () {
        return (
            <DateRangePicker startDate="1/1/2014" endDate="3/1/2014">
                <div>Click Me To Open Picker!</div>
            </DateRangePicker>
        );
    }
});
  1. Include the daterangepicker CSS in your project somewhere. The CSS file is here: daterangepicker-bs3.css (don't hotlink- download and host your own copy)
<link rel="stylesheet" href="daterangepicker-bs3.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, timePicker12Hour, timePickerSeconds, ranges, opens, buttonClasses, applyClass, cancelClass, format, separator, locale, singleDatePicker, parentEl

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.