animationOpacity
Description
If true, the opacity of the content will be animated.
Type
booleanDefault
trueCollapse
Collapse is a component that allows you to expand or collapse an element for display.
Props
CollapseProps
as
Description
The HTML element to render.
Type
"symbol" | "object" | "clipPath" | "filter" | "g" | "marker" | "mask" | "p" | "text" | "style" | "animate" | "button" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | ... 149 more ... | "textPath"colorScheme
Description
The visual color appearance of the component.
Type
"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"delay
Description
Custom delay definition for enter and exit.
Type
number | MotionLifecycleProps<number>duration
Description
Custom duration definition for enter and exit.
Type
number | MotionLifecycleProps<number>endingHeight
Description
The height you want the content in its expanded state.
Type
string | numberDefault
autoenter
Description
Custom enter.
Type
anyexit
Description
Custom exit.
A target to animate to when this component is removed from the tree.
This component **must** be the first animatable child of an AnimatePresence to enable this exit animation.
This limitation exists because React doesn't allow components to defer unmounting until after
an animation is complete. Once this limitation is fixed, the AnimatePresence component will be unnecessary.
``jsx
import { AnimatePresence, motion } from 'framer-motion'
export const MyComponent = ({ isVisible }) => {
return (
<AnimatePresence>
{isVisible && (
<motion.div
initial={{ opacity: 0 }}
animate={{ opacity: 1 }}
exit={{ opacity: 0 }}
/>
)}
</AnimatePresence>
)
}
``
Type
anyinitial
Description
Custom initial.
Properties, variant label or array of variant labels to start in.
Set to false to initialise with the values in animate (disabling the mount animation)
``jsx
// As values
<motion.div initial={{ opacity: 1 }} />
// As variant
<motion.div initial="visible" variants={variants} />
// Multiple variants
<motion.div initial={["visible", "active"]} variants={variants} />
// As false (disable mount animation)
<motion.div initial={false} animate={{ opacity: 0 }} />
``
Type
anyisOpen
DeprecatedDescription
Show the component. triggers when enter or exit states.
Deprecated
Use open instead.
Type
booleanopen
Description
Show the component. triggers when enter or exit states.
Type
booleansize
Description
The size of the Collapse.
Type
stringstartingHeight
Description
The height you want the content in its collapsed state.
Type
string | numberDefault
0transition
Description
Custom transition definition for enter and exit.
Type
MotionLifecycleProps<Transition$1>transitionEnd
Description
Custom transitionEnd definition for enter and exit.
Type
MotionLifecycleProps<MakeCustomValueType<TargetProperties>>unmountOnExit
Description
If true, the element will unmount when isOpen={false} and animation is done.
Type
booleanvariant
Description
The variant of the Collapse.
Type
stringEdit this page on GitHub