microsoft / microsoft/react-native-windows-samples
Documentation for custom props
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 544
- Forks
- 218
- PR merge metrics
- No merged PRs in 30d
Description
Hey there!
I found it really hard to figure out react-native-windows specific custom props like onMouseEnter for the view component. There seems to be no (complete) documentation of the neat props you added to the components. For View props there is IViewWindowsProps docs but there are many probs missing.
Maybe you already have this, but the best discoverability of props I find is through typescript types. Do you provide your own types for components? Obviously the vanilla react-native ViewProps type would not have onMouseEnter for example.
Is there a list of all custom props? Do you need any help in adding them to the docs?
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.
Research direction
Start with the linked IViewWindowsProps documentation and the React Native Windows View component, then check whether custom component props have TypeScript types. Compare the documented props with the available custom props and define a complete, discoverable list; done means the Windows-specific props are documented and their typing status is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react-native, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 32/100