React-datepicker: Documentation is lacking

Created on 22 Aug 2018  Â·  10Comments  Â·  Source: Hacker0x01/react-datepicker

The component "documentation" lists the available props. Since most of them are missing a description, it's a bit of trial and error to use them correctly.

wontfix

Most helpful comment

I'd like to see a description of every prop in the docs folder.
I can't exactly remember what I needed when I created the issue.
The examples only describe how to achieve specific scenarios. The list is obviously not exhaustive.
Most of the props are not used in the examples. adjustDateOnChange, clearButtonTitle, customInputRef …

All 10 comments

+

I wanna props api doc.
examples are not cover all the cases

e.g. isOpen doc is missed

I would like the documentation to answer the question: how does one get a blank field to start?

I would like documentation that would address a growing number of nebulous usage challenges. Using this github repo for technical questions is mostly unhelpful and getting very little notice from any existing knowledgeable devs.

it is super hard to predict the arguments and use them without docs. i really appreciate to have written documentation

https://reactdatepicker.com/ contains a lot of examples, is this what you're looking for?

@martijnrusschen To me, it's not.

Can you be a little bit more descriptive about what you would like to see?

I'd like to see a description of every prop in the docs folder.
I can't exactly remember what I needed when I created the issue.
The examples only describe how to achieve specific scenarios. The list is obviously not exhaustive.
Most of the props are not used in the examples. adjustDateOnChange, clearButtonTitle, customInputRef …

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

WAT?

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ahribori picture ahribori  Â·  3Comments

arturictus picture arturictus  Â·  3Comments

jcabrerazuniga picture jcabrerazuniga  Â·  3Comments

lclemence picture lclemence  Â·  3Comments

pinturic picture pinturic  Â·  3Comments