react-component / react-component/tooltip
Feature Request: More aggressive types
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 944
- Forks
- 199
- Avg merge
- 19h 1m
- Merged PRs (30d)
- 3
Description
Thanks for the wonderful library! I think it would be really great if the types documented the API of the component a little more closely. For instance the type of "placement" is string, whereas the actual allowed values (according to the readme) are 'left','right','top','bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'. It would be great if the type knew about all of the things that the documentation knew about, which allows autocompleters/intellisensers to be able to provide in context documentation.
(I'd be happy to help if you are busy with other things!)
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 by comparing the README's documented placement values with the current TypeScript type for placement. Trace the other documented component props to define the scope; done means the declarations cover the documented API and editor completion reflects the allowed values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100