PoseGroup

The PoseGroup component manages enter and exit animations on its direct children as they enter and exit the component tree.

Import

import posed, { PoseGroup } from 'react-pose'

Usage

By adding a posed component as a direct child of PoseGroup, it will gain two new poses: enter and exit.

const Item = posed.div({
  enter: { opacity: 1 },
  exit: { opacity: 0 }
})

const ItemList = ({ items }) => (
  <PoseGroup>
    {items.map((item) => <Item key={item.id} />)}
  </PoseGroup>
)

Notes:

  • Every child must be provided a unique key property for PoseGroup to track entering and exiting children.
  • Entering children transition from their pre-enter pose to 'enter'. The pre-enter pose is 'exit' by default, and can be edited with the preEnterPose prop.

Animating children

As with any posed component, the enter/exit pose will propagate throughout any of its posed component children.

In the case of the exit pose, PoseGroup will only unmount the animating component once all of its children have also finished their exit animation.

Passing props to children

A common problem with transition components is passing props to components that have been removed from the tree. They might be animating out, but as far as React is concerned, they’ve already left (so props don’t get updated).

With Pose for React, any props you provide to PoseGroup will be forwarded to all children, even ones that are leaving the tree.

This allows you to use the latest props in dynamic poses:

const Item = posed.li({
  enter: { opacity: 1, x: 0 },
  exit: {
    opacity: 0,
    x: ({ selectedItemId, id }) =>
      id === selectedItemId ? 100 : -100
  }
});

export default ({ items, selectedItemId }) => (
  <PoseGroup selectedItemId={selectedItemId}>
    {items.map(({ id }) => <Item id={id} />)}
  </PoseGroup>
);

Props

animateOnMount

animateOnMount: boolean = false

By default, only children added to the PoseGroup after it has mounted are animated to enter.

By setting animateOnMount to true, all children elements will animate in on mount.

enterPose

enterPose: string = 'enter'

The name of the pose to use when a component enters.

exitPose

exitPose: string = 'exit'

The name of the pose to use when a component leaves.

preEnterPose

preEnterPose: string = 'exit'

The name of the pose to set before a component enters. This can be used to configure where a components animates in from.

flipMove

flipMove: boolean = true

When an element exits, Pose takes it out of the layout and applies position: absolute so it can detect the new position of surrounding elements and animate via FLIP.

While it attempts to figure out the correct matching transform-origin there are times when this fails. Setting flipMove={false} will prevent these issues.

onRest

onRest: Function

When a component finishes exiting, it isn’t removed immediately. Instead, it’s kept in the DOM until all currently leaving components have finished animating out to prevent expensive layout thrashing.

onRest will fire when all exit transitions are complete.

If new exit transitions begin in the meantime, onRest won’t be fired until these have also finished.

…props

All remaining props passed to PoseGroup will be forwarded to its immediate children, for use in dynamic props.

This is useful because if you’re removing a component, it’s impossible in React to update its props without doing a two-pass render.

By providing them to the PoseGroup prop, Pose can pass these to the posed components to change the exit animation:

const Box = posed.div({
  enter: { x: 0 },
  exit: { x: ({ delta }) => - delta * 100 + 'vw' }
});

export default ({ isVisible }) => (
  <PoseGroup delta={1}>
    {isVisible && <Box key="a" />}
  </PoseGroup>
)