IMPORTANT: This project doesn't support newer versions of React or React Router and is for now considered abandoned. Please see: #33
⚛️💨 A React component that makes it easy to use the page transitions from the Codedrops Page Transitions Demo See Original.
npm install @steveeeie/react-page-transition
or
yarn add @steveeeie/react-page-transition
npm install react-router react-router-dom react-transition-group styled-components
or
yarn add react-router react-router-dom react-transition-group styled-components
import React from 'react';
import { BrowserRouter, Switch, Route, Link } from 'react-router-dom';
import { PageTransition } from '@steveeeie/react-page-transition';
import './styles.css';
const Links = () => (
<>
<Link to="/">Home</Link>
<Link to="/about">About</Link>
</>
);
const Home = props => <h1>Home</h1>;
const About = props => <h1>About</h1>;
export default function App() {
return (
<BrowserRouter>
<Links />
<Route
render={({ location }) => {
return (
<PageTransition
preset="moveToLeftFromRight"
transitionKey={location.pathname}
>
<Switch location={location}>
<Route exact path="/" component={Home} />
<Route exact path="/about" component={About} />
</Switch>
</PageTransition>
);
}}
/>
</BrowserRouter>
);
}
Wrap your routes inside the PageTransition
component and pass one of the preset names to the preset
prop. View the advanced demo for the full list of presets.
You will also need to pass the current location.path
to the transitionKey
prop, this is so that the internal TransitionGroup
can track which components are entering and exiting.
html,
body,
#root {
height: 100%;
}
PageTransition
is styled with height: 100%
. The parent containers need to be given a height for it to render correctly because of this.
Prop | Required | Type | Description |
---|---|---|---|
preset |
No | String | Sets the enter and exit animations * |
enterAnimation |
No | String | Sets the enter animation * |
exitAnimation |
No | String | Sets the exit animation * |
transitionKey |
Yes | Unique Identifier | Used internally to track which components are entering and exiting. |