{"id":13469725,"url":"https://github.com/jscottsmith/react-scroll-parallax","last_synced_at":"2025-05-12T13:16:02.724Z","repository":{"id":38870625,"uuid":"84919676","full_name":"jscottsmith/react-scroll-parallax","owner":"jscottsmith","description":"🔮  React hooks and components to create parallax scroll effects for banners, images or any other DOM elements.","archived":false,"fork":false,"pushed_at":"2025-04-29T02:12:43.000Z","size":9299,"stargazers_count":2931,"open_issues_count":14,"forks_count":157,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-05-12T13:15:49.577Z","etag":null,"topics":["animation","banner","component","effects","hooks","parallax","react","scroll"],"latest_commit_sha":null,"homepage":"https://react-scroll-parallax.damnthat.tv/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jscottsmith.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-03-14T07:38:20.000Z","updated_at":"2025-05-09T00:16:02.000Z","dependencies_parsed_at":"2022-07-12T17:39:52.888Z","dependency_job_id":"9028a7de-c649-4585-aacc-5250c41a422a","html_url":"https://github.com/jscottsmith/react-scroll-parallax","commit_stats":{"total_commits":679,"total_committers":13,"mean_commits":52.23076923076923,"dds":0.08247422680412375,"last_synced_commit":"a6b7bff8e1b021573b90fa7b1b7984644af25cf9"},"previous_names":[],"tags_count":113,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jscottsmith%2Freact-scroll-parallax","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jscottsmith%2Freact-scroll-parallax/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jscottsmith%2Freact-scroll-parallax/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jscottsmith%2Freact-scroll-parallax/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jscottsmith","download_url":"https://codeload.github.com/jscottsmith/react-scroll-parallax/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253745196,"owners_count":21957319,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["animation","banner","component","effects","hooks","parallax","react","scroll"],"created_at":"2024-07-31T15:01:52.971Z","updated_at":"2025-05-12T13:16:02.381Z","avatar_url":"https://github.com/jscottsmith.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","Table of Contents","🌐 Web Development - Frontend"],"sub_categories":["Scroll Animation Libraries"],"readme":"\u003ca href=\"https://react-scroll-parallax.damnthat.tv/\"\u003e\u003cimg src=\"https://react-scroll-parallax.damnthat.tv/img/logo.png\" style=\"width:96px;height:auto;\"\u003e\u003c/a\u003e\n\n# React Scroll Parallax\n\n[![NPM Version Latest](https://img.shields.io/npm/v/react-scroll-parallax/latest)](https://www.npmjs.com/package/react-scroll-parallax)\n[![NPM Downloads](https://img.shields.io/npm/dm/react-scroll-parallax)](https://www.npmjs.com/package/react-scroll-parallax)\n[![Codecov](https://codecov.io/gh/jscottsmith/react-scroll-parallax/branch/v3/graph/badge.svg)](https://codecov.io/gh/jscottsmith/react-scroll-parallax)\n[![Rate on Openbase](https://badges.openbase.com/js/rating/react-scroll-parallax.svg)](https://openbase.com/js/react-scroll-parallax?utm_source=embedded\u0026utm_medium=badge\u0026utm_campaign=rate-badge)\n\n[![Test and Lint](https://github.com/jscottsmith/react-scroll-parallax/actions/workflows/main.yml/badge.svg)](https://github.com/jscottsmith/react-scroll-parallax/actions/workflows/main.yml)\n[![Storybook](https://github.com/jscottsmith/react-scroll-parallax/actions/workflows/surge.yml/badge.svg)](https://github.com/jscottsmith/react-scroll-parallax/actions/workflows/surge.yml)\n[![Storybook](https://github.com/jscottsmith/react-scroll-parallax/actions/workflows/coverage.yml/badge.svg)](https://github.com/jscottsmith/react-scroll-parallax/actions/workflows/coverage.yml)\n\nReact hooks and components to create parallax scroll effects for banners, images or any other DOM elements. Utilizes [Parallax Controller](https://parallax-controller.v1.damnthat.tv) to add vertical or horizontal scrolling based effects to elements. [Optimized](https://parallax-controller.v1.damnthat.tv/docs/performance) to _reduce_ jank on scroll and works with SSR and SSG rendered React apps.\n\nIf you're coming from [V2](https://github.com/jscottsmith/react-scroll-parallax/tree/v2), here's a [migration guide](https://react-scroll-parallax.damnthat.tv/docs/migration-guides/v2-migration-guide).\n\n## Install\n\nWith npm\n\n```\nnpm install react-scroll-parallax\n```\n\nor yarn\n\n```\nyarn add react-scroll-parallax\n```\n\n## Example\n\n[Create effects](https://react-scroll-parallax.damnthat.tv/docs/examples/how-it-works) with a hook:\n\n```jsx\nfunction Component() {\n  const parallax = useParallax({\n    speed: -10,\n  });\n  return \u003cdiv ref={parallax.ref} /\u003e;\n}\n```\n\nor with a component:\n\n```jsx\nfunction Component() {\n  return (\n    \u003cParallax speed={-10}\u003e\n      \u003cdiv /\u003e\n    \u003c/Parallax\u003e\n  );\n}\n```\n\n## Getting Started\n\nRead the [documentation](https://react-scroll-parallax.damnthat.tv/) for setup and usage instructions.\n\n- [Usage](https://react-scroll-parallax.damnthat.tv/docs/usage/)\n- [Usage with NextJS 13](https://react-scroll-parallax.damnthat.tv/docs/usage/next-13)\n- [How it works](https://react-scroll-parallax.damnthat.tv/docs/examples/how-it-works)\n\n### Demos\n\n- [Storybook v3](https://react-scroll-parallax-v3.surge.sh/) - [Source Code](https://github.com/jscottsmith/react-scroll-parallax/tree/v3/stories)\n- [Demo 1](https://react-scroll-parallax-examples.vercel.app/) - [Source Code](https://github.com/jscottsmith/react-scroll-parallax-examples)\n- [Demo 2](https://react-scroll-parallax.netlify.app/) - [Source Code (old 2.x version)](https://github.com/jscottsmith/react-parallax-site)\n\n### Docs: Hooks\n\n- [`useParallax()`](https://react-scroll-parallax.damnthat.tv/docs/usage/hooks/use-parallax)\n- [`useParallaxController()`](https://react-scroll-parallax.damnthat.tv/docs/usage/hooks/use-parallax-controller)\n\n### Docs: Components\n\n- [`\u003cParallax\u003e`](https://react-scroll-parallax.damnthat.tv/docs/usage/components/parallax-component)\n- [`\u003cParallaxBanner\u003e`](https://react-scroll-parallax.damnthat.tv/docs/usage/components/parallax-banner-component)\n- [`\u003cParallaxProvider\u003e`](https://react-scroll-parallax.damnthat.tv/docs/usage/components/parallax-provider)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjscottsmith%2Freact-scroll-parallax","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjscottsmith%2Freact-scroll-parallax","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjscottsmith%2Freact-scroll-parallax/lists"}