Adding Readme.md and docs by DanielSanudo · Pull Request #7 · react-native-datetimepicker/datetimepicker

DanielSanudo · 2019-06-12T15:44:03Z

Summary

Readme.md added with documentation included

Compatibility

OS	Implemented
iOS	✅
Android	✅

Checklist

I have tested this on a device and a simulator
I added the documentation in README.md
I mentioned this change in CHANGELOG.md
I updated the typed files (TS and Flow)
I added a sample use of the API in the example project (example/App.js)

Swaagie

Nice work, mostly small comments. The bigger one is ordering of sections. Imho I think the generic flow should be

Installing/adding the component to your project
Using the React Component with examples
API/props
Migration examples
Contributing to the component
5a. clone, install
5b. how to test
5c. running the example

In addition a TOC might be useful on top (index 0) of the readme

Swaagie · 2019-06-12T22:33:55Z

+- Using CocoaPods:
+
+  1. Install CocoaPods, here the [installation guide](https://guides.cocoapods.org/using/getting-started.html).
+  2. Inside the iOS folder run `pod init`, this will create the initial `pod` file.


This section is ok to have, but it feels like the focus should be more on adding RNDateTimePicker from the podspec. Right now it is focused on setting up the consuming app, which most avid cocoapods users might have already done when they initialized their own project.

Swaagie · 2019-06-12T22:35:20Z

+      end
+      ```
+  4. Run `pod install` inside the same folder where the `pod` file was created
+  5. Open the `.xcworkspace` file that was created and run


run what? Also why go through xcode, the norm is using the react-native CLI, e.g. react-native run-{ios,android}

run from Xcode, I will change it to use CLI.

Swaagie · 2019-06-12T22:36:09Z

+4. Add the import and link the package in `MainApplication.java`:
+
+   ```java
+   import com.reactcommunity.rndatetimepicker.RNDateTimePickerPackage; // <-- add this import


rather than using // <-- add this import, use ```diff to denote what should be added or changed

Swaagie · 2019-06-12T22:41:24Z

+Defines the maximum date that can be selected.
+
+```js
+<RNDateTimePicker maximumDate={new Date()} />


Make this an actual example, not the current Date. Year 2250 or something

Swaagie · 2019-06-12T22:42:17Z

+Defines the date or time value used in the component.
+
+```js
+<RNDateTimePicker value={new Date()} />


This is the default for value, specifying a different value or an example with state/ HOC props would be nice to have.

Swaagie · 2019-06-12T22:42:21Z

+Defines the minimum date that can be selected.
+
+```js
+<RNDateTimePicker minimumDate={new Date()} />


Same as above

3rd-Eden

Limit your self to a 80 cols of text space, some of the code examples are impossible to read without scrolling sideways for example.
Add a table of contents and link to the different API’s
Would love to see a compatiblity table.
Reference the license
Screenshots? People love screenshots.

3rd-Eden · 2019-06-13T13:05:11Z

+
+## Getting started
+
+`npm install react-native-datetimepicker --save`


Use 3x backticks for code, instead of 1, add bash as language identifier.

3rd-Eden · 2019-06-13T13:05:22Z

+
+or
+
+`yarn add react-native-datetimepicker`


See backtick

3rd-Eden · 2019-06-13T13:05:28Z

+
+### Install using react-native link
+
+`react-native link react-native-datetimepicker`


See backtick

3rd-Eden · 2019-06-13T13:11:00Z

+
+### `timeZoneOffsetInMinutes` (`optional`, `iOS only`)
+
+Allows to change the timeZone of the date picker, by default it uses the device's time zone.


Allows changing of the

I would also suggest replacing the comma with a .

3rd-Eden · 2019-06-13T13:11:07Z

+
+### `locale` (`optional`, `iOS only`)
+
+Allows to change the locale of the component, by default it uses the device's locale.


Allow schanging of the

3rd-Eden · 2019-06-13T13:11:43Z

+
+### `is24Hour` (`optional`, `Android only`)
+
+Allows to set the time picker to 24hour format.


Allows changing of the time picker to a 24 hour format

3rd-Eden · 2019-06-13T13:13:38Z

+
+RNDateTimePicker is the new common name used to represent the old versions of iOS and Android.
+
+On android, open picker modals will update the selected date and/or time if the prop `value` changes. For example, if a HOC holding state, updates the `value` prop. Previously the component used to close the modal and render a new one on consecutive calls.


3rd-Eden · 2019-06-13T13:14:05Z

+
+## Migration from the older components
+
+RNDateTimePicker is the new common name used to represent the old versions of iOS and Android.


backticks around RNDateTimePicker

Swaagie · 2019-06-13T13:43:28Z

Wrt to license reference, I'd prefer a badge over text

Swaagie suggested changes Jun 12, 2019

View reviewed changes

DanielSanudo added 4 commits June 13, 2019 13:11

Adding docs

873e285

Adding rest of the docs

8bc6847

CHANGELOG.md entry added

b4b2276

Addressing PR comments

f5e4e8d

DanielSanudo force-pushed the initial_docs branch from cad606c to f5e4e8d Compare June 13, 2019 12:12

DanielSanudo added 2 commits June 13, 2019 13:19

Updating docs

38a3a89

CircleCI config upated

2b91b0d

Swaagie approved these changes Jun 13, 2019

View reviewed changes

3rd-Eden suggested changes Jun 13, 2019

View reviewed changes

DanielSanudo added 2 commits June 13, 2019 15:48

Activating detox tests for circleci

d909c35

Addressing PR comments and adding some screenshots

ed9c31a

DanielSanudo merged commit 7f98d92 into react-native-datetimepicker:master Jun 13, 2019

DanielSanudo deleted the initial_docs branch June 13, 2019 21:22


		## Getting started

		`npm install react-native-datetimepicker --save`


		### Install using react-native link

		`react-native link react-native-datetimepicker`


		### `timeZoneOffsetInMinutes` (`optional`, `iOS only`)

		Allows to change the timeZone of the date picker, by default it uses the device's time zone.


		### `locale` (`optional`, `iOS only`)

		Allows to change the locale of the component, by default it uses the device's locale.


		### `is24Hour` (`optional`, `Android only`)

		Allows to set the time picker to 24hour format.


		RNDateTimePicker is the new common name used to represent the old versions of iOS and Android.

		On android, open picker modals will update the selected date and/or time if the prop `value` changes. For example, if a HOC holding state, updates the `value` prop. Previously the component used to close the modal and render a new one on consecutive calls.


		## Migration from the older components

		RNDateTimePicker is the new common name used to represent the old versions of iOS and Android.

Conversation

DanielSanudo commented Jun 12, 2019

Summary

Compatibility

Checklist

Uh oh!

Swaagie left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

3rd-Eden left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Swaagie commented Jun 13, 2019

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Swaagie left a comment •

edited

Loading