Overview

Welcome to the react-spring docs site!

What is this?

Our old documentation was lacking in features & clarity. So, based on community feedback, we've made an endeavor to improve our documentation with a few key differences:

• We want to explain more of our codebase conceptually e.g what is an animated component
• All our content will be searchable so no more running around in the dark
• Step-by-step tutorials on how to achieve common use-cases

How can I help?

Thank you for being interested in helping! It means a lot — if you want to share feedback or open a discussion, head over to the GitHub Discussions thread.

If you're interested in adding an example to the site then why not check out the specific contributing guide.

Breaking changes

from v9 to v10

v10 introduced the move to React 19 and brought a breaking change to the SpringContext API. To add the Spring context provider, you must explicitly use SpringContextProvider.

before:

import { SpringContext } from 'react-spring'

...
<SpringContext ...>
...

now:

import { SpringContextProvider } from 'react-spring'

...
<SpringContextProvider ...>
...