React components for easily implementing basic CSS animations and transitions
npm install react-transitioning
A simple React library that provides components for managing animations and transitions with ease. It allows seamless transitions for both individual components and groups of elements. The library is inspired by react-transition-group and shares a similar API with a few notable differences.
- Ease of Use: Simple and intuitive API for creating animations and transitions for both components and groups of elements.
- Modern Approach: Built with functional components and hooks, avoiding deprecated methods like findDOMNode.
- No External Dependencies: No additional dependencies, keeping your project lightweight and reducing potential conflicts.
- No nodeRef Required: Unlike react-transition-group, there's no need to pass a nodeRef prop.
- Flexibility: Supports both CSS-based and inline style-based animations.
- Lightweight: Minimal bundle size to keep your application fast.
The library provides components that allow you to easily create custom components with animations and transitions tailored to your needs. You can integrate them into your own React components to add smooth animations and transitions with minimal effort.
``tsx`
Fading element
To install the library, run:
`bash`
npm install react-transitioningor
yarn add react-transitioning
For more detailed information and usage examples, check out the Docs.
The Transition component allows you to control the mounting and unmounting of an element with transitions.
`tsx
import { Transition } from 'react-transitioning'
...
{(transitionState) => (
{JSON.stringify(transitionState)}
)}
`
The CSSTransition component applies CSS classes based on the current transition state.
`tsx
import { CSSTransition } from 'react-transitioning'
...
Animated element
`
The StyleTransition component applies inline styles based on the current transition state. This is useful for customizing transitions without needing to rely on external CSS.
`tsx
import { StyleTransition } from 'react-transitioning'
...
duration={300}
styles={{
enter: { opacity: 0 },
enterActive: { opacity: 1 },
}}
>
$3
The
component handles a set of elements, animating them as they are added or removed from the DOM.`tsx
import { TransitionGroup } from 'react-transitioning'...
{items.map((item) => (
{item.label}
))}
`$3
tsx
classNames="fade"
addEndListener={(phase, done) => {
nodeRef.current.addEventListener('transitionend', done, { once: true, capture: false })
}}
>
Animated element
`
API
$3
ts
type TransitionProps = {
children: React.ReactNode | ((transitionState: TransitionState, activePhase: TransitionPhase) => React.ReactNode);
in?: boolean;
appear?: boolean;
enter?: boolean;
exit?: boolean;
duration?: number;
alwaysMounted?: boolean;
addEndListener?: (phase: TransitionPhase, done: () => void) => void;
onEnter: () => void;
onEntering: () => void;
onEntered: () => void;
onExit: () => void;
onExiting: () => void;
onExited: () => void;
}
`The
passed to the children function has the following structure:`ts
type TransitionState = {
appear: boolean;
appearActive: boolean;
appearDone: boolean;
enter: boolean;
enterActive: boolean;
enterDone: boolean;
exit: boolean;
exitActive: boolean;
exitDone: boolean;
}
`$3
ts
type CSSTransitionProps = Omit & {
children: React.ReactElement<{ className?: string }>
classNames: string | {
appear?: string;
appearActive?: string;
appearDone?: string;
enter?: string;
enterActive?: string;
enterDone?: string;
exit?: string;
exitActive?: string;
exitDone?: string;
}
}
`if
is a string, then the computed className will be suffixed based on the current transition state.
For example, when classNames is "fade", the fade-appear-active class will be applied during the appearActive phase.If
classNames is an object, the final className will be taken from that object based on the current transition state.$3
`ts
type StyleTransitionProps = Omit & {
children: React.ReactElement<{ style?: React.CSSProperties };
styles: {
appear?: object;
appearActive?: object;
appearDone?: object;
enter?: object;
enterActive?: object;
enterDone?: object;
exit?: object;
exitActive?: object;
exitDone?: object;
}
}
`The
prop allows you to define inline styles based on the current transition state. For example, when the element enters, the enterActive styles will be applied.$3
`ts
type TransitionGroupProps = {
children: React.ReactNode;
appear?: boolean;
enter?: boolean;
exit?: boolean;
duration?: number;
}
``MIT