themesberg / themesberg/flowbite-react
Improve component's documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.1k
- Forks
- 506
- PR merge metrics
- No merged PRs in 30d
Description
Summary
Please improve the documentation! I actually don't know about other components, but I've been trying to use DatePicker for some good time and had to go into the code to know that the change event is onSelectedDateChange (that was rough)
It would be cool to have props/theme/events tabs on each component (Like the Chakra UI docs, for example)
Context
Trying to guess the change event from DatePicker component.
Contributor guide
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 locating the DatePicker documentation and comparing its current presentation with the other component docs. Verify how the onSelectedDateChange event and component props, theme, and events are exposed, then determine whether the proposed tabs should apply consistently across components. Done means users can find this API without reading the source and the documentation structure is consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100