Mistake within the Documentation

Open Beginner friendly
#203 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
react
Domain
documentation

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.

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.
Screen Shot 2021-05-22 at 6 21 19 pm
Screen Shot 2021-05-22 at 6 21 41 pm

Thanks

Dominant language
TypeScript
Stars
332
Forks
140
Avg merge
22h 19m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from react-component/collapse

All issues in react-component/collapse

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.