react-navigation / react-navigation/react-navigation.github.io
Convert v5.x.x samples to typescript in documentation
@jarvisluong is already working on this.
Since Apr 17, 2020.
- Dominant language
- JavaScript
- Stars
- 324
- Forks
- 2k
- PR merge metrics
- No merged PRs in 30d
Description
Current Behavior
react-navigation v5.x.x has written in typescript but documentation samples are based on javascript. in some cases it's hard to guess what type must be used
for example, I don't know what type I should use for creating the navigationRef in this documentation
having the examples in typescript language would be a great help (especially for those like me that working with previous versions of react-navigation and going to migrate their codes, there are a lot of changes in both libraries and types and it's hard to find at least for me.)
Expected Behavior
having documentation examples in typescript language. (or even having a switch button in code sections to switch between typescript and javascript examples)
How to reproduce
just review the documentation website :)
Your Environment
I think it does not really matter for the feature request.
| software | version |
|---|---|
| iOS or Android | |
| @react-navigation/native | |
| react-native | |
| expo | |
| node | |
| npm or yarn |
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.