react-native-date-picker - npm Package Compare versions

Comparing version 3.0.2 to 3.0.3

package.json

 {
   "name": "react-native-date-picker",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "A Cross Platform React Native Picker",
   "main": "src/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "prepublishOnly": "mv README.md githubREADME.md && mv npmREADME.md README.md",
-    "postpublish": "mv README.md npmREADME.md && mv githubREADME.md README.md"
+    "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -11,0 +9,0 @@ "repository": {

README.md

@@ -1,21 +0,211 @@
-# React Native Date Picker
-A cross platform <a href="https://github.com/henninghall/react-native-date-picker" title="React Native Date Pickers">react native date picker</a> component for android and ios. Including 3 different modes, date, time, and datetime. The date picker is customizable and have mulitple language support. 
+# React Native Date Picker [![npm](https://img.shields.io/npm/v/react-native-date-picker.svg)](https://www.npmjs.com/package/react-native-date-picker) [![Build status](https://img.shields.io/github/workflow/status/henninghall/react-native-date-picker/Android:%20build%20&%20test?label=tests)](https://github.com/henninghall/react-native-date-picker/actions) [![npm](https://img.shields.io/npm/dm/react-native-date-picker.svg)](https://www.npmjs.com/package/react-native-date-picker)
 
+This is a React Native Date Picker with following main features:
+
+📱 Supporting iOS and Android <br>
+🕑 3 different modes: Time, Date, DateTime <br>
+🌍 Multiple languages<br>
+🎨 Customizable<br>
+
 <table>
   <tr>
     <td align="center"><b>iOS</b></td>
-    <td align="center"><b>Android</b></td>  
   </tr>
    <tr>
-    <td><img src="https://camo.githubusercontent.com/6d48ab840daf8d55c6d9067c314497b5f7642ea3/68747470733a2f2f66616365626f6f6b2e6769746875622e696f2f72656163742d6e61746976652f646f63732f6173736574732f446174655069636b6572494f532f6d6178696d756d446174652e676966" alt="React Native Date Picker IOS" height="150px" />
+    <td><img src="docs/react-native-date-picker.gif" alt="React Native Date Picker" title="React Native Date Picker" height="150px" />
     </td>
-    <td><img src="https://github.com/henninghall/react-native-date-picker/blob/master/docs/react-native-date-picker-android.gif?raw=true" alt="React Native Date Picker Android" height="150px" style="margin-left:10px" />
-    </td>  
   </tr>
 
+  <tr>
+    <td align="center" colspan="2"><b>Android</b><br>Choose from 2 different variants</td>
+  </tr>
+   <tr>
+    <td><img src="docs/react-native-date-picker-android.gif" alt="React Native Date Picker Android" height="150px" style="margin-left:10px" />
+    </td>
+        <td><img src="docs/react-native-date-picker-android-native.gif" alt="React Native Datepicker" height="150px" style="margin-left:10px" />
+        </td>  
+  </tr>
+      <tr>
+  <td align="center"><code>androidVariant="iosClone"</code></td><td align="center"><code>androidVariant="nativeAndroid"</code></td>
+  </tr>
+  </table>
   
-  </table>
+## Installation
 
-## Documentation
+1. `npm install react-native-date-picker --save`
+2. `react-native link react-native-date-picker` (Only needed for React Native <= 0.59)
+3. `(cd ios && pod install)` (If you're using CocoaPods)
 
-See <a href="https://github.com/henninghall/react-native-date-picker">github page </a>for documentation and more info.
+Xcode 11 is required to run the latest version of the date picker. Xcode 10 is supported up to version 2.7.2. 
+
+## Minimal Example
+
+```jsx
+import React, { useState } from 'react'
+import DatePicker from 'react-native-date-picker'
+
+export default () => {
+
+  const [date, setDate] = useState(new Date())
+
+  return (
+    <DatePicker
+      date={date}
+      onDateChange={setDate}
+    />
+  )
+}
+
+```
+
+## Properties
+
+| Prop                    | Description                                                                                                                                                                                                                                                                                                           | Screenshots iOS                                                                                                                                                                                                                          | Screenshot Android                                                                                                                                                                                                                                                 |
+| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| date                    | The currently selected date.                                                                                                                                                                                                                                                                                          |
+| onDateChange            | Date change handler                                                                                                                                                                                                                                                                                                   |
+| fadeToColor             | Android picker is fading towards this background color. {color, 'none'}                                                                                                                                                                                                                                               |
+| maximumDate             | Maximum selectable date.                                                                                                                                                                                                                                                                                              |
+| minimumDate             | Minimum selectable date                                                                                                                                                                                                                                                                                               |
+| androidVariant          | Choose from 2 android style variants. {'iosClone', 'nativeAndroid'} (default: 'iosClone')                                                                                                                                                                                                                                                                         |                                                                                                                                           | <img src="docs/datetime-mode-android.png" alt="Datepicker ios clone variant" height="120px" /><img src="docs/react-native-date-picker-android.png" alt="Datepicker android native variant"/>                                                                                                                                                            |
+| minuteInterval          | The interval at which minutes can be selected.                                                                                                                                                                                                                                                                        | <img src="docs/minute-interval-ios.png" alt="Date picker minute interval IOS" height="120px" />                                                                                                                                          | <img src="docs/minute-interval-android.png" alt="Date picker minute interval Android" height="120px" />                                                                                                                                                            |
+| mode                    | The date picker mode. {'datetime', 'date', 'time'}                                                                                                                                                                                                                                                                    | <img src="docs/datetime-mode-ios.png" alt="React native date time picker" height="120px" /><img src="docs/date-mode-ios.png" alt="React native datepicker" height="120px" /><img src="docs/time-mode-ios.png" alt="React native time picker" height="120px" /> | <img src="docs/datetime-mode-android.png" alt="react native date time picker android" height="120px" /><img src="docs/date-mode-android.png" alt="react native datepicker android" height="120px" /><img src="docs/time-mode-android.png" alt="react native time picker android" height="120px" /> |
+| locale                  | The locale for the date picker. Changes language, date order and am/pm preferences. Value needs to be a <a title="react native datepicker locale id" href="https://developer.apple.com/library/content/documentation/MacOSX/Conceptual/BPInternational/LanguageandLocaleIDs/LanguageandLocaleIDs.html">Locale ID.</a> | <img src="docs/locale-ios.png" alt="React Native Date picker locale language ios" height="120px" />                                                                                                                                      | <img src="docs/locale-android.png" alt="React Native Date picker locale language android" height="120px" />                                                                                                                                                        |
+| textColor               | Changes the text color. ⚠ Colors other than black (#000000) or white (#ffffff) will replace the "Today" string with a date on iOS 13 or higher.                                                                                                                                                                                 | <img src="docs/colors-ios.png" alt="react native datepicker text color background color ios" height="120px" />                                                                                                                           | <img src="docs/colors-android.png" alt="Text color background color android" height="120px" />                                                                                                                                                                     |
+| timeZoneOffsetInMinutes | Timezone offset in minutes (default: device's timezone)                                                                                                                                                                                                                                                               |
+
+## About
+
+📅 &nbsp; React Native Date Picker is a cross platform component working on both iOS and Android. It uses the slightly improved DatePickerIOS on iOS and a custom picker on Android which has similar look and feel. The datetime mode might be particulary interesting if you looking for a way to avoid two different popup pickers on android.
+
+## FAQ
+
+### How do I change the divider color?
+The color of the divider, separator (or whatever you choose to call it) can only be changed on android for the androidNative variant. To change it, add the following to your android AppTheme. The theme is often found in styles.xml. 
+```xml
+<item name="colorControlNormal">#ff0000</item>
+```
+
+### Can I use expo?
+
+Unfortunately, expo does not support this date picker at the moment. Upvote <a href="https://expo.canny.io/feature-requests/p/support-react-native-date-picker">this feature request</a> if you would like to have it included.
+
+### How do i change the date order? (To YYYY-MM-DD etc)
+
+The order is determined by the `locale` prop. Set for instance `locale='fr'`to get the France preference.
+
+### How do i change the 12/24h or AM/PM format?
+
+On iOS the 12/24h preference is determined by the `locale` prop. Set for instance `locale='fr'`to get the France preference. On Android the 12/24h format is determined by the device setting. When using 12h mode the AM/PM part of the picker will be displayed.
+
+### Is it possible to show only month and year?
+
+This is unfortunately not possible due to the limitation in DatePickerIOS. You should be able to create your own month-year picker with for instance https://github.com/TronNatthakorn/react-native-wheel-pick.
+
+### Why does the Android app crash in production?
+
+If you have enabled <a href="https://facebook.github.io/react-native/docs/signed-apk-android#enabling-proguard-to-reduce-the-size-of-the-apk-optional">Proguard</a> for Android you might need to ignore some classes to get the the picker to work propery in android production/release mode. Add these lines to you proguard file (often called `proguard-rules.pro`):
+
+```
+-keep public class net.time4j.android.ApplicationStarter
+-keep public class net.time4j.PrettyTime
+```
+
+## Two different Android variants
+On Android there are two design variants to choose from:
+
+<table>
+<tr><td align="center"><b>iOS clone</b></td><td align="center"><b>Native Android</b></td>  
+  </tr><tr><td align="center">
+ <img src="docs/react-native-date-picker-android.gif" alt="date time picker" height="120px" />
+</td><td align="center">
+ <img src="docs/react-native-date-picker-android-native.gif" alt="date time picker" height="120px" />
+</td></tr>
+
+<tr><td>The so called "iOS clone" looks and works similar to the ios version. It shows normaly 5 lines of dates. It is enabled by default.</td><td>
+The "Android Native" version looks more like a standard native implementation on Android. The divider color can be changed by adding the following to you Android theme:
+<br><code>&lt;item name=&quot;colorControlNormal&quot;&gt;#03b6fc&lt;/item&gt;</code>
+</td></tr>
+<tr><td>
+
+```js
+androidVariant="nativeAndroid"
+```
+</td><td>
+
+```js
+androidVariant="iosClone"
+```
+</td></tr>
+</table>
+
+
+
+## Three different modes
+Here are some more info about the three different picker modes that are available.
+
+### Date time picker
+Using the datetime mode gives you a react native date time picker where both date and time can be selected at the same time. The todays date will be replays with the string "Today" translated to the desired language. This is the default mode and look like this.
+
+<table><tr><td align="center"><b>iOS</b></td><td align="center"><b>Android</b></td>  
+  </tr><tr><td>
+    <img src="docs/datetime-mode-ios.png" alt="date time picker" height="120px" 
+/>
+</td><td>
+    <img src="docs/datetime-mode-android.png" alt="date time picker" height="120px" />
+</td></tr></table>
+
+Add the optional `datetime` mode property to use this mode. Since datetime is default this could also be exclude. 
+
+```jsx
+<DatePicker
+  ...
+  mode="datetime"
+/>
+```
+
+### Datepicker
+The date mode displays a react native datepicker with year month and date where the year-month-date order will be adjusted to the locale. If will look similar to this: 
+<table><tr><td align="center"><b>iOS</b></td><td align="center"><b>Android</b></td>  
+  </tr><tr><td>
+    <img src="docs/date-mode-ios.png" alt="datepicker ios" height="120px" 
+/>
+</td><td>
+    <img src="docs/date-mode-android.png" alt="datepicker" height="120px" />
+</td></tr></table>
+
+Just add the value `date` to mode property: 
+
+```jsx
+<DatePicker
+  ...
+  mode="date"
+/>
+```
+
+### Time picker
+The time  mode can be used when only the time matters. AM/PM will be added depending on locale and user setting. It can be useful to add the `timeInterval` to only display the time with for instance 15min intervals. The react native time picker look like this:
+<table><tr><td align="center"><b>iOS</b></td><td align="center"><b>Android</b></td>  
+  </tr><tr><td>
+    <img src="docs/time-mode-ios.png" alt="react native time picker" height="120px" 
+/>
+</td><td>
+    <img src="docs/time-mode-android.png" alt="react native time picker android" height="120px" />
+</td></tr></table>
+
+Set mode property to `time` to show the time picker: 
+
+```jsx
+<DatePicker
+  ...
+  mode="time"
+/>
+```
+
+
+## Why another React Native datepicker?
+
+One of the strongest reason to use react native is its cross platform compatibility. Most of the official components are working seamlessly on both platforms but there are some with single platform support only. The react native datepicker is one example where both <a href="https://facebook.github.io/react-native/docs/datepickerios">DatePickerIOS</a> and <a href="https://facebook.github.io/react-native/docs/datepickerandroid">DatePickerAndroid</a> are present. The reason for this is that the default date picker is implemented in seperate ways, iOS normally have an integrated view picker wheel where android has different pickers in a dialog format.
+
+If you want to use these pickers you can combile the official ones or a third party module that already done that for you. If you on the other hand want have a more unified design between your android and ios app, this module is for you. The datetime mode can be particularly helpful to avoid 2 separate picker dialogs on android.
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

145081

increased by11.75%

Number of lines in readme file

212

increased by909.52%

No dependency changes