react-component / react-component/collapse
Mistake within the Documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 332
- Forks
- 140
- Avg merge
- 22h 19m
- Merged PRs (30d)
- 1
Description
Hi,
I installed the library for the first time and found myself working through the documentation and discovered a mistake.
The docs outline that the openMotion prop falls under the Collapse.Panel component. Although, I went looking into the source of the react-component github page - here - to discover that the openMotion is a prop on the <Collapse> component, not the <Panel>
I've attached two screenshots to highlight the mistake.
Thanks
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
Find the documentation entry that describes the openMotion prop under Collapse.Panel, then compare it with the linked react-component Collapse story and source. Update the documentation to identify openMotion as a prop on Collapse, and verify that the corrected component description is consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 78/100