Skip to content
This repository was archived by the owner on May 19, 2025. It is now read-only.

Commit 52689ef

Browse files
committed
updated documentation
1 parent 81d6883 commit 52689ef

File tree

3 files changed

+15
-33
lines changed

3 files changed

+15
-33
lines changed

README.md

Lines changed: 9 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -17,39 +17,8 @@ $ npm install --save react-date-range
1717
```
1818

1919
## Usage
20-
### Date Picker
21-
```javascript
22-
import React, { Component } from 'react';
23-
import { Calendar } from 'react-date-range';
24-
25-
class MyComponent extends Component {
26-
handleSelect(date){
27-
console.log(date); // Momentjs object
28-
}
29-
30-
render(){
31-
return (
32-
<div>
33-
<Calendar
34-
onInit={this.handleSelect}
35-
onChange={this.handleSelect}
36-
/>
37-
</div>
38-
)
39-
}
40-
}
41-
42-
```
43-
44-
###### Available Options (props)
45-
* **date:** *(String, Moment.js object, Function)* - default: today
46-
* **format:** *(String)* - default: DD/MM/YYY
47-
* **firstDayOfWeek** *(Number)* - default: [moment.localeData().firstDayOfWeek()](http://momentjs.com/docs/#/i18n/locale-data/)
48-
* **theme:** *(Object)* see [Demo's source](https://github.com/Adphorus/react-date-range/blob/master/demo/src/components/Main.js#L130)
49-
* **onInit:** *(Function)* default: none
50-
* **onChange:** *(Function)* default: none
5120

52-
### Range Picker
21+
###
5322
```javascript
5423
import React, { Component } from 'react';
5524
import { DateRange } from 'react-date-range';
@@ -85,3 +54,11 @@ class MyComponent extends Component {
8554
* **linkedCalendars:** *(Boolean)* default: false
8655
* **calendars:** *(Number)* default: 2
8756
* **ranges:** *(Object)* default: none
57+
* **selectYear** *(Boolean)* default: false
58+
Activates select year dropdown.
59+
* **yearRange** *(Object)* default: ```{start: 10, end: 10}```
60+
Specifies the year range of the options in selectYear dropdown.
61+
* **pickSingleDate** *(Boolean)*
62+
Calendar only picks a single date.
63+
* **showIndex** *(Number)*
64+
Specifies the calendar where the date will be shown if there are multiple calendars.

demo/src/components/Main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export default class Main extends Component {
2828
render() {
2929
const { rangePicker, linked, datePicker, firstDayOfWeek, predefined} = this.state;
3030
const format = 'dddd, D MMMM YYYY';
31-
console.log(rangePicker)
31+
3232
return (
3333
<main className={styles['Main']}>
3434

src/DateRange.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,7 @@ DateRange.defaultProps = {
180180
linkedCalendars : false,
181181
selectYear : false,
182182
theme : {},
183+
yearRange : {start: 10, end:10},
183184
format : 'DD/MM/YYYY',
184185
calendars : 2,
185186
onlyClasses : false,
@@ -191,6 +192,10 @@ DateRange.propTypes = {
191192
selectYear : PropTypes.bool,
192193
pickSingleDate : PropTypes.bool,
193194
showIndex : PropTypes.number,
195+
yearRange : PropTypes.shape({
196+
start : PropTypes.number,
197+
end : PropTypes.number,
198+
}),
194199
format : PropTypes.string,
195200
firstDayOfWeek : PropTypes.number,
196201
calendars : PropTypes.oneOfType([PropTypes.string, PropTypes.number]),

0 commit comments

Comments
 (0)