page-transition 0.1.0-beta.1 → 0.1.0-beta.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # page-transition
2
- A page transition library for the Next.js App Router.
2
+ A page transition library for the Next.js App Router.
3
+
4
+ [🌐 Live Demo](https://simon-schindler.github.io/page-transition-demo/)
3
5
 
4
6
  ## Features
5
7
 
@@ -8,11 +10,7 @@ A page transition library for the Next.js App Router.
8
10
 
9
11
  ## Install
10
12
 
11
- Copy page-transition-0.1.0-beta.1.tgz into the root directory of your Next.js project.
12
-
13
- Install the package using npm:
14
-
15
- `npm install ./page-transition-0.1.0-beta.1.tgz`
13
+ `npm install page-transition@beta`
16
14
 
17
15
  ## Usage
18
16
  Import your page transition styles and wrap your page content with `TransitionProvider` in your root layout.
@@ -82,9 +80,16 @@ options={{
82
80
  ### `TransitionLink`
83
81
  #### Props
84
82
 
85
- |Prop|type|default|
86
- |---|---|---|
87
- | href | string | - |
83
+ |Prop|Type|Default|Required
84
+ |---|---|---|---|
85
+ | href | string | - | Yes |
86
+ | className | string | - | - |
87
+ | scroll | boolean | true | - |
88
+ | prefetch | "auto" \| null | null | - |
89
+ | onClick | (e: React.MouseEvent)=>void | - | - |
90
+
91
+ **Prop Descriptions**
92
+ TransitionLink uses the Next.js Link component internally. For details about navigation behavior and supported props, refer to the official Next.js documentation.
88
93
 
89
94
  **Description**
90
95
  Triggers the transition.
@@ -200,10 +205,10 @@ overlayCount: 10
200
205
  background: black;
201
206
  transition: none;
202
207
  will-change: clip-path;
203
- clip-path: inset(100% 0 0 0);
208
+ clip-path: inset(100% -1px 0 -1px);
204
209
  }
205
210
  [data-transition].exit .overlay-item{
206
- clip-path: inset(0 0 0 0);
211
+ clip-path: inset(0 -1px 0 -1px);
207
212
  transition: clip-path 1.0s ease;
208
213
  @for $i from 0 to 10{
209
214
  &:nth-child(#{$i+1}){
@@ -212,7 +217,7 @@ overlayCount: 10
212
217
  }
213
218
  }
214
219
  [data-transition].enter .overlay-item{
215
- clip-path: inset(0 0 100% 0);
220
+ clip-path: inset(0 -1px 100% -1px);
216
221
  transition: clip-path 1.0s ease;
217
222
  @for $i from 0 to 10{
218
223
  &:nth-child(#{$i+1}){
@@ -1,5 +1,10 @@
1
1
  import type { ReactNode } from "react";
2
- export declare function TransitionLink({ href, children }: {
2
+ interface Props {
3
3
  href: string;
4
+ className?: string;
5
+ prefetch?: boolean;
6
+ onClick?: (e: React.MouseEvent) => void;
4
7
  children: ReactNode;
5
- }): import("react").JSX.Element;
8
+ }
9
+ export declare function TransitionLink({ href, className, prefetch, onClick, children }: Props): import("react").JSX.Element;
10
+ export {};
@@ -1,9 +1,10 @@
1
1
  import { jsx as _jsx } from "react/jsx-runtime";
2
2
  import Link from "next/link";
3
3
  import { useTransitionContext } from "../context/TransitionContext";
4
- export function TransitionLink({ href, children }) {
4
+ export function TransitionLink({ href, className, prefetch, onClick, children }) {
5
5
  const { handleLinkClick } = useTransitionContext();
6
6
  return (_jsx(Link, { href: href, onClick: (e) => {
7
7
  handleLinkClick.current(e, href);
8
- }, children: children }));
8
+ onClick?.(e);
9
+ }, className: className, prefetch: prefetch, children: children }));
9
10
  }
@@ -1,7 +1,7 @@
1
1
  import type { ReactNode } from "react";
2
2
  interface TransitionOptions {
3
- transitionProperty: 'opacity' | 'clip-path';
4
- overlayCount: number;
3
+ transitionProperty?: 'opacity' | 'clip-path';
4
+ overlayCount?: number;
5
5
  }
6
6
  interface ProviderProps {
7
7
  header?: ReactNode;
@@ -11,10 +11,13 @@ import { useHandleLinkClick } from "../hooks/useHandleLinkClick";
11
11
  import { useScrollRestoration } from "../hooks/useScrollRestoration";
12
12
  import { usePopState } from "../hooks/usePopState";
13
13
  import { parseDelay } from "../functions/parseDelay";
14
- export function CssTransitionProvider({ header, options = {
15
- transitionProperty: 'opacity',
16
- overlayCount: 0
17
- }, children }) {
14
+ import { pollTransitionStart } from "../functions/pollTransitionStart";
15
+ export function CssTransitionProvider({ header, options, children }) {
16
+ const defaultOptions = {
17
+ transitionProperty: 'opacity',
18
+ overlayCount: 0,
19
+ ...options
20
+ };
18
21
  const container = useRef(null);
19
22
  const overlayWrapper = useRef(null);
20
23
  const overlayItems = useRef([]);
@@ -25,7 +28,8 @@ export function CssTransitionProvider({ header, options = {
25
28
  initPathname: pathname
26
29
  });
27
30
  const state = useRef('idle');
28
- const popRun = useRef(false);
31
+ const useUse = useRef(false);
32
+ const resolveUseFn = useRef(null);
29
33
  const reverse = useRef({
30
34
  _lock: true,
31
35
  get lock() {
@@ -44,9 +48,10 @@ export function CssTransitionProvider({ header, options = {
44
48
  const handleLinkClick = useRef(() => { });
45
49
  const transitionEndHandler = useTransitionEndHandler();
46
50
  const transitionEndData = useTransitionEndData({
47
- elArray: options.overlayCount === 0 ? container : overlayItems,
48
- transitionProperty: options.transitionProperty
51
+ elArray: defaultOptions.overlayCount === 0 ? container : overlayItems,
52
+ transitionProperty: defaultOptions.transitionProperty
49
53
  });
54
+ const pollRafId = useRef(null);
50
55
  usePopState({
51
56
  container,
52
57
  currentPathname,
@@ -55,7 +60,8 @@ export function CssTransitionProvider({ header, options = {
55
60
  state,
56
61
  reverse,
57
62
  delay,
58
- popRun
63
+ useUse,
64
+ resolveUseFn
59
65
  });
60
66
  useHandleLinkClick({
61
67
  container,
@@ -66,7 +72,8 @@ export function CssTransitionProvider({ header, options = {
66
72
  state,
67
73
  reverse,
68
74
  delay,
69
- popRun
75
+ useUse,
76
+ resolveUseFn
70
77
  });
71
78
  useScrollRestoration();
72
79
  const removeEnter = useTransitionEndObj({
@@ -96,12 +103,18 @@ export function CssTransitionProvider({ header, options = {
96
103
  });
97
104
  container.current.classList.remove('exit');
98
105
  container.current.classList.add('enter');
106
+ pollTransitionStart({
107
+ transitionEndData,
108
+ id: pollRafId,
109
+ fn: () => {
110
+ state.current = 'entering';
111
+ }
112
+ });
99
113
  currentPathname.current = pathname;
100
- state.current = 'entering';
101
114
  reverse.current.lock = false;
102
115
  }, [pathname]);
103
116
  const value = useMemo(() => ({ handleLinkClick, overlayWrapper, overlayItems }), []);
104
- return (_jsxs(TransitionContext.Provider, { value: value, children: [header, _jsxs("div", { ref: container, "data-transition": true, children: [_jsx("div", { ref: overlayWrapper, className: "overlay-wrapper", children: Array.from({ length: options.overlayCount }).map((_, i) => (_jsx("div", { ref: (el) => {
117
+ return (_jsxs(TransitionContext.Provider, { value: value, children: [header, _jsxs("div", { ref: container, "data-transition": true, children: [_jsx("div", { ref: overlayWrapper, className: "overlay-wrapper", children: Array.from({ length: defaultOptions.overlayCount }).map((_, i) => (_jsx("div", { ref: (el) => {
105
118
  overlayItems.current[i] = el;
106
119
  }, className: "overlay-item" }, i))) }), children] })] }));
107
120
  }
@@ -10,17 +10,20 @@ export function ManualTransitionProvider({ children }) {
10
10
  const handleLinkClick = useRef(() => { });
11
11
  const resolveFn = useRef(null);
12
12
  const state = useRef('idle');
13
- const popRun = useRef(false);
13
+ const useUse = useRef(false);
14
+ const resolveUseFn = useRef(null);
14
15
  usePopState({
15
16
  resolveFn,
16
17
  state,
17
- popRun
18
+ useUse,
19
+ resolveUseFn
18
20
  });
19
21
  useHandleLinkClick({
20
22
  handleLinkClick,
21
23
  resolveFn,
22
24
  state,
23
- popRun
25
+ useUse,
26
+ resolveUseFn
24
27
  });
25
28
  useEffect(() => {
26
29
  state.current = 'entering';
@@ -11,8 +11,8 @@ export declare function useTransitionContext(): ContextProps;
11
11
  type Mode = 'css' | 'manual';
12
12
  type TransitionProperty = 'opacity' | 'clip-path';
13
13
  interface TransitionOptions {
14
- transitionProperty: TransitionProperty;
15
- overlayCount: number;
14
+ transitionProperty?: TransitionProperty;
15
+ overlayCount?: number;
16
16
  }
17
17
  interface ProviderProps {
18
18
  header?: ReactNode;
@@ -10,10 +10,7 @@ export function useTransitionContext() {
10
10
  throw new Error('useTransitionContext in Provider!');
11
11
  return context;
12
12
  }
13
- export function TransitionProvider({ header, mode = 'css', options = {
14
- transitionProperty: 'opacity',
15
- overlayCount: 0
16
- }, children, }) {
13
+ export function TransitionProvider({ header, mode = 'css', options, children, }) {
17
14
  return (mode === 'css' ?
18
15
  _jsx(CssTransitionProvider, { header: header, options: options, children: children }) :
19
16
  _jsx(ManualTransitionProvider, { children: children }));
@@ -0,0 +1,6 @@
1
+ interface TransitionEndData {
2
+ elArray: (HTMLDivElement | null)[];
3
+ propertyName: 'opacity' | 'clip-path';
4
+ }
5
+ export declare function checkTransitionStart(transitionEndData: TransitionEndData, fn: (() => void) | null): boolean;
6
+ export {};
@@ -0,0 +1,15 @@
1
+ import { parseOpacityAll } from "./parseOpacityAll";
2
+ import { parseClipPathAll } from "./parseClipPathAll";
3
+ export function checkTransitionStart(transitionEndData, fn) {
4
+ const parse = {
5
+ 'opacity': () => parseOpacityAll(transitionEndData.elArray),
6
+ 'clip-path': () => parseClipPathAll(transitionEndData.elArray)
7
+ };
8
+ if (parse[transitionEndData.propertyName]()) {
9
+ return false;
10
+ }
11
+ else {
12
+ fn?.();
13
+ return true;
14
+ }
15
+ }
@@ -0,0 +1,12 @@
1
+ import type { RefObject } from "react";
2
+ interface TransitionEndData {
3
+ elArray: (HTMLDivElement | null)[];
4
+ propertyName: 'opacity' | 'clip-path';
5
+ }
6
+ interface Props {
7
+ id: RefObject<number | null>;
8
+ fn: () => void;
9
+ transitionEndData: RefObject<TransitionEndData>;
10
+ }
11
+ export declare function pollTransitionStart({ id, fn, transitionEndData }: Props): void;
12
+ export {};
@@ -0,0 +1,9 @@
1
+ import { checkTransitionStart } from "./checkTransitionStart";
2
+ export function pollTransitionStart({ id, fn, transitionEndData }) {
3
+ id.current = requestAnimationFrame(() => {
4
+ if (checkTransitionStart(transitionEndData.current, fn)) {
5
+ return;
6
+ }
7
+ pollTransitionStart({ id, fn, transitionEndData });
8
+ });
9
+ }
@@ -3,7 +3,8 @@ interface Props {
3
3
  handleLinkClick: RefObject<((e: React.MouseEvent, url: string) => void)>;
4
4
  resolveFn: RefObject<(() => void) | null>;
5
5
  state: RefObject<'idle' | 'exiting' | 'entering'>;
6
- popRun: RefObject<boolean>;
6
+ useUse: RefObject<boolean>;
7
+ resolveUseFn: RefObject<(() => void) | null>;
7
8
  }
8
- export declare function useHandleLinkClick({ handleLinkClick, resolveFn, state, popRun }: Props): void;
9
+ export declare function useHandleLinkClick({ handleLinkClick, resolveFn, state, useUse, resolveUseFn }: Props): void;
9
10
  export {};
@@ -1,16 +1,16 @@
1
1
  "use client";
2
2
  import { useCallback } from "react";
3
3
  import { useRouter } from "next/navigation";
4
- export function useHandleLinkClick({ handleLinkClick, resolveFn, state, popRun }) {
4
+ export function useHandleLinkClick({ handleLinkClick, resolveFn, state, useUse, resolveUseFn }) {
5
5
  const router = useRouter();
6
6
  handleLinkClick.current = useCallback((e, url) => {
7
7
  e.preventDefault();
8
- if (popRun.current)
9
- return;
10
8
  new Promise((resolve) => {
11
9
  resolveFn.current = resolve;
12
10
  state.current = 'exiting';
13
11
  }).then(() => {
12
+ if (useUse.current)
13
+ resolveUseFn.current?.();
14
14
  router.push(url);
15
15
  });
16
16
  }, []);
@@ -2,7 +2,8 @@ import type { RefObject } from "react";
2
2
  interface Props {
3
3
  resolveFn: RefObject<(() => void) | null>;
4
4
  state: RefObject<'idle' | 'exiting' | 'entering'>;
5
- popRun: RefObject<boolean>;
5
+ useUse: RefObject<boolean>;
6
+ resolveUseFn: RefObject<(() => void) | null>;
6
7
  }
7
- export declare function usePopState({ resolveFn, state, popRun }: Props): void;
8
+ export declare function usePopState({ resolveFn, state, useUse, resolveUseFn }: Props): void;
8
9
  export {};
@@ -1,18 +1,21 @@
1
1
  "use client";
2
2
  import { useEffect, useState, use } from "react";
3
- export function usePopState({ resolveFn, state, popRun }) {
3
+ export function usePopState({ resolveFn, state, useUse, resolveUseFn }) {
4
4
  const [promise, setPromise] = useState(null);
5
5
  if (promise) {
6
- popRun.current = true;
6
+ useUse.current = true;
7
7
  use(promise);
8
- popRun.current = false;
8
+ }
9
+ else {
10
+ useUse.current = false;
9
11
  }
10
12
  useEffect(() => {
11
13
  const handlePopstate = () => {
12
- setPromise(new Promise((resolve) => {
14
+ setPromise(new Promise((resolve, reject) => {
13
15
  resolveFn.current = resolve;
16
+ resolveUseFn.current = reject;
14
17
  state.current = 'exiting';
15
- }));
18
+ }).then(() => setPromise(null)).catch(() => setPromise(null)));
16
19
  };
17
20
  window.addEventListener('popstate', handlePopstate);
18
21
  return () => window.removeEventListener('popstate', handlePopstate);
@@ -19,7 +19,8 @@ interface Props {
19
19
  lock: boolean;
20
20
  }>;
21
21
  delay: RefObject<number | null>;
22
- popRun: RefObject<boolean>;
22
+ useUse: RefObject<boolean>;
23
+ resolveUseFn: RefObject<(() => void) | null>;
23
24
  }
24
- export declare function useHandleLinkClick({ container, handleLinkClick, currentPathname, transitionEndData, transitionEndHandler, reverse, delay, state, popRun, }: Props): void;
25
+ export declare function useHandleLinkClick({ container, handleLinkClick, currentPathname, transitionEndData, transitionEndHandler, reverse, delay, state, useUse, resolveUseFn }: Props): void;
25
26
  export {};
@@ -4,7 +4,7 @@ import { useRouter } from "next/navigation";
4
4
  import { useTransitionEndObj } from "../hooks/useTransitionEndObj";
5
5
  import { transitionEnd } from "../functions/transitionEnd";
6
6
  import { checkTransitionFinish } from "../functions/checkTransitionFinish";
7
- export function useHandleLinkClick({ container, handleLinkClick, currentPathname, transitionEndData, transitionEndHandler, reverse, delay, state, popRun, }) {
7
+ export function useHandleLinkClick({ container, handleLinkClick, currentPathname, transitionEndData, transitionEndHandler, reverse, delay, state, useUse, resolveUseFn }) {
8
8
  const router = useRouter();
9
9
  const afterExitFn = useRef(null);
10
10
  const nextPage = useRef(null);
@@ -13,6 +13,8 @@ export function useHandleLinkClick({ container, handleLinkClick, currentPathname
13
13
  fn: () => {
14
14
  if (!nextPage.current)
15
15
  return;
16
+ if (useUse.current)
17
+ resolveUseFn.current?.();
16
18
  state.current = 'navigating';
17
19
  router.push(nextPage.current);
18
20
  nextPage.current = null;
@@ -35,20 +37,23 @@ export function useHandleLinkClick({ container, handleLinkClick, currentPathname
35
37
  reverse,
36
38
  delay
37
39
  });
40
+ if (useUse.current) {
41
+ resolveUseFn.current?.();
42
+ state.current = 'navigating';
43
+ router.push(currentPathname.current);
44
+ }
38
45
  container.current?.classList.remove('exit');
39
46
  container.current?.classList.add('enter');
40
- reverse.current.lock = false;
41
47
  state.current = 'entering';
48
+ reverse.current.lock = false;
42
49
  }
43
50
  });
44
51
  handleLinkClick.current = useCallback((e, url) => {
45
52
  e.preventDefault();
46
- if (popRun.current)
47
- return;
48
53
  nextPage.current = url;
49
54
  new Promise((resolve) => {
50
55
  if (state.current === 'navigating') {
51
- console.log('navigating');
56
+ console.log('state.current === navigating');
52
57
  if (url === currentPathname.current) {
53
58
  return;
54
59
  }
@@ -18,7 +18,8 @@ interface Props {
18
18
  }>;
19
19
  delay: RefObject<number | null>;
20
20
  state: RefObject<'idle' | 'exiting' | 'entering' | 'navigating'>;
21
- popRun: RefObject<boolean>;
21
+ useUse: RefObject<boolean>;
22
+ resolveUseFn: RefObject<(() => void) | null>;
22
23
  }
23
- export declare function usePopState({ container, currentPathname, transitionEndData, transitionEndHandler, reverse, delay, state, popRun }: Props): void;
24
+ export declare function usePopState({ container, currentPathname, transitionEndData, transitionEndHandler, reverse, delay, state, useUse, resolveUseFn }: Props): void;
24
25
  export {};
@@ -3,12 +3,14 @@ import { useEffect, useRef, useState, use } from "react";
3
3
  import { useTransitionEndObj } from "./useTransitionEndObj";
4
4
  import { transitionEnd } from "../functions/transitionEnd";
5
5
  import { checkTransitionFinish } from "../functions/checkTransitionFinish";
6
- export function usePopState({ container, currentPathname, transitionEndData, transitionEndHandler, reverse, delay, state, popRun }) {
6
+ export function usePopState({ container, currentPathname, transitionEndData, transitionEndHandler, reverse, delay, state, useUse, resolveUseFn }) {
7
7
  const [promise, setPromise] = useState(null);
8
8
  if (promise) {
9
- popRun.current = true;
9
+ useUse.current = true;
10
10
  use(promise);
11
- popRun.current = false;
11
+ }
12
+ else {
13
+ useUse.current = false;
12
14
  }
13
15
  const resolveFn = useRef(null);
14
16
  const afterExitFn = useRef(null);
@@ -34,6 +36,8 @@ export function usePopState({ container, currentPathname, transitionEndData, tra
34
36
  state.current = 'entering';
35
37
  reverse.current.lock = false;
36
38
  resolveFn.current?.();
39
+ setPromise(null);
40
+ useUse.current = false;
37
41
  }
38
42
  });
39
43
  const pop = useTransitionEndObj({
@@ -42,18 +46,20 @@ export function usePopState({ container, currentPathname, transitionEndData, tra
42
46
  state.current = 'navigating';
43
47
  window.scrollTo(0, window.history.state.scrollY ?? 0);
44
48
  resolveFn.current?.();
45
- resolveFn.current = null;
49
+ setPromise(null);
46
50
  }
47
51
  });
48
52
  useEffect(() => {
49
53
  const handlePopstate = () => {
50
- setPromise(new Promise((resolve) => {
54
+ setPromise(new Promise((resolve, reject) => {
51
55
  resolveFn.current = resolve;
56
+ resolveUseFn.current = reject;
52
57
  new Promise((resolveNavigating) => {
53
- if (state.current === "navigating") {
58
+ if (state.current === "navigating" || state.current === "entering") {
54
59
  if (currentPathname.current !== window.location.pathname) {
55
60
  if (checkTransitionFinish(transitionEndData.current, () => {
56
61
  resolveFn.current?.();
62
+ setPromise(null);
57
63
  }))
58
64
  return;
59
65
  }
@@ -89,7 +95,7 @@ export function usePopState({ container, currentPathname, transitionEndData, tra
89
95
  container.current?.classList.add('exit');
90
96
  state.current = 'exiting';
91
97
  });
92
- }));
98
+ }).catch(() => setPromise(null)));
93
99
  };
94
100
  window.addEventListener('popstate', handlePopstate);
95
101
  return () => window.removeEventListener('popstate', handlePopstate);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "page-transition",
3
- "version": "0.1.0-beta.1",
3
+ "version": "0.1.0-beta.11",
4
4
  "description": "A page transition library for the Next.js App Router.",
5
5
  "license": "MIT",
6
6
  "files": [