AnimatePresence
AnimatePresence
makes exit animations easy. By wrapping one or more motion
components with AnimatePresence
, we gain access to the exit
animation prop.
Usage
Import
Exit animations
AnimatePresence
works by detecting when its direct children are removed from the React tree.
This can be due to a component mounting/remounting:
Its key
changing:
Or when children in a list are added/removed:
Any motion
components within the exiting component will fire animations defined on their exit
props before the component is removed from the DOM.
Note: Direct children must each have a unique key
prop so AnimatePresence
can track their presence in the tree.
Like initial
and animate
, exit
can be defined either as an object of values, or as a variant label.
Changing key
Changing a key
prop makes React create an entirely new component. So by changing the key
of a single child of AnimatePresence
, we can easily make components like slideshows.
Access presence state
Any child of AnimatePresence
can access presence state with the useIsPresence
hook.
This allows you to change content or styles when a component is no longer rendered.
Access presence data
When a component has been removed from the React tree, its props can no longer be updated. We can use AnimatePresence
's custom
prop to pass new data down through the tree, even into exiting components.
Then later we can extract that using usePresenceData
.
Manual usage
It's also possible to manually tell AnimatePresence
when a component is safe to remove with the usePresence
hook.
This returns both isPresent
state and a callback, safeToRemove
, that should be called when you're ready to remove the component from the DOM (for instance after a manual animation or other timeout).
Propagate exit animations
By default, AnimatePresence
controls the exit
animations on all of its children, until another AnimatePresence
component is rendered.
By setting an AnimatePresence
component's propagate
prop to true
, when it's removed from another AnimatePresence
it will fire all of its children's exit animations.
Props
initial
By passing initial={false}
, AnimatePresence
will disable any initial animations on children that are present when the component is first rendered.
custom
When a component is removed, there's no longer a chance to update its props (because it's no longer in the React tree). Therefore we can't update its exit animation with the same render that removed the component.
By passing a value through AnimatePresence
's custom
prop, we can use dynamic variants to change the exit
animation.
This data can be accessed by children via usePresenceData
.
mode
Default: "sync"
Decides how AnimatePresence
handles entering and exiting children.
"sync"
: Children animate in/out as soon as they're added/removed."wait"
: The entering child will wait until the exiting child has animated out. Note: Currently only renders a single child at a time."popLayout"
: Exiting children will be "popped" out of the page layout. This allows surrounding elements to move to their new layout immediately.
Custom component note: When using popLayout
mode, any immediate child of AnimatePresence that's a custom component must be wrapped in React's forwardRef
function, forwarding the provided ref
to the DOM node you wish to pop out of the layout.
onExitComplete
Fires when all exiting nodes have completed animating out.
propagate
Default: false
If set to true
, exit animations on children will also trigger when this AnimatePresence
exits from a parent AnimatePresence
.
Troubleshooting
Exit animations aren't working
Ensure all immediate children get a unique key
prop that remains the same for that component every render.
For instance, providing index
as a key
is bad because if the items reorder then the index
will not be matched to the item
:
It's preferred to pass something that's unique to that item, for instance an ID:
Also make sure AnimatePresence
is outside of the code that unmounts the element. If AnimatePresence
itself unmounts, then it can't control exit animations!
For example, this will not work:
Instead, the conditional should be at the root of AnimatePresence
:
Layout animations not working with mode="sync"
When mixing layout and exit animations, it might be necessary to wrap the group in LayoutGroup
to ensure that components outside of AnimatePresence
know when to perform a layout animation.
Layout animations not working with mode="popLayout"
When any HTML element has an active transform
it temporarily becomes the offset parent of its children. This can cause children with position: "absolute"
not to appear where you expect.mode="popLayout"
works by using position: "absolute"
. So to ensure consistent and expected positioning during a layout animation, ensure that the animating parent has a position
other than "static"
.
Motion+ examples
Motion+ is a one-time payment, lifetime membership that gains you access to the source code of an ever-growing library of premium examples, as well as premium components like Cursor
and AnimateNumber
.
It features a number of examples involving AnimatePresence
, including: