pmndrs / pmndrs/react-spring

[bug]: Incorrect tooltips in useTransition docs

Open
#2,232 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: docs type: good first issue
Dominant language
TypeScript
Stars
29.1k
Forks
1.2k
PR merge metrics
No merged PRs in 30d

Description

Which react-spring target are you using?
  • @react-spring/web
  • @react-spring/three
  • @react-spring/native
  • @react-spring/konva
  • @react-spring/zdog
What version of react-spring are you using?

9.7.3

What's Wrong?

Browsing the docs for useTransition on https://www.react-spring.dev/docs/components/use-transition shows the incorrect tooltip content for the following props:

  • enter
  • update
  • leave

The tooltip content for these props show The to prop, is very versatile, for more information checkout out Async Animations.

image
To Reproduce

Check the References section in the useTransition docs and activate the tooltips for:

  • enter
  • update
  • leave

They display incorrect information about each prop.

Expected Behaviour

The tooltip should show information relevant to what each prop does, instead of the to prop for all of them.

Link to repo

https://www.react-spring.dev/docs/components/use-transition#reference

Contributor guide

Open the contributing guide

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.

Research direction

Start at the useTransition documentation's References section and inspect how the enter, update, and leave tooltip content is defined. Replace the repeated to-prop text with information relevant to each prop, then verify the three tooltips on the documented useTransition page.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.