Skip to content

Commit

Permalink
Added renderDayContents prop for custom day contents/day formatting (H…
Browse files Browse the repository at this point in the history
  • Loading branch information
DriesH authored and martijnrusschen committed Nov 3, 2018
1 parent 626ca16 commit 6fd129a
Show file tree
Hide file tree
Showing 9 changed files with 762 additions and 476 deletions.
62 changes: 34 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,18 @@ npm install react-datepicker --save
You’ll need to install React, PropTypes, and Moment.js separately since those dependencies aren’t included in the package. Below is a simple example of how to use the Datepicker in a React view. You will also need to require the CSS file from this package (or provide your own). The example below shows how to include the CSS from this package if your build system supports requiring CSS files (Webpack is one that does).

```js
import React from 'react';
import DatePicker from 'react-datepicker';
import moment from 'moment';
import React from "react";
import DatePicker from "react-datepicker";
import moment from "moment";

import 'react-datepicker/dist/react-datepicker.css';
import "react-datepicker/dist/react-datepicker.css";

// CSS Modules, react-datepicker-cssmodules.css
// import 'react-datepicker/dist/react-datepicker-cssmodules.css';

class Example extends React.Component {
constructor (props) {
super(props)
constructor(props) {
super(props);
this.state = {
startDate: moment()
};
Expand All @@ -48,10 +48,12 @@ class Example extends React.Component {
}

render() {
return <DatePicker
return (
<DatePicker
selected={this.state.startDate}
onChange={this.handleChange}
/>;
/>
);
}
}
```
Expand All @@ -67,7 +69,8 @@ The most basic use of the DatePicker can be described with:
You can use `onSelect` event handler which fires each time some calendar date has been selected

```js
<DatePicker selected={this.state.date}
<DatePicker
selected={this.state.date}
onSelect={this.handleSelect} //when day is clicked
onChange={this.handleChange} //only when value has changed
/>
Expand All @@ -86,7 +89,8 @@ You can also include a time picker by adding the showTimeSelect prop
selected={this.state.date}
onChange={this.handleChange}
showTimeSelect
dateFormat="LLL" />
dateFormat="LLL"
/>
```

Times will be displayed at 30-minute intervals by default (default configurable via timeInterval prop)
Expand All @@ -97,8 +101,8 @@ More examples of how to use the time picker are given on the [main website](http

The date picker relies on [moment.js internationalization](http://momentjs.com/docs/#/i18n/) to localize its display components. By default, the date picker will use the locale globally set in moment, which is English. Locales can be changed in the following ways:

- **Globally** by calling `moment.locale(lang)`
- **Picker-specific** by providing the `locale` prop
* **Globally** by calling `moment.locale(lang)`
* **Picker-specific** by providing the `locale` prop

Locales can be further configured in moment with various [customization options](http://momentjs.com/docs/#/customization/).

Expand All @@ -111,40 +115,42 @@ _As of version 0.23, the `weekdays` and `weekStart` DatePicker props have been r
We're always trying to stay compatible with the latest version of React. We can't support all older versions of React.

Latest compatible versions:
- React 15.5 or newer: All above React-datepicker v.0.40.0
- React 15.4.1: needs React-datepicker v0.40.0, newer won't work (due to react-onclickoutside dependencies)
- React 0.14 or newer: All above React-datepicker v0.13.0
- React 0.13: React-datepicker v0.13.0
- pre React 0.13: React-datepicker v0.6.2

* React 15.5 or newer: All above React-datepicker v.0.40.0
* React 15.4.1: needs React-datepicker v0.40.0, newer won't work (due to react-onclickoutside dependencies)
* React 0.14 or newer: All above React-datepicker v0.13.0
* React 0.13: React-datepicker v0.13.0
* pre React 0.13: React-datepicker v0.6.2

### Browser Support

The date picker is compatible with the latest versions of Chrome, Firefox, and IE10+.

Unfortunately, it is difficult to support legacy browsers while maintaining our ability to develop new features in the future. For IE9 support, it is known that the [classlist polyfill](https://www.npmjs.com/package/classlist-polyfill) is needed, but this may change or break at any point in the future.
Unfortunately, it is difficult to support legacy browsers while maintaining our ability to develop new features in the future. For IE9 support, it is known that the [classlist polyfill](https://www.npmjs.com/package/classlist-polyfill) is needed, but this may change or break at any point in the future.

## Local Development

The `master` branch contains the latest version of the Datepicker component. To start your example app, you can run `yarn start`. This starts a simple webserver on http://localhost:8080.

You can run `yarn test` to execute the test suite and linters. To help you develop the component we’ve set up some tests that cover the basic functionality (can be found in `/tests`). Even though we’re big fans of testing, this only covers a small piece of the component. We highly recommend you add tests when you’re adding new functionality.
You can run `yarn test` to execute the test suite and linters. To help you develop the component we’ve set up some tests that cover the basic functionality (can be found in `/tests`). Even though we’re big fans of testing, this only covers a small piece of the component. We highly recommend you add tests when you’re adding new functionality.

### The examples

The examples are hosted within the docs folder and are ran in the simple app that loads the Datepicker. To extend the examples with a new example, you can simply duplicate one of the existing examples and change the unique properties of your example.

## Accessibility

### Keyboard support

* *Left*: Move to the previous day.
* *Right*: Move to the next day.
* *Up*: Move to the previous week.
* *Down*: Move to the next week.
* *PgUp*: Move to the previous month.
* *PgDn*: Move to the next month.
* *Home*: Move to the previous year.
* *End*: Move to the next year.
* *Enter/Esc/Tab*: close the calendar. (Enter & Esc calls preventDefault)
* _Left_: Move to the previous day.
* _Right_: Move to the next day.
* _Up_: Move to the previous week.
* _Down_: Move to the next week.
* _PgUp_: Move to the previous month.
* _PgDn_: Move to the next month.
* _Home_: Move to the previous year.
* _End_: Move to the next year.
* _Enter/Esc/Tab_: close the calendar. (Enter & Esc calls preventDefault)

## License

Expand Down
9 changes: 5 additions & 4 deletions docs-site/bundle.js
Original file line number Diff line number Diff line change
Expand Up @@ -24384,7 +24384,8 @@
},
/* 416 */
/***/ function(module, exports) {
module.exports = function(hljs) { // TODO support filter tags like :javascript, support inline HTML
module.exports = function(hljs) {
// TODO support filter tags like :javascript, support inline HTML
return {
case_insensitive: true,
contains: [
Expand Down Expand Up @@ -30324,7 +30325,8 @@
},
/* 475 */
/***/ function(module, exports) {
module.exports = function(hljs) { // Base deafult colors in PB IDE: background: #FFFFDF; foreground: #000000;
module.exports = function(hljs) {
// Base deafult colors in PB IDE: background: #FFFFDF; foreground: #000000;
var STRINGS = {
// PB IDE color: #0080FF (Azure Radiance)
className: "string",
Expand Down Expand Up @@ -71454,8 +71456,7 @@
});

for (
var es6Symbols = // 19.4.2.2, 19.4.2.3, 19.4.2.4, 19.4.2.6, 19.4.2.8, 19.4.2.9, 19.4.2.10, 19.4.2.11, 19.4.2.12, 19.4.2.13, 19.4.2.14
"hasInstance,isConcatSpreadable,iterator,match,replace,search,species,split,toPrimitive,toStringTag,unscopables".split(
var es6Symbols = "hasInstance,isConcatSpreadable,iterator,match,replace,search,species,split,toPrimitive,toStringTag,unscopables".split( // 19.4.2.2, 19.4.2.3, 19.4.2.4, 19.4.2.6, 19.4.2.8, 19.4.2.9, 19.4.2.10, 19.4.2.11, 19.4.2.12, 19.4.2.13, 19.4.2.14
","
),
j = 0;
Expand Down
Loading

0 comments on commit 6fd129a

Please sign in to comment.