react-day-picker 8.2.0 → 8.3.0

package/README.md

@@ -1,11 +1,35 @@
-# React DayPicker v8
+# React DayPicker
 
-DayPicker is a date picker component for [React](https://reactjs.org).
+[React DayPicker](http://react-day-picker.js.org) is a date picker component for [React](https://reactjs.org). Renders a calendar where the user can browse months to select days. DayPicker is customizable, works great with input fields and can be styled to match any design.
 
-```bash
-$ npm install react-day-picker date-fns  # using npm
-$ pnpm install react-day-picker date-fns # using pnpm
-$ yarn add react-day-picker date-fns     # using yarn
+➡️ **[react-day-picker.js.org](http://react-day-picker.js.org)** for guides, examples and API reference.
+
+<a href="http://react-day-picker.js.org">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/120693/188241991-19d0e8a1-230a-48c8-8477-3c90d4e36197.png"/>
+    <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/120693/188238076-311ec6d1-503d-4c21-8ffe-d89faa60e40f.png"/>
+    <img alt="Shows a screenshot of the React DayPicker component in a browser’s window." width="900" />
+  </picture>
+</a>
+
+## Main features
+
+- ☀️ Select days, ranges or whatever
+- 🧘‍♀️ using [date-fns](http://date-fns.org) as date library
+- 🌎 Localizable into any language
+- ➡️ Keyboard navigation
+- ♿️ [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) support
+- 🤖 Written in TypeScript
+- 🎨 Easy to style and customize
+- 🗓 Support multiple calendars
+- 📄 Easy to integrate input fields
+
+## Installation
+
+```shell
+npm install react-day-picker date-fns  # using npm
+pnpm install react-day-picker date-fns # using pnpm
+yarn add react-day-picker date-fns     # using yarn
 ```
 
 <a href="https://www.npmjs.com/package/react-day-picker">
@@ -18,20 +42,34 @@ $ yarn add react-day-picker date-fns     # using yarn
   <img src="https://img.shields.io/github/sponsors/gpbl?style=flat-square" alt="sponsors"/>
 </a>
 
-## Main features
+## Example
 
-- ☀️ Select days, ranges or whatever
-- 🌎 Localizable into any language
-- ➡️ Keyboard navigation
-- ♿️ [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) support
-- 🤖 Native TypeScript support
-- 🧘‍♀️ using [date-fns](http://date-fns.org) as date library
-- 🗓 Create multiple calendars
-- 🎨 Easy to style and customize
-- 📄 Native integration with input elements
+```tsx
+import React from 'react';
 
-## Documentation
+import { format } from 'date-fns';
+import { DayPicker } from 'react-day-picker';
+import 'react-day-picker/dist/style.css';
+
+export default function Example() {
+  const [selected, setSelected] = React.useState<Date>();
 
-- See ➡️ **[react-day-picker.js.org](http://react-day-picker.js.org)** for guides, examples and API reference.
+  let footer = <p>Please pick a day.</p>;
+  if (selected) {
+    footer = <p>You picked {format(selected, 'PP')}.</p>;
+  }
+  return (
+    <DayPicker
+      mode="single"
+      selected={selected}
+      onSelect={setSelected}
+      footer={footer}
+    />
+  );
+}
+```
+
+## Documentation
 
-<small>Looking for v7 docs? Go to <a href="https://react-day-picker-v7.netlify.app" target="_blank">react-day-picker-v7.netlify.app</a>.</small>
+See **[react-day-picker.js.org](http://react-day-picker.js.org)** for guides, examples and API reference of the latest version.
+<small>Docs for version 7 are at <a href="https://react-day-picker-v7.netlify.app" target="_blank">react-day-picker-v7.netlify.app</a>.</small>