MCPcopy
hub / github.com/jscottsmith/react-scroll-parallax

github.com/jscottsmith/react-scroll-parallax @v3.5.0 sqlite

repository ↗ · DeepWiki ↗ · release v3.5.0 ↗
99 symbols 239 edges 79 files 0 documented · 0%
README

React Scroll Parallax

NPM Version Latest NPM Downloads Codecov

Test and Lint Storybook Storybook

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:

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

;
}

or with a component:

function Component() {
  return (
    <Parallax speed={-10}>



    </Parallax>
  );
}

Getting Started

Read the documentation for setup and usage instructions.

Demos

Docs: Hooks

Docs: Components

Extension points exported contracts — how you extend this code

ParallaxProps (Interface)
(no doc)
src/components/Parallax/types.ts
MockProviderProps (Interface)
(no doc)
src/testUtils/MockProvider.tsx
ParallaxProviderProps (Interface)
(no doc)
src/components/ParallaxProvider/types.ts
BannerLayer (Interface)
(no doc)
src/components/ParallaxBanner/types.ts
ParallaxBannerProps (Interface)
(no doc)
src/components/ParallaxBanner/types.ts

Core symbols most depended-on inside this repo

useParallax
called by 15
src/hooks/useParallax.ts
useParallaxController
called by 12
src/hooks/useParallaxController.ts
render
called by 4
src/testUtils/MockProvider.tsx
getIsolatedParallaxProps
called by 3
src/helpers/getIsolatedParallaxProps.ts
getExpandedStyle
called by 2
src/components/ParallaxBanner/helpers/getExpandedStyle.ts
useUpdateControllerOnRouteChange
called by 1
documentation/src/components/parallax-route-update/index.tsx
useVerifyController
called by 1
src/components/Parallax/hooks.ts
createController
called by 1
src/components/ParallaxProvider/helpers.ts

Shape

Function 89
Interface 5
Method 3
Class 2

Languages

TypeScript100%

Modules by API surface

stories/Parallax/1_ParallaxVertical.stories.tsx11 symbols
stories/ParallaxBanner/4_ParallaxBanner.stories.tsx10 symbols
stories/Parallax/2_ParallaxHorizontal.stories.tsx6 symbols
src/testUtils/MockProvider.tsx6 symbols
src/components/ParallaxProvider/index.test.tsx6 symbols
src/components/ParallaxBanner/ParallaxBanner.tsx3 symbols
stories/useParallax/useParallax.stories.tsx2 symbols
stories/Parallax/7_ParallaxEasing.stories.tsx2 symbols
stories/Image/Image.tsx2 symbols
src/components/ParallaxBanner/types.ts2 symbols
src/components/Parallax/index.test.tsx2 symbols
documentation/src/components/parallax-route-update/index.tsx2 symbols

Used by 1 indexed graphs manifest dependencies, hub-wide

Dependencies from manifests, versioned

@docusaurus/core3.9.1 · 1×
@docusaurus/plugin-google-analytics3.9.1 · 1×
@docusaurus/preset-classic3.9.1 · 1×
@docusaurus/tsconfig3.9.1 · 1×
@eslint/js9.36.0 · 1×
@mdx-js/react3.0.0 · 1×
@size-limit/preset-small-lib6.0.4 · 1×
@storybook/addon-docs9.1.8 · 1×
@storybook/addon-links9.1.8 · 1×
@storybook/preset-scss1.0.3 · 1×
@storybook/react9.1.8 · 1×
@storybook/react-vite9.1.8 · 1×

For agents

$ claude mcp add react-scroll-parallax \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact