{"id":16213573,"url":"https://github.com/mohammad-mghn/nextjs-animate-on-scroll","last_synced_at":"2025-12-24T11:01:41.566Z","repository":{"id":57749125,"uuid":"523408006","full_name":"mohammad-mghn/nextjs-animate-on-scroll","owner":"mohammad-mghn","description":"NPM Package for Next.js framework to animate components on scroll easily.","archived":false,"fork":false,"pushed_at":"2022-08-11T11:10:11.000Z","size":13729,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-03T13:07:22.829Z","etag":null,"topics":["create-react-library","eslint","framer-motion","npm-package","prettier","react","webpack"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mohammad-mghn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-08-10T15:59:25.000Z","updated_at":"2024-10-26T13:18:11.000Z","dependencies_parsed_at":"2022-08-26T13:11:58.013Z","dependency_job_id":null,"html_url":"https://github.com/mohammad-mghn/nextjs-animate-on-scroll","commit_stats":null,"previous_names":["mohammad-mghn/nextjs-animate-on-scroll","vito-mohagheghian/nextjs-animate-on-scroll"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mohammad-mghn/nextjs-animate-on-scroll","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohammad-mghn%2Fnextjs-animate-on-scroll","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohammad-mghn%2Fnextjs-animate-on-scroll/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohammad-mghn%2Fnextjs-animate-on-scroll/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohammad-mghn%2Fnextjs-animate-on-scroll/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mohammad-mghn","download_url":"https://codeload.github.com/mohammad-mghn/nextjs-animate-on-scroll/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohammad-mghn%2Fnextjs-animate-on-scroll/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266204534,"owners_count":23892364,"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":["create-react-library","eslint","framer-motion","npm-package","prettier","react","webpack"],"created_at":"2024-10-10T11:01:29.720Z","updated_at":"2025-12-24T11:01:36.528Z","avatar_url":"https://github.com/mohammad-mghn.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nextjs-animate-on-scroll\n\nNPM Package for Next.js framework to animate components on scroll easily created by [vito.mohagheghian](https://vito.vercel.app).\n\n## \u003cimg src=\"https://slackmojis.com/emojis/11401-among-us-dance/download\" width=\"18\"/\u003e Demo\n\n![Preview](/preview/preview.gif)\n\n\u003e [Live Demo](https://google/com)\n\n## \u003cimg src=\"https://slackmojis.com/emojis/12349-among_us_pet/download\" width=\"20\"/\u003e Installation\n\n```bash\n# npm \nnpm install nextjs-animate-on-scroll \n\n# yarn \nyarn add nextjs-animate-on-scroll\n```\n\n## \u003cimg src=\"https://slackmojis.com/emojis/11386-among_us_orange_dance/download\" width=\"20\"/\u003e Usage\n\n```jsx\nimport React from 'react'\n\nimport Animator, { AnimateProvider } from 'nextjs-animate-on-scroll'\n\nconst App = () =\u003e {\n  return (\n    \u003cAnimateProvider\u003e\n      \u003cdiv\n        style={{\n          height: '800vh',\n          display: 'grid',\n          placeItems: 'center',\n          backgroundColor: '#2E2E2E'\n        }}\n      \u003e\n        \u003cAnimator\n          amountDisplay={0.5}\n          UNKey={'example'}\n          initial={{ scale: 1.2, opacity: 0 }}\n          onScreen={{ scale: 1, opacity: 1 }}\n        \u003e\n          {/* your component */}\n        \u003c/Animator\u003e\n      \u003c/div\u003e\n    \u003c/AnimateProvider\u003e\n  )\n}\n\nexport default App\n```\n\n### AnimateProvider\n\n\u003e For using AnimateProvider in the app you have put it in a way that Animator be its child, no matter using that in _app, or other components.\n\n### Animator\n\n\u003e For using Animator in the app you have to wrap elements that want to become animated.\n\n### Animator Props\n\n| Name                | Type       | Default Value | Required? | Description                                            |\n| ------------------- | ---------- | ------------- | --------- | ------------------------------------------------------ |\n| initial           | `Obejsct`  | `undefined`   | Yes | Initial styles of wrapped component                      |\n| onScreen               | `Object`   | `undefined`    | Yes | Styles of component when becomed in view |\n| UNKey          | -  | 1         | Yes | like key prop                      |\n| amountDisplay       | `Number` | 0.25     | No | The amount of element should become in view to run animation                       |\n| bounce | `Number` | 0.5     | No | the amount bounce from 0 to 1                                   |\n\n## \u003cimg src=\"https://slackmojis.com/emojis/10512-amongus/download\" width=\"20\"/\u003e License\n\nMIT © [vito-mohagheghian](https://github.com/vito-mohagheghian)\n\n\u003cp\u003e\u003ca href=\"https://github.com/vito-mohagheghian\" target=\"_blank\"\u003e\u003cimg alt=\"Github\" src=\"https://img.shields.io/badge/GitHub-DD0031?\u0026style=for-the-badge\u0026logo=Github\u0026logoColor=white\" /\u003e\u003c/a\u003e \u003ca href=\"https://twitter.com/hereisvito\" target=\"_blank\"\u003e\u003cimg alt=\"Twitter\" src=\"https://img.shields.io/badge/twitter-%231DA1F2.svg?\u0026style=for-the-badge\u0026logo=twitter\u0026logoColor=white\" /\u003e\u003c/a\u003e \u003ca href=\"https://www.linkedin.com/in/mohammad-mohagheghian-5a8160214/\" target=\"_blank\"\u003e\u003cimg alt=\"LinkedIn\" src=\"https://img.shields.io/badge/linkedin-FB542B?\u0026style=for-the-badge\u0026logo=linkedin\u0026logoColor=white\" /\u003e\u003c/a\u003e \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohammad-mghn%2Fnextjs-animate-on-scroll","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmohammad-mghn%2Fnextjs-animate-on-scroll","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohammad-mghn%2Fnextjs-animate-on-scroll/lists"}