npm explorer

react-scroll-parallax

v3.0.0-beta.15TypeScriptDeprecated
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

React hooks and components to create parallax scroll effects for banners, images or any other DOM elements.

reactscrolleffectsparallaxbanneranimationhookscomponent
0/weekUpdated 4 months agoMITUnpacked: 187.9 KB
Published by J Scott Smith
npm install react-scroll-parallax
RepositoryHomepagenpm

React Scroll Parallax

![NPM Version Latest](https://www.npmjs.com/package/react-scroll-parallax)
![NPM Downloads](https://www.npmjs.com/package/react-scroll-parallax)
![Codecov](https://codecov.io/gh/jscottsmith/react-scroll-parallax)

![Test and Lint](https://github.com/jscottsmith/react-scroll-parallax/actions/workflows/main.yml)
![Storybook](https://github.com/jscottsmith/react-scroll-parallax/actions/workflows/surge.yml)
![Storybook](https://github.com/jscottsmith/react-scroll-parallax/actions/workflows/coverage.yml)

React hooks and components to create parallax scroll effects for banners, images or any other DOM elements. Utilizes Parallax Controller to add vertical or horizontal scrolling based effects to elements. Optimized to _reduce_ jank on scroll and works with SSR and SSG rendered React apps.

If you're coming from V2, here's a migration guide.

Install

With npm

``
npm install react-scroll-parallax
`

or pnpm

`
pnpm add react-scroll-parallax
`

Example

Create effects with a hook:

`jsx
function Component() {
const parallax = useParallax({
speed: -10,
});
return

;
}
`

or with a component:

`jsx
function Component() {
return (



);
}
`

Getting Started

Read the documentation for setup and usage instructions.

- Usage
- Usage with NextJS 13
- How it works

$3

- Storybook v3 - Source Code
- Demo 1 - Source Code
- Demo 2 - Source Code (old 2.x version)

$3

- useParallax()
-
useParallaxController()

$3

-
-

-
`

react-scroll-parallax - npm explorer

Dist Tags

next2.0.0-beta.5
alpha3.0.0-beta.3
beta3.0.0-beta.15
latest3.5.0