feat: Support ReactJS 18, NextJS

- Support ReactJS 18
- Update README and fix tons of things for supporting NextJS
- Change types/interface names
  - `IAnimation` to `Animation`
  - `IStyle` to `Style`
- `page` props is deprecated. This value will be auto-assign, so you don't have to set it.

Author: 1000ship

README.md

@@ -27,47 +27,72 @@ npm install react-scroll-motion
 yarn add react-scroll-motion
 ```
 
-## Code Preview
+## Preview
 
 | PC                                                           | Mobile                                                       |
 | ------------------------------------------------------------ | ------------------------------------------------------------ |
 | <img src="_readme/example-pc.gif" alt="Preview PC" width=434 height=320/> | <img src="_readme/example-mobile.gif" alt="Preview Mobile" width=148 height=320/> |
 
 - [View on deployed example](https://1000ship.github.io/react-scroll-motion/)
+  
+  
+## Import components/functions
+
+### ReactJS
 
 ```jsx
-import { Animator, ScrollContainer, ScrollPage, batch, Fade, FadeIn, Move, MoveIn, MoveOut, Sticky, StickyIn, ZoomIn } from "react-scroll-motion";
+import { Animator, ScrollContainer, ScrollPage, batch, Fade, FadeIn, FadeOut, Move, MoveIn, MoveOut, Sticky, StickyIn, StickyOut, Zoom, ZoomIn, ZoomOut } from "react-scroll-motion";
+```
+
+- Support up to 18 version
+
+### NextJS
+```jsx
+import dynamic from "next/dynamic";
+const Animator = dynamic(
+  import("react-scroll-motion").then((it) => it.Animator),
+  { ssr: false }
+);
+
+
+import { ScrollContainer, ScrollPage, batch, Fade, FadeIn, FadeOut, Move, MoveIn, MoveOut, Sticky, StickyIn, StickyOut, Zoom, ZoomIn, ZoomOut } from "react-scroll-motion";
+```
+- **Check this out especially if you use *NextJS***
+- Please import `Animator` component with `next/dynamic` like upper code, when using NextJS
 
+## Example Code
+```jsx
 const ZoomInScrollOut = batch(StickyIn(), FadeIn(), ZoomIn());
 const FadeUp = batch(Fade(), Move(), Sticky());
 
 <ScrollContainer>
-  <ScrollPage page={0}>
+  <ScrollPage>
     <Animator animation={batch(Fade(), Sticky(), MoveOut(0, -200))}>
       <span style={{ fontSize: "30px" }}>Let me show you scroll animation 😀</span>
     </Animator>
   </ScrollPage>
-  <ScrollPage page={1}>
+  <ScrollPage>
     <Animator animation={ZoomInScrollOut}>
       <span style={{ fontSize: "40px" }}>I'm FadeUpScrollOut ✨</span>
     </Animator>
   </ScrollPage>
-  <ScrollPage page={2}>
+  <ScrollPage>
     <Animator animation={FadeUp}>
       <span style={{ fontSize: "40px" }}>I'm FadeUp ⛅️</span>
     </Animator>
   </ScrollPage>
-  <ScrollPage page={3}>
+  <ScrollPage>
     <div style={{ display: "flex", justifyContent: "center", alignItems: "center", height: "100%" }} >
       <span style={{ fontSize: "40px" }}>
         <Animator animation={MoveIn(-1000, 0)}>Hello Guys 👋🏻</Animator>
-        <Animator animation={MoveIn(1000, 0)}>Nice to meet you 🙋🏻‍♀️</Animator>- I'm Seonghyeok -
+        <Animator animation={MoveIn(1000, 0)}>Nice to meet you 🙋🏻‍♀️</Animator>
+        - I'm Dante Chun -
         <Animator animation={MoveOut(1000, 0)}>Good bye ✋🏻</Animator>
         <Animator animation={MoveOut(-1000, 0)}>See you 💛</Animator>
       </span>
     </div>
   </ScrollPage>
-  <ScrollPage page={4}>
+  <ScrollPage>
     <Animator animation={batch(Fade(), Sticky())}>
       <span style={{ fontSize: "40px" }}>Done</span>
       <br/>
@@ -79,14 +104,72 @@ const FadeUp = batch(Fade(), Move(), Sticky());
 </ScrollContainer>
 ```
 
+## Make custom animation
+
+Let's make spin animation 😉
+
+<img src="_readme/custom-animation.webp" alt="Custom spinning animation" width="400" height="400" />
+
+
+### Javascript
+```jsx
+const Spin = (cycle) =>
+  ({
+    in: {
+      style: {
+        transform: (p) => `rotate(${p * 360 * cycle}deg)`,
+      },
+    },
+    out: {
+      style: {
+        transform: (p) => `rotate(${p * 360 * cycle}deg)`,
+      },
+    },
+  });
+```
+
+
+### Typescript
+```tsx
+import { Animation } from "react-scroll-motion";
+
+const Spin = (cycle: number) =>
+  ({
+    in: {
+      style: {
+        transform: (p) => `rotate(${p * 360 * cycle}deg)`,
+      },
+    },
+    out: {
+      style: {
+        transform: (p) => `rotate(${p * 360 * cycle}deg)`,
+      },
+    },
+  } as Animation);
+```
+
+```jsx
+<ScrollContainer>
+  <ScrollPage>
+    // Your custom animation also can be batched!
+    <Animator animation={batch(Sticky(), Fade(), Spin(3))}>
+      <h1 style={{ fontSize: 50 }}>Hello!!!</h1>
+    </Animator>
+  </ScrollPage>
+  <ScrollPage>
+    ...
+  </ScrollPage>
+</ScrollContainer>
+```
+
 ## Notes & References
 
-- [Simple Docs (BETA)](_readme/docs.md)
+- [Simple Docs](_readme/docs.md)
 - [Update Notes](_readme/update.md)
 
 ## Author
 
-👤 **Seonghyeok Chun**
+👤 **Dante Chun**
 
 * Website: 1000ship.me
 * Github: [@1000ship](https://github.com/1000ship)
@@ -101,8 +184,5 @@ Give a ⭐️ if this project helped you!
 
 ## 📝 License
 
-Copyright © 2021 [Seonghyeok Chun](https://github.com/1000ship).<br />
+Copyright © 2021 [Dante Chun](https://github.com/1000ship).<br />
 This project is [MIT](https://github.com/1000ship/react-scroll-motion/blob/master/LICENSE) licensed.
-
-***
-_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

_readme/custom-animation.webp

@@ -2,13 +2,13 @@
 
 
 
-## Simple Docs
+## Docs
 
 ### Markup Example
 
 ```jsx
 <ScrollContainer snap="mandatory">
-  <ScrollPage page={0}>
+  <ScrollPage>
     <Animator animation={batch(Fade(), Sticky(), MoveOut(0, -200))}>
       <MediumText>Let't me show you scroll animation 😀</MediumText>
     </Animator>
@@ -24,10 +24,6 @@
 
 - `ScrollPage` is `position: relative;` thus, if you want use flexbox, make `div` in `ScrollPage`
 
-- `ScrollPage` has `page` props for integer
-
-  *(Honestly, I don't like this way, is there awesome solution?)*
-
 - `Animator` must be in `ScrollPage`
 
 - `Animator` has `animation` props

_readme/docs.md

@@ -30,3 +30,12 @@
 ## version 0.2.6
 
 - Remove unnecessary files on npm.js publishing
+
+## version 0.3.0
+
+- Support ReactJS 18
+- Update README and fix tons of things for supporting NextJS
+- Change types/interface names
+  - `IAnimation` to `Animation`
+  - `IStyle` to `Style`
+- `page` props is deprecated. This value will be auto-assign, so you don't have to set it.

_readme/update.md

@@ -0,0 +1,6 @@
+{
+  "extends": "next/core-web-vitals",
+  "rules": {
+    "react/no-unescaped-entities": "off"
+  }
+}

examples/.eslintrc.json

@@ -8,16 +8,25 @@
 # testing
 /coverage
 
+# next.js
+/.next/
+/out/
+
 # production
 /build
 
 # misc
 .DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
+*.pem
 
+# debug
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel

examples/.gitignore

@@ -1,46 +1,34 @@
-# Getting Started with Create React App
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+## Getting Started
 
-## Available Scripts
+First, run the development server:
 
-In the project directory, you can run:
+```bash
+npm run dev
+# or
+yarn dev
+```
 
-### `yarn start`
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
 
-### `yarn test`
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `yarn build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+## Learn More
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+To learn more about Next.js, take a look at the following resources:
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
 
-## Learn More
+## Deploy on Vercel
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

examples/README.md

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

examples/next-env.d.ts

@@ -0,0 +1,6 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+}
+
+module.exports = nextConfig

examples/next.config.js

@@ -2,43 +2,22 @@
   "name": "examples",
   "version": "0.1.0",
   "private": true,
-  "dependencies": {
-    "@testing-library/jest-dom": "^5.14.1",
-    "@testing-library/react": "^12.0.0",
-    "@testing-library/user-event": "^13.2.1",
-    "@types/jest": "^27.0.1",
-    "@types/node": "^16.7.13",
-    "@types/react": "^17.0.20",
-    "@types/react-dom": "^17.0.9",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "react-scripts": "5.0.0",
-    "react-scroll-motion": "../",
-    "typescript": "^4.4.2",
-    "web-vitals": "^2.1.0"
-  },
   "scripts": {
-    "start": "react-scripts start",
-    "build": "react-scripts build",
-    "test": "react-scripts test",
-    "eject": "react-scripts eject"
+    "reinstall": "rm yarn.lock && rm -rf node_modules && yarn install",
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
   },
-  "eslintConfig": {
-    "extends": [
-      "react-app",
-      "react-app/jest"
-    ]
+  "dependencies": {
+    "next": "12.1.6",
+    "react": "18.1.0",
+    "react-dom": "18.1.0",
+    "react-scroll-motion": "../"
   },
-  "browserslist": {
-    "production": [
-      ">0.2%",
-      "not dead",
-      "not op_mini all"
-    ],
-    "development": [
-      "last 1 chrome version",
-      "last 1 firefox version",
-      "last 1 safari version"
-    ]
+  "devDependencies": {
+    "@types/node": "^17.0.39",
+    "eslint": "8.17.0",
+    "eslint-config-next": "12.1.6"
   }
 }