page-transition 0.0.0-stage → 0.1.0-beta.1
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/LICENSE +21 -0
- package/README.md +237 -2
- package/dist/components/TransitionLink.d.ts +5 -0
- package/dist/components/TransitionLink.js +9 -0
- package/dist/context/CssTransitionProvider.d.ts +12 -0
- package/dist/context/CssTransitionProvider.js +107 -0
- package/dist/context/ManualTransitionProvider.d.ts +6 -0
- package/dist/context/ManualTransitionProvider.js +30 -0
- package/dist/context/TransitionContext.d.ts +24 -0
- package/dist/context/TransitionContext.js +20 -0
- package/dist/functions/checkTransitionFinish.d.ts +6 -0
- package/dist/functions/checkTransitionFinish.js +13 -0
- package/dist/functions/debounce.d.ts +11 -0
- package/dist/functions/debounce.js +8 -0
- package/dist/functions/parseClipPath.d.ts +1 -0
- package/dist/functions/parseClipPath.js +9 -0
- package/dist/functions/parseClipPathAll.d.ts +1 -0
- package/dist/functions/parseClipPathAll.js +20 -0
- package/dist/functions/parseDelay.d.ts +1 -0
- package/dist/functions/parseDelay.js +10 -0
- package/dist/functions/parseOpacity.d.ts +1 -0
- package/dist/functions/parseOpacity.js +6 -0
- package/dist/functions/parseOpacityAll.d.ts +1 -0
- package/dist/functions/parseOpacityAll.js +13 -0
- package/dist/functions/resetDelay.d.ts +1 -0
- package/dist/functions/resetDelay.js +7 -0
- package/dist/functions/transitionEnd.d.ts +21 -0
- package/dist/functions/transitionEnd.js +29 -0
- package/dist/functions/transitionEndReverse.d.ts +21 -0
- package/dist/functions/transitionEndReverse.js +36 -0
- package/dist/functions/wait.d.ts +2 -0
- package/dist/functions/wait.js +12 -0
- package/dist/hooks/manual/useHandleLinkClick.d.ts +9 -0
- package/dist/hooks/manual/useHandleLinkClick.js +17 -0
- package/dist/hooks/manual/usePopState.d.ts +8 -0
- package/dist/hooks/manual/usePopState.js +20 -0
- package/dist/hooks/useHandleLinkClick.d.ts +25 -0
- package/dist/hooks/useHandleLinkClick.js +93 -0
- package/dist/hooks/usePopState.d.ts +24 -0
- package/dist/hooks/usePopState.js +97 -0
- package/dist/hooks/useScrollRestoration.d.ts +1 -0
- package/dist/hooks/useScrollRestoration.js +26 -0
- package/dist/hooks/useTransitionEndData.d.ts +11 -0
- package/dist/hooks/useTransitionEndData.js +17 -0
- package/dist/hooks/useTransitionEndHandler.d.ts +7 -0
- package/dist/hooks/useTransitionEndHandler.js +9 -0
- package/dist/hooks/useTransitionEndObj.d.ts +16 -0
- package/dist/hooks/useTransitionEndObj.js +15 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +3 -0
- package/package.json +23 -5
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Simon Schindler
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,238 @@
|
|
|
1
|
-
#
|
|
1
|
+
# page-transition
|
|
2
|
+
A page transition library for the Next.js App Router.
|
|
2
3
|
|
|
3
|
-
|
|
4
|
+
## Features
|
|
5
|
+
|
|
6
|
+
- CSS & Manual mode
|
|
7
|
+
- Scroll restoration
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
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`
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
Import your page transition styles and wrap your page content with `TransitionProvider` in your root layout.
|
|
19
|
+
|
|
20
|
+
```tsx
|
|
21
|
+
import { TransitionProvider } from "page-transition"
|
|
22
|
+
import '.../your-page-transition-styles.css'
|
|
23
|
+
|
|
24
|
+
export default function RootLayout({ children }: LayoutProps<"/">) {
|
|
25
|
+
return (
|
|
26
|
+
<html lang="en">
|
|
27
|
+
<body>
|
|
28
|
+
<TransitionProvider>
|
|
29
|
+
{children}
|
|
30
|
+
</TransitionProvider>
|
|
31
|
+
</body>
|
|
32
|
+
</html>
|
|
33
|
+
);
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Components
|
|
38
|
+
|
|
39
|
+
### `TransitionProvider`
|
|
40
|
+
#### Props
|
|
41
|
+
|
|
42
|
+
|Prop|Type|Default|Mode|
|
|
43
|
+
|---|---|---|---|
|
|
44
|
+
| mode | "css" \| "manual" | "css" | Both |
|
|
45
|
+
| header | JSX | - | CSS |
|
|
46
|
+
| options | *Options* | {} | CSS |
|
|
47
|
+
|
|
48
|
+
*Options*
|
|
49
|
+
|
|
50
|
+
| Option | Type | Default |
|
|
51
|
+
|---|---|---|
|
|
52
|
+
| transitionProperty | "opacity" \| "clip-path" | "opacity" |
|
|
53
|
+
| overlayCount | number | 0 |
|
|
54
|
+
|
|
55
|
+
**Prop Descriptions**
|
|
56
|
+
|
|
57
|
+
**mode**
|
|
58
|
+
Select the transition mode.
|
|
59
|
+
|
|
60
|
+
**header**
|
|
61
|
+
The component rendered outside the transition container.
|
|
62
|
+
|
|
63
|
+
**options.transitionProperty**
|
|
64
|
+
Defines which property transitionend waits for.
|
|
65
|
+
|
|
66
|
+
**options.overlayCount**
|
|
67
|
+
Defines how many overlay items should be created.
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
```tsx
|
|
71
|
+
<TransitionProvider
|
|
72
|
+
header={<Header/>}
|
|
73
|
+
options={{
|
|
74
|
+
transitionProperty: "clip-path",
|
|
75
|
+
overlayCount: 1
|
|
76
|
+
}}
|
|
77
|
+
>
|
|
78
|
+
{children}
|
|
79
|
+
</TransitionProvider>
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### `TransitionLink`
|
|
83
|
+
#### Props
|
|
84
|
+
|
|
85
|
+
|Prop|type|default|
|
|
86
|
+
|---|---|---|
|
|
87
|
+
| href | string | - |
|
|
88
|
+
|
|
89
|
+
**Description**
|
|
90
|
+
Triggers the transition.
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
```tsx
|
|
94
|
+
<TransitionLink href={"/home"}>
|
|
95
|
+
Home
|
|
96
|
+
</TransitionLink>
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### CSS Mode
|
|
100
|
+
|
|
101
|
+
The `TransitionProvider` uses a container with a `data-transition` attribute. When navigation starts, it adds the `exit` class and waits for the transitionend event of the configured transition property.
|
|
102
|
+
|
|
103
|
+
Once the transition ends, navigation is performed and the scroll position is restored using window.history.state.scrollY.
|
|
104
|
+
|
|
105
|
+
After navigation, the `exit` class is removed and the `enter` class is added. Once the next transitionend event fires, the enter class is removed.
|
|
106
|
+
|
|
107
|
+
For overlay animations, a `.overlay-wrapper` is available. You can add overlay items by setting the `overlayCount` option.
|
|
108
|
+
|
|
109
|
+
To access the overlay wrapper and its items, use `useTransitionContext`.
|
|
110
|
+
|
|
111
|
+
```ts
|
|
112
|
+
import { useTransitionContext } from "page-transition"
|
|
113
|
+
|
|
114
|
+
const {overlayWrapper, overlayItems} = useTransitionContext()
|
|
115
|
+
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
#### CSS/SCSS Examples
|
|
119
|
+
<details>
|
|
120
|
+
<summary>Opacity</summary>
|
|
121
|
+
<br/>
|
|
122
|
+
options
|
|
123
|
+
|
|
124
|
+
```ts
|
|
125
|
+
transitionProperty: "opacity"
|
|
126
|
+
overlayCount: 0
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
```css
|
|
130
|
+
[data-transition]{
|
|
131
|
+
will-change: opacity;
|
|
132
|
+
opacity: 1;
|
|
133
|
+
}
|
|
134
|
+
[data-transition].exit{
|
|
135
|
+
opacity: 0;
|
|
136
|
+
transition: opacity 0.4s ease;
|
|
137
|
+
|
|
138
|
+
}
|
|
139
|
+
[data-transition].enter{
|
|
140
|
+
opacity: 1;
|
|
141
|
+
transition: opacity 0.5s ease;
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
</details>
|
|
145
|
+
|
|
146
|
+
<details>
|
|
147
|
+
<summary>Single Overlay</summary>
|
|
148
|
+
<br/>
|
|
149
|
+
options
|
|
150
|
+
|
|
151
|
+
```ts
|
|
152
|
+
transitionProperty: "clip-path"
|
|
153
|
+
overlayCount: 1
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
```css
|
|
157
|
+
[data-transition] .overlay-wrapper{
|
|
158
|
+
position: fixed;
|
|
159
|
+
inset: 0;
|
|
160
|
+
|
|
161
|
+
display: grid;
|
|
162
|
+
grid-template-columns: 1fr;
|
|
163
|
+
}
|
|
164
|
+
[data-transition] .overlay-item{
|
|
165
|
+
background: black;
|
|
166
|
+
transition: none;
|
|
167
|
+
will-change: clip-path;
|
|
168
|
+
clip-path: inset(100% 0 0 0);
|
|
169
|
+
}
|
|
170
|
+
[data-transition].exit .overlay-item{
|
|
171
|
+
clip-path: inset(0 0 0 0);
|
|
172
|
+
transition: clip-path 1.2s ease;
|
|
173
|
+
}
|
|
174
|
+
[data-transition].enter .overlay-item{
|
|
175
|
+
clip-path: inset(0 0 100% 0);
|
|
176
|
+
transition: clip-path 1.2s ease;
|
|
177
|
+
}
|
|
178
|
+
```
|
|
179
|
+
</details>
|
|
180
|
+
|
|
181
|
+
<details>
|
|
182
|
+
<summary>Staggered Overlays</summary>
|
|
183
|
+
<br/>
|
|
184
|
+
options
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
transitionProperty: "clip-path"
|
|
188
|
+
overlayCount: 10
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
```scss
|
|
192
|
+
[data-transition] .overlay-wrapper{
|
|
193
|
+
position: fixed;
|
|
194
|
+
inset: 0;
|
|
195
|
+
|
|
196
|
+
display: grid;
|
|
197
|
+
grid-template-columns: repeat(10, 1fr);
|
|
198
|
+
}
|
|
199
|
+
[data-transition] .overlay-item{
|
|
200
|
+
background: black;
|
|
201
|
+
transition: none;
|
|
202
|
+
will-change: clip-path;
|
|
203
|
+
clip-path: inset(100% 0 0 0);
|
|
204
|
+
}
|
|
205
|
+
[data-transition].exit .overlay-item{
|
|
206
|
+
clip-path: inset(0 0 0 0);
|
|
207
|
+
transition: clip-path 1.0s ease;
|
|
208
|
+
@for $i from 0 to 10{
|
|
209
|
+
&:nth-child(#{$i+1}){
|
|
210
|
+
transition-delay: $i * 0.2s;
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
[data-transition].enter .overlay-item{
|
|
215
|
+
clip-path: inset(0 0 100% 0);
|
|
216
|
+
transition: clip-path 1.0s ease;
|
|
217
|
+
@for $i from 0 to 10{
|
|
218
|
+
&:nth-child(#{$i+1}){
|
|
219
|
+
transition-delay: $i * 0.2s;
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
```
|
|
224
|
+
</details>
|
|
225
|
+
|
|
226
|
+
### Manual Mode
|
|
227
|
+
|
|
228
|
+
In manual mode, you can control the transition using `useTransitionContext`.
|
|
229
|
+
|
|
230
|
+
After triggering the navigation, `state.current` is set to `exiting`. You can then call `resolveFn.current()` to proceed with the navigation. Once `state.current` is set to `entering`, the new page has loaded. After the animation finishes, `state.current` should be set to `idle`.
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
```ts
|
|
234
|
+
import { useTransitionContext } from "page-transition"
|
|
235
|
+
|
|
236
|
+
const { resolveFn, state } = useTransitionContext()
|
|
237
|
+
|
|
238
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import Link from "next/link";
|
|
3
|
+
import { useTransitionContext } from "../context/TransitionContext";
|
|
4
|
+
export function TransitionLink({ href, children }) {
|
|
5
|
+
const { handleLinkClick } = useTransitionContext();
|
|
6
|
+
return (_jsx(Link, { href: href, onClick: (e) => {
|
|
7
|
+
handleLinkClick.current(e, href);
|
|
8
|
+
}, children: children }));
|
|
9
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { ReactNode } from "react";
|
|
2
|
+
interface TransitionOptions {
|
|
3
|
+
transitionProperty: 'opacity' | 'clip-path';
|
|
4
|
+
overlayCount: number;
|
|
5
|
+
}
|
|
6
|
+
interface ProviderProps {
|
|
7
|
+
header?: ReactNode;
|
|
8
|
+
options?: TransitionOptions;
|
|
9
|
+
children: ReactNode;
|
|
10
|
+
}
|
|
11
|
+
export declare function CssTransitionProvider({ header, options, children }: ProviderProps): import("react").JSX.Element;
|
|
12
|
+
export {};
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
3
|
+
import { TransitionContext } from "./TransitionContext";
|
|
4
|
+
import { useRef, useMemo, useEffect } from "react";
|
|
5
|
+
import { usePathname } from "next/navigation";
|
|
6
|
+
import { useTransitionEndHandler } from "../hooks/useTransitionEndHandler";
|
|
7
|
+
import { useTransitionEndData } from "../hooks/useTransitionEndData";
|
|
8
|
+
import { useTransitionEndObj } from "../hooks/useTransitionEndObj";
|
|
9
|
+
import { transitionEnd } from "../functions/transitionEnd";
|
|
10
|
+
import { useHandleLinkClick } from "../hooks/useHandleLinkClick";
|
|
11
|
+
import { useScrollRestoration } from "../hooks/useScrollRestoration";
|
|
12
|
+
import { usePopState } from "../hooks/usePopState";
|
|
13
|
+
import { parseDelay } from "../functions/parseDelay";
|
|
14
|
+
export function CssTransitionProvider({ header, options = {
|
|
15
|
+
transitionProperty: 'opacity',
|
|
16
|
+
overlayCount: 0
|
|
17
|
+
}, children }) {
|
|
18
|
+
const container = useRef(null);
|
|
19
|
+
const overlayWrapper = useRef(null);
|
|
20
|
+
const overlayItems = useRef([]);
|
|
21
|
+
const pathname = usePathname();
|
|
22
|
+
const currentPathname = useRef(pathname);
|
|
23
|
+
const mount = useRef({
|
|
24
|
+
mounted: false,
|
|
25
|
+
initPathname: pathname
|
|
26
|
+
});
|
|
27
|
+
const state = useRef('idle');
|
|
28
|
+
const popRun = useRef(false);
|
|
29
|
+
const reverse = useRef({
|
|
30
|
+
_lock: true,
|
|
31
|
+
get lock() {
|
|
32
|
+
return this._lock;
|
|
33
|
+
},
|
|
34
|
+
set lock(value) {
|
|
35
|
+
if (delay.current === 0 || overlayItems.current.length < 2) {
|
|
36
|
+
if (this._lock === false)
|
|
37
|
+
this._lock = true;
|
|
38
|
+
return;
|
|
39
|
+
}
|
|
40
|
+
this._lock = value;
|
|
41
|
+
}
|
|
42
|
+
});
|
|
43
|
+
const delay = useRef(null);
|
|
44
|
+
const handleLinkClick = useRef(() => { });
|
|
45
|
+
const transitionEndHandler = useTransitionEndHandler();
|
|
46
|
+
const transitionEndData = useTransitionEndData({
|
|
47
|
+
elArray: options.overlayCount === 0 ? container : overlayItems,
|
|
48
|
+
transitionProperty: options.transitionProperty
|
|
49
|
+
});
|
|
50
|
+
usePopState({
|
|
51
|
+
container,
|
|
52
|
+
currentPathname,
|
|
53
|
+
transitionEndData,
|
|
54
|
+
transitionEndHandler,
|
|
55
|
+
state,
|
|
56
|
+
reverse,
|
|
57
|
+
delay,
|
|
58
|
+
popRun
|
|
59
|
+
});
|
|
60
|
+
useHandleLinkClick({
|
|
61
|
+
container,
|
|
62
|
+
handleLinkClick,
|
|
63
|
+
currentPathname,
|
|
64
|
+
transitionEndData,
|
|
65
|
+
transitionEndHandler,
|
|
66
|
+
state,
|
|
67
|
+
reverse,
|
|
68
|
+
delay,
|
|
69
|
+
popRun
|
|
70
|
+
});
|
|
71
|
+
useScrollRestoration();
|
|
72
|
+
const removeEnter = useTransitionEndObj({
|
|
73
|
+
transitionEndData,
|
|
74
|
+
fn: () => {
|
|
75
|
+
container.current?.classList.remove('enter');
|
|
76
|
+
state.current = 'idle';
|
|
77
|
+
reverse.current.lock = true;
|
|
78
|
+
}
|
|
79
|
+
});
|
|
80
|
+
useEffect(() => {
|
|
81
|
+
if (mount.current.mounted === false &&
|
|
82
|
+
mount.current.initPathname === pathname) {
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
mount.current.mounted = true;
|
|
86
|
+
if (delay.current === null) {
|
|
87
|
+
delay.current = parseDelay(transitionEndData.current.elArray);
|
|
88
|
+
}
|
|
89
|
+
if (!container.current)
|
|
90
|
+
return;
|
|
91
|
+
transitionEnd({
|
|
92
|
+
transitionEndObj: removeEnter,
|
|
93
|
+
transitionEndHandler,
|
|
94
|
+
reverse,
|
|
95
|
+
delay
|
|
96
|
+
});
|
|
97
|
+
container.current.classList.remove('exit');
|
|
98
|
+
container.current.classList.add('enter');
|
|
99
|
+
currentPathname.current = pathname;
|
|
100
|
+
state.current = 'entering';
|
|
101
|
+
reverse.current.lock = false;
|
|
102
|
+
}, [pathname]);
|
|
103
|
+
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) => {
|
|
105
|
+
overlayItems.current[i] = el;
|
|
106
|
+
}, className: "overlay-item" }, i))) }), children] })] }));
|
|
107
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
3
|
+
import { TransitionContext } from "./TransitionContext";
|
|
4
|
+
import { useEffect, useRef, useMemo } from "react";
|
|
5
|
+
import { usePathname } from "next/navigation";
|
|
6
|
+
import { usePopState } from "../hooks/manual/usePopState";
|
|
7
|
+
import { useHandleLinkClick } from "../hooks/manual/useHandleLinkClick";
|
|
8
|
+
export function ManualTransitionProvider({ children }) {
|
|
9
|
+
const pathname = usePathname();
|
|
10
|
+
const handleLinkClick = useRef(() => { });
|
|
11
|
+
const resolveFn = useRef(null);
|
|
12
|
+
const state = useRef('idle');
|
|
13
|
+
const popRun = useRef(false);
|
|
14
|
+
usePopState({
|
|
15
|
+
resolveFn,
|
|
16
|
+
state,
|
|
17
|
+
popRun
|
|
18
|
+
});
|
|
19
|
+
useHandleLinkClick({
|
|
20
|
+
handleLinkClick,
|
|
21
|
+
resolveFn,
|
|
22
|
+
state,
|
|
23
|
+
popRun
|
|
24
|
+
});
|
|
25
|
+
useEffect(() => {
|
|
26
|
+
state.current = 'entering';
|
|
27
|
+
}, [pathname]);
|
|
28
|
+
const value = useMemo(() => ({ handleLinkClick, resolveFn, state }), []);
|
|
29
|
+
return (_jsx(TransitionContext.Provider, { value: value, children: children }));
|
|
30
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { ReactNode, RefObject } from "react";
|
|
2
|
+
interface ContextProps {
|
|
3
|
+
handleLinkClick: RefObject<((e: React.MouseEvent, url: string) => void)>;
|
|
4
|
+
overlayWrapper?: RefObject<HTMLDivElement | null>;
|
|
5
|
+
overlayItems?: RefObject<(HTMLDivElement | null)[]>;
|
|
6
|
+
resolveFn?: RefObject<(() => void) | null>;
|
|
7
|
+
state?: RefObject<'idle' | 'exiting' | 'entering'>;
|
|
8
|
+
}
|
|
9
|
+
export declare const TransitionContext: import("react").Context<ContextProps | null>;
|
|
10
|
+
export declare function useTransitionContext(): ContextProps;
|
|
11
|
+
type Mode = 'css' | 'manual';
|
|
12
|
+
type TransitionProperty = 'opacity' | 'clip-path';
|
|
13
|
+
interface TransitionOptions {
|
|
14
|
+
transitionProperty: TransitionProperty;
|
|
15
|
+
overlayCount: number;
|
|
16
|
+
}
|
|
17
|
+
interface ProviderProps {
|
|
18
|
+
header?: ReactNode;
|
|
19
|
+
mode?: Mode;
|
|
20
|
+
options?: TransitionOptions;
|
|
21
|
+
children: ReactNode;
|
|
22
|
+
}
|
|
23
|
+
export declare function TransitionProvider({ header, mode, options, children, }: ProviderProps): import("react").JSX.Element;
|
|
24
|
+
export {};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
3
|
+
import { createContext, useContext } from "react";
|
|
4
|
+
import { CssTransitionProvider } from "./CssTransitionProvider";
|
|
5
|
+
import { ManualTransitionProvider } from "./ManualTransitionProvider";
|
|
6
|
+
export const TransitionContext = createContext(null);
|
|
7
|
+
export function useTransitionContext() {
|
|
8
|
+
const context = useContext(TransitionContext);
|
|
9
|
+
if (!context)
|
|
10
|
+
throw new Error('useTransitionContext in Provider!');
|
|
11
|
+
return context;
|
|
12
|
+
}
|
|
13
|
+
export function TransitionProvider({ header, mode = 'css', options = {
|
|
14
|
+
transitionProperty: 'opacity',
|
|
15
|
+
overlayCount: 0
|
|
16
|
+
}, children, }) {
|
|
17
|
+
return (mode === 'css' ?
|
|
18
|
+
_jsx(CssTransitionProvider, { header: header, options: options, children: children }) :
|
|
19
|
+
_jsx(ManualTransitionProvider, { children: children }));
|
|
20
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { parseOpacityAll } from "./parseOpacityAll";
|
|
2
|
+
import { parseClipPathAll } from "./parseClipPathAll";
|
|
3
|
+
export function checkTransitionFinish(transitionEndData, fn) {
|
|
4
|
+
const parse = {
|
|
5
|
+
'opacity': () => parseOpacityAll(transitionEndData.elArray),
|
|
6
|
+
'clip-path': () => parseClipPathAll(transitionEndData.elArray)
|
|
7
|
+
};
|
|
8
|
+
if (parse[transitionEndData.propertyName]()) {
|
|
9
|
+
fn?.();
|
|
10
|
+
return true;
|
|
11
|
+
}
|
|
12
|
+
return false;
|
|
13
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function parseClipPath(el: HTMLDivElement | null): number | null;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export function parseClipPath(el) {
|
|
2
|
+
if (!el)
|
|
3
|
+
return null;
|
|
4
|
+
const clipPath = getComputedStyle(el).clipPath;
|
|
5
|
+
const match = clipPath.match(/inset\(([^)]+)\)/);
|
|
6
|
+
const result = match?.[1]?.split(/\s+/) ?? null;
|
|
7
|
+
const number = result?.map(value => parseFloat(value)).find(value => value > 0) ?? 0;
|
|
8
|
+
return number / 100;
|
|
9
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function parseClipPathAll(elArray: (HTMLDivElement | null)[]): null | boolean;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export function parseClipPathAll(elArray) {
|
|
2
|
+
if (elArray.length === 0)
|
|
3
|
+
return null;
|
|
4
|
+
const array = [];
|
|
5
|
+
elArray.forEach((el) => {
|
|
6
|
+
if (!el)
|
|
7
|
+
return;
|
|
8
|
+
const clipPath = getComputedStyle(el).clipPath;
|
|
9
|
+
const m = clipPath.match(/inset\(([^)]+)\)/);
|
|
10
|
+
const result = m?.[1]?.split(/\s+/) ?? null;
|
|
11
|
+
const number = result?.map((string) => parseFloat(string)).find(n => n > 0) ?? 0;
|
|
12
|
+
array.push(number);
|
|
13
|
+
});
|
|
14
|
+
for (const number of array) {
|
|
15
|
+
if (number < 100) {
|
|
16
|
+
return false;
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
return true;
|
|
20
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function parseDelay(elArray: (HTMLDivElement | null)[]): number | null;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export function parseDelay(elArray) {
|
|
2
|
+
if (elArray.length === 0)
|
|
3
|
+
return null;
|
|
4
|
+
const lastIndex = elArray.length - 1;
|
|
5
|
+
const lastEl = elArray[lastIndex];
|
|
6
|
+
if (!lastEl)
|
|
7
|
+
return null;
|
|
8
|
+
const lastDelay = parseFloat(getComputedStyle(lastEl).transitionDelay);
|
|
9
|
+
return lastDelay / (lastIndex || 1);
|
|
10
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function parseOpacity(el: HTMLDivElement | null): number | null;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function parseOpacityAll(elArray: (HTMLDivElement | null)[]): boolean | null;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export function parseOpacityAll(elArray) {
|
|
2
|
+
if (elArray.length === 0)
|
|
3
|
+
return null;
|
|
4
|
+
for (const el of elArray) {
|
|
5
|
+
if (!el)
|
|
6
|
+
continue;
|
|
7
|
+
const opacity = parseFloat(getComputedStyle(el).opacity);
|
|
8
|
+
if (opacity > 0) {
|
|
9
|
+
return false;
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
return true;
|
|
13
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function resetDelay(elArray: (HTMLDivElement | null)[]): void;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { RefObject } from "react";
|
|
2
|
+
interface TransitionEndObj {
|
|
3
|
+
elArray: (HTMLDivElement | null)[];
|
|
4
|
+
propertyName: 'opacity' | 'clip-path';
|
|
5
|
+
fn: (() => void) | null;
|
|
6
|
+
}
|
|
7
|
+
interface TransitionEndHandler {
|
|
8
|
+
handler: ((e: TransitionEvent) => void) | null;
|
|
9
|
+
handlerEl: HTMLDivElement | null;
|
|
10
|
+
}
|
|
11
|
+
interface Props {
|
|
12
|
+
transitionEndObj: RefObject<TransitionEndObj>;
|
|
13
|
+
transitionEndHandler: RefObject<TransitionEndHandler>;
|
|
14
|
+
reverse: RefObject<{
|
|
15
|
+
_lock: boolean;
|
|
16
|
+
lock: boolean;
|
|
17
|
+
}>;
|
|
18
|
+
delay: RefObject<number | null>;
|
|
19
|
+
}
|
|
20
|
+
export declare function transitionEnd({ transitionEndObj, transitionEndHandler, reverse, delay }: Props): void;
|
|
21
|
+
export {};
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { transtionEndReverse } from "./transitionEndReverse";
|
|
2
|
+
export function transitionEnd({ transitionEndObj, transitionEndHandler, reverse, delay }) {
|
|
3
|
+
const lastIndex = transitionEndObj.current.elArray.length - 1;
|
|
4
|
+
if (transitionEndHandler.current.handler &&
|
|
5
|
+
transitionEndHandler.current.handlerEl) {
|
|
6
|
+
transitionEndHandler.current.handlerEl.removeEventListener('transitionend', transitionEndHandler.current.handler);
|
|
7
|
+
}
|
|
8
|
+
if (!reverse.current.lock) {
|
|
9
|
+
transtionEndReverse({
|
|
10
|
+
transitionEndObj,
|
|
11
|
+
transitionEndHandler,
|
|
12
|
+
reverse,
|
|
13
|
+
delay
|
|
14
|
+
});
|
|
15
|
+
return;
|
|
16
|
+
}
|
|
17
|
+
const handler = (e) => {
|
|
18
|
+
if (e.target !== e.currentTarget)
|
|
19
|
+
return;
|
|
20
|
+
if (transitionEndObj.current.propertyName &&
|
|
21
|
+
e.propertyName !== transitionEndObj.current.propertyName)
|
|
22
|
+
return;
|
|
23
|
+
transitionEndObj.current.elArray[lastIndex]?.removeEventListener('transitionend', handler);
|
|
24
|
+
transitionEndObj.current.fn?.();
|
|
25
|
+
};
|
|
26
|
+
transitionEndHandler.current.handler = handler;
|
|
27
|
+
transitionEndHandler.current.handlerEl = transitionEndObj.current.elArray[lastIndex];
|
|
28
|
+
transitionEndObj.current.elArray[lastIndex]?.addEventListener('transitionend', transitionEndHandler.current.handler);
|
|
29
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { RefObject } from "react";
|
|
2
|
+
interface TransitionEndObj {
|
|
3
|
+
elArray: (HTMLDivElement | null)[];
|
|
4
|
+
propertyName: 'opacity' | 'clip-path';
|
|
5
|
+
fn: (() => void) | null;
|
|
6
|
+
}
|
|
7
|
+
interface TransitionEndHandler {
|
|
8
|
+
handler: ((e: TransitionEvent) => void) | null;
|
|
9
|
+
handlerEl: HTMLDivElement | null;
|
|
10
|
+
}
|
|
11
|
+
interface Props {
|
|
12
|
+
transitionEndObj: RefObject<TransitionEndObj>;
|
|
13
|
+
transitionEndHandler: RefObject<TransitionEndHandler>;
|
|
14
|
+
reverse: RefObject<{
|
|
15
|
+
_lock: boolean;
|
|
16
|
+
lock: boolean;
|
|
17
|
+
}>;
|
|
18
|
+
delay: RefObject<number | null>;
|
|
19
|
+
}
|
|
20
|
+
export declare function transtionEndReverse({ transitionEndObj, transitionEndHandler, reverse, delay }: Props): void;
|
|
21
|
+
export {};
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { parseClipPath } from "./parseClipPath";
|
|
2
|
+
import { parseOpacity } from "./parseOpacity";
|
|
3
|
+
import { resetDelay } from "./resetDelay";
|
|
4
|
+
export function transtionEndReverse({ transitionEndObj, transitionEndHandler, reverse, delay }) {
|
|
5
|
+
if (transitionEndHandler.current.handler &&
|
|
6
|
+
transitionEndHandler.current.handlerEl)
|
|
7
|
+
transitionEndHandler.current.handlerEl.removeEventListener('transitionend', transitionEndHandler.current.handler);
|
|
8
|
+
const obj = transitionEndObj.current;
|
|
9
|
+
const property = transitionEndObj.current.propertyName;
|
|
10
|
+
const parseFn = {
|
|
11
|
+
opacity: parseOpacity,
|
|
12
|
+
'clip-path': parseClipPath
|
|
13
|
+
};
|
|
14
|
+
let summ = 0;
|
|
15
|
+
obj.elArray.toReversed().forEach((el) => {
|
|
16
|
+
if (!el)
|
|
17
|
+
return;
|
|
18
|
+
const progress = parseFn[property](el);
|
|
19
|
+
const d = (delay.current ?? 0) * (progress ?? 0);
|
|
20
|
+
el.style.transitionDelay = `${summ}s`;
|
|
21
|
+
summ += d;
|
|
22
|
+
});
|
|
23
|
+
const firstEl = obj.elArray[0];
|
|
24
|
+
const handler = (e) => {
|
|
25
|
+
if (e.propertyName !== obj.propertyName ||
|
|
26
|
+
e.target !== e.currentTarget)
|
|
27
|
+
return;
|
|
28
|
+
resetDelay(obj.elArray);
|
|
29
|
+
reverse.current.lock = true;
|
|
30
|
+
firstEl?.removeEventListener('transitionend', handler);
|
|
31
|
+
obj.fn?.();
|
|
32
|
+
};
|
|
33
|
+
transitionEndHandler.current.handler = handler;
|
|
34
|
+
transitionEndHandler.current.handlerEl = firstEl;
|
|
35
|
+
firstEl?.addEventListener('transitionend', handler);
|
|
36
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export function wait(fn, count, rafId) {
|
|
2
|
+
if (count < 1) {
|
|
3
|
+
fn();
|
|
4
|
+
rafId.current = null;
|
|
5
|
+
return;
|
|
6
|
+
}
|
|
7
|
+
if (rafId.current !== null)
|
|
8
|
+
cancelAnimationFrame(rafId.current);
|
|
9
|
+
rafId.current = requestAnimationFrame(() => {
|
|
10
|
+
wait(fn, --count, rafId);
|
|
11
|
+
});
|
|
12
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { RefObject } from "react";
|
|
2
|
+
interface Props {
|
|
3
|
+
handleLinkClick: RefObject<((e: React.MouseEvent, url: string) => void)>;
|
|
4
|
+
resolveFn: RefObject<(() => void) | null>;
|
|
5
|
+
state: RefObject<'idle' | 'exiting' | 'entering'>;
|
|
6
|
+
popRun: RefObject<boolean>;
|
|
7
|
+
}
|
|
8
|
+
export declare function useHandleLinkClick({ handleLinkClick, resolveFn, state, popRun }: Props): void;
|
|
9
|
+
export {};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { useCallback } from "react";
|
|
3
|
+
import { useRouter } from "next/navigation";
|
|
4
|
+
export function useHandleLinkClick({ handleLinkClick, resolveFn, state, popRun }) {
|
|
5
|
+
const router = useRouter();
|
|
6
|
+
handleLinkClick.current = useCallback((e, url) => {
|
|
7
|
+
e.preventDefault();
|
|
8
|
+
if (popRun.current)
|
|
9
|
+
return;
|
|
10
|
+
new Promise((resolve) => {
|
|
11
|
+
resolveFn.current = resolve;
|
|
12
|
+
state.current = 'exiting';
|
|
13
|
+
}).then(() => {
|
|
14
|
+
router.push(url);
|
|
15
|
+
});
|
|
16
|
+
}, []);
|
|
17
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { RefObject } from "react";
|
|
2
|
+
interface Props {
|
|
3
|
+
resolveFn: RefObject<(() => void) | null>;
|
|
4
|
+
state: RefObject<'idle' | 'exiting' | 'entering'>;
|
|
5
|
+
popRun: RefObject<boolean>;
|
|
6
|
+
}
|
|
7
|
+
export declare function usePopState({ resolveFn, state, popRun }: Props): void;
|
|
8
|
+
export {};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { useEffect, useState, use } from "react";
|
|
3
|
+
export function usePopState({ resolveFn, state, popRun }) {
|
|
4
|
+
const [promise, setPromise] = useState(null);
|
|
5
|
+
if (promise) {
|
|
6
|
+
popRun.current = true;
|
|
7
|
+
use(promise);
|
|
8
|
+
popRun.current = false;
|
|
9
|
+
}
|
|
10
|
+
useEffect(() => {
|
|
11
|
+
const handlePopstate = () => {
|
|
12
|
+
setPromise(new Promise((resolve) => {
|
|
13
|
+
resolveFn.current = resolve;
|
|
14
|
+
state.current = 'exiting';
|
|
15
|
+
}));
|
|
16
|
+
};
|
|
17
|
+
window.addEventListener('popstate', handlePopstate);
|
|
18
|
+
return () => window.removeEventListener('popstate', handlePopstate);
|
|
19
|
+
}, []);
|
|
20
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { RefObject } from "react";
|
|
2
|
+
interface TransitionEndData {
|
|
3
|
+
elArray: (HTMLDivElement | null)[];
|
|
4
|
+
propertyName: 'opacity' | 'clip-path';
|
|
5
|
+
}
|
|
6
|
+
interface TransitionEndHandler {
|
|
7
|
+
handler: ((e: TransitionEvent) => void) | null;
|
|
8
|
+
handlerEl: HTMLDivElement | null;
|
|
9
|
+
}
|
|
10
|
+
interface Props {
|
|
11
|
+
container: RefObject<HTMLDivElement | null>;
|
|
12
|
+
handleLinkClick: RefObject<((e: React.MouseEvent, url: string) => void)>;
|
|
13
|
+
currentPathname: RefObject<string>;
|
|
14
|
+
transitionEndData: RefObject<TransitionEndData>;
|
|
15
|
+
transitionEndHandler: RefObject<TransitionEndHandler>;
|
|
16
|
+
state: RefObject<'idle' | 'exiting' | 'entering' | 'navigating'>;
|
|
17
|
+
reverse: RefObject<{
|
|
18
|
+
_lock: boolean;
|
|
19
|
+
lock: boolean;
|
|
20
|
+
}>;
|
|
21
|
+
delay: RefObject<number | null>;
|
|
22
|
+
popRun: RefObject<boolean>;
|
|
23
|
+
}
|
|
24
|
+
export declare function useHandleLinkClick({ container, handleLinkClick, currentPathname, transitionEndData, transitionEndHandler, reverse, delay, state, popRun, }: Props): void;
|
|
25
|
+
export {};
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { useCallback, useRef } from "react";
|
|
3
|
+
import { useRouter } from "next/navigation";
|
|
4
|
+
import { useTransitionEndObj } from "../hooks/useTransitionEndObj";
|
|
5
|
+
import { transitionEnd } from "../functions/transitionEnd";
|
|
6
|
+
import { checkTransitionFinish } from "../functions/checkTransitionFinish";
|
|
7
|
+
export function useHandleLinkClick({ container, handleLinkClick, currentPathname, transitionEndData, transitionEndHandler, reverse, delay, state, popRun, }) {
|
|
8
|
+
const router = useRouter();
|
|
9
|
+
const afterExitFn = useRef(null);
|
|
10
|
+
const nextPage = useRef(null);
|
|
11
|
+
const push = useTransitionEndObj({
|
|
12
|
+
transitionEndData,
|
|
13
|
+
fn: () => {
|
|
14
|
+
if (!nextPage.current)
|
|
15
|
+
return;
|
|
16
|
+
state.current = 'navigating';
|
|
17
|
+
router.push(nextPage.current);
|
|
18
|
+
nextPage.current = null;
|
|
19
|
+
}
|
|
20
|
+
});
|
|
21
|
+
const removeEnter = useTransitionEndObj({
|
|
22
|
+
transitionEndData,
|
|
23
|
+
fn: () => {
|
|
24
|
+
container.current?.classList.remove('enter');
|
|
25
|
+
state.current = 'idle';
|
|
26
|
+
reverse.current.lock = true;
|
|
27
|
+
}
|
|
28
|
+
});
|
|
29
|
+
const afterExit = useTransitionEndObj({
|
|
30
|
+
transitionEndData,
|
|
31
|
+
fn: afterExitFn.current = () => {
|
|
32
|
+
transitionEnd({
|
|
33
|
+
transitionEndObj: removeEnter,
|
|
34
|
+
transitionEndHandler,
|
|
35
|
+
reverse,
|
|
36
|
+
delay
|
|
37
|
+
});
|
|
38
|
+
container.current?.classList.remove('exit');
|
|
39
|
+
container.current?.classList.add('enter');
|
|
40
|
+
reverse.current.lock = false;
|
|
41
|
+
state.current = 'entering';
|
|
42
|
+
}
|
|
43
|
+
});
|
|
44
|
+
handleLinkClick.current = useCallback((e, url) => {
|
|
45
|
+
e.preventDefault();
|
|
46
|
+
if (popRun.current)
|
|
47
|
+
return;
|
|
48
|
+
nextPage.current = url;
|
|
49
|
+
new Promise((resolve) => {
|
|
50
|
+
if (state.current === 'navigating') {
|
|
51
|
+
console.log('navigating');
|
|
52
|
+
if (url === currentPathname.current) {
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
else if (url !== currentPathname.current) {
|
|
56
|
+
if (checkTransitionFinish(transitionEndData.current, () => {
|
|
57
|
+
if (!nextPage.current)
|
|
58
|
+
return;
|
|
59
|
+
state.current = 'navigating';
|
|
60
|
+
router.push(nextPage.current);
|
|
61
|
+
nextPage.current = null;
|
|
62
|
+
}))
|
|
63
|
+
return;
|
|
64
|
+
resolve();
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
else {
|
|
68
|
+
resolve();
|
|
69
|
+
}
|
|
70
|
+
}).then(() => {
|
|
71
|
+
if (url === currentPathname.current) {
|
|
72
|
+
if (state.current !== 'exiting')
|
|
73
|
+
return;
|
|
74
|
+
transitionEnd({
|
|
75
|
+
transitionEndObj: afterExit,
|
|
76
|
+
transitionEndHandler,
|
|
77
|
+
reverse,
|
|
78
|
+
delay
|
|
79
|
+
});
|
|
80
|
+
return;
|
|
81
|
+
}
|
|
82
|
+
transitionEnd({
|
|
83
|
+
transitionEndObj: push,
|
|
84
|
+
transitionEndHandler,
|
|
85
|
+
reverse,
|
|
86
|
+
delay
|
|
87
|
+
});
|
|
88
|
+
container.current?.classList.remove('enter');
|
|
89
|
+
container.current?.classList.add('exit');
|
|
90
|
+
state.current = 'exiting';
|
|
91
|
+
});
|
|
92
|
+
}, [router]);
|
|
93
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { RefObject } from "react";
|
|
2
|
+
interface TransitionEndData {
|
|
3
|
+
elArray: (HTMLDivElement | null)[];
|
|
4
|
+
propertyName: 'opacity' | 'clip-path';
|
|
5
|
+
}
|
|
6
|
+
interface TransitionEndHandler {
|
|
7
|
+
handler: ((e: TransitionEvent) => void) | null;
|
|
8
|
+
handlerEl: HTMLDivElement | null;
|
|
9
|
+
}
|
|
10
|
+
interface Props {
|
|
11
|
+
container: RefObject<HTMLDivElement | null>;
|
|
12
|
+
currentPathname: RefObject<string>;
|
|
13
|
+
transitionEndData: RefObject<TransitionEndData>;
|
|
14
|
+
transitionEndHandler: RefObject<TransitionEndHandler>;
|
|
15
|
+
reverse: RefObject<{
|
|
16
|
+
_lock: boolean;
|
|
17
|
+
lock: boolean;
|
|
18
|
+
}>;
|
|
19
|
+
delay: RefObject<number | null>;
|
|
20
|
+
state: RefObject<'idle' | 'exiting' | 'entering' | 'navigating'>;
|
|
21
|
+
popRun: RefObject<boolean>;
|
|
22
|
+
}
|
|
23
|
+
export declare function usePopState({ container, currentPathname, transitionEndData, transitionEndHandler, reverse, delay, state, popRun }: Props): void;
|
|
24
|
+
export {};
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { useEffect, useRef, useState, use } from "react";
|
|
3
|
+
import { useTransitionEndObj } from "./useTransitionEndObj";
|
|
4
|
+
import { transitionEnd } from "../functions/transitionEnd";
|
|
5
|
+
import { checkTransitionFinish } from "../functions/checkTransitionFinish";
|
|
6
|
+
export function usePopState({ container, currentPathname, transitionEndData, transitionEndHandler, reverse, delay, state, popRun }) {
|
|
7
|
+
const [promise, setPromise] = useState(null);
|
|
8
|
+
if (promise) {
|
|
9
|
+
popRun.current = true;
|
|
10
|
+
use(promise);
|
|
11
|
+
popRun.current = false;
|
|
12
|
+
}
|
|
13
|
+
const resolveFn = useRef(null);
|
|
14
|
+
const afterExitFn = useRef(null);
|
|
15
|
+
const removeEnter = useTransitionEndObj({
|
|
16
|
+
transitionEndData,
|
|
17
|
+
fn: () => {
|
|
18
|
+
container.current?.classList.remove('enter');
|
|
19
|
+
state.current = 'idle';
|
|
20
|
+
reverse.current.lock = true;
|
|
21
|
+
}
|
|
22
|
+
});
|
|
23
|
+
const afterExit = useTransitionEndObj({
|
|
24
|
+
transitionEndData,
|
|
25
|
+
fn: afterExitFn.current = () => {
|
|
26
|
+
transitionEnd({
|
|
27
|
+
transitionEndObj: removeEnter,
|
|
28
|
+
transitionEndHandler,
|
|
29
|
+
reverse,
|
|
30
|
+
delay
|
|
31
|
+
});
|
|
32
|
+
container.current?.classList.remove('exit');
|
|
33
|
+
container.current?.classList.add('enter');
|
|
34
|
+
state.current = 'entering';
|
|
35
|
+
reverse.current.lock = false;
|
|
36
|
+
resolveFn.current?.();
|
|
37
|
+
}
|
|
38
|
+
});
|
|
39
|
+
const pop = useTransitionEndObj({
|
|
40
|
+
transitionEndData,
|
|
41
|
+
fn: () => {
|
|
42
|
+
state.current = 'navigating';
|
|
43
|
+
window.scrollTo(0, window.history.state.scrollY ?? 0);
|
|
44
|
+
resolveFn.current?.();
|
|
45
|
+
resolveFn.current = null;
|
|
46
|
+
}
|
|
47
|
+
});
|
|
48
|
+
useEffect(() => {
|
|
49
|
+
const handlePopstate = () => {
|
|
50
|
+
setPromise(new Promise((resolve) => {
|
|
51
|
+
resolveFn.current = resolve;
|
|
52
|
+
new Promise((resolveNavigating) => {
|
|
53
|
+
if (state.current === "navigating") {
|
|
54
|
+
if (currentPathname.current !== window.location.pathname) {
|
|
55
|
+
if (checkTransitionFinish(transitionEndData.current, () => {
|
|
56
|
+
resolveFn.current?.();
|
|
57
|
+
}))
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
else if (currentPathname.current === window.location.pathname) {
|
|
61
|
+
if (checkTransitionFinish(transitionEndData.current, afterExitFn.current)) {
|
|
62
|
+
return;
|
|
63
|
+
}
|
|
64
|
+
else {
|
|
65
|
+
resolveNavigating();
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
else {
|
|
70
|
+
resolveNavigating();
|
|
71
|
+
}
|
|
72
|
+
}).then(() => {
|
|
73
|
+
if (currentPathname.current === window.location.pathname) {
|
|
74
|
+
transitionEnd({
|
|
75
|
+
transitionEndObj: afterExit,
|
|
76
|
+
transitionEndHandler,
|
|
77
|
+
reverse,
|
|
78
|
+
delay
|
|
79
|
+
});
|
|
80
|
+
return;
|
|
81
|
+
}
|
|
82
|
+
transitionEnd({
|
|
83
|
+
transitionEndObj: pop,
|
|
84
|
+
transitionEndHandler,
|
|
85
|
+
reverse,
|
|
86
|
+
delay
|
|
87
|
+
});
|
|
88
|
+
container.current?.classList.remove('enter');
|
|
89
|
+
container.current?.classList.add('exit');
|
|
90
|
+
state.current = 'exiting';
|
|
91
|
+
});
|
|
92
|
+
}));
|
|
93
|
+
};
|
|
94
|
+
window.addEventListener('popstate', handlePopstate);
|
|
95
|
+
return () => window.removeEventListener('popstate', handlePopstate);
|
|
96
|
+
}, []);
|
|
97
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function useScrollRestoration(): void;
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { useEffect, useRef } from "react";
|
|
3
|
+
import { debounce } from "../functions/debounce";
|
|
4
|
+
export function useScrollRestoration() {
|
|
5
|
+
const saveScrollY = () => {
|
|
6
|
+
window.history.replaceState({
|
|
7
|
+
...window.history.state,
|
|
8
|
+
scrollY: window.scrollY
|
|
9
|
+
}, "");
|
|
10
|
+
};
|
|
11
|
+
const debounceRef = useRef({
|
|
12
|
+
timeOutId: null,
|
|
13
|
+
fn: saveScrollY
|
|
14
|
+
});
|
|
15
|
+
useEffect(() => {
|
|
16
|
+
window.history.scrollRestoration = 'manual';
|
|
17
|
+
const handleScroll = () => {
|
|
18
|
+
debounce({ ref: debounceRef });
|
|
19
|
+
};
|
|
20
|
+
window.addEventListener('scroll', handleScroll);
|
|
21
|
+
return () => {
|
|
22
|
+
window.history.scrollRestoration = 'auto';
|
|
23
|
+
window.removeEventListener('scroll', handleScroll);
|
|
24
|
+
};
|
|
25
|
+
}, []);
|
|
26
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { RefObject } from "react";
|
|
2
|
+
interface TransitionEndData {
|
|
3
|
+
elArray: (HTMLDivElement | null)[];
|
|
4
|
+
propertyName: 'opacity' | 'clip-path';
|
|
5
|
+
}
|
|
6
|
+
interface Props {
|
|
7
|
+
elArray: RefObject<HTMLDivElement | null | (HTMLDivElement | null)[]>;
|
|
8
|
+
transitionProperty: 'opacity' | 'clip-path';
|
|
9
|
+
}
|
|
10
|
+
export declare function useTransitionEndData({ elArray, transitionProperty }: Props): RefObject<TransitionEndData>;
|
|
11
|
+
export {};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { useEffect, useRef } from "react";
|
|
3
|
+
export function useTransitionEndData({ elArray, transitionProperty }) {
|
|
4
|
+
const transitionEndData = useRef({
|
|
5
|
+
elArray: [],
|
|
6
|
+
propertyName: transitionProperty
|
|
7
|
+
});
|
|
8
|
+
useEffect(() => {
|
|
9
|
+
transitionEndData.current = {
|
|
10
|
+
...transitionEndData.current,
|
|
11
|
+
elArray: Array.isArray(elArray.current) ?
|
|
12
|
+
elArray.current :
|
|
13
|
+
[elArray.current],
|
|
14
|
+
};
|
|
15
|
+
}, []);
|
|
16
|
+
return transitionEndData;
|
|
17
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { RefObject } from "react";
|
|
2
|
+
interface TransitionEndData {
|
|
3
|
+
elArray: (HTMLDivElement | null)[];
|
|
4
|
+
propertyName: 'opacity' | 'clip-path';
|
|
5
|
+
}
|
|
6
|
+
interface Props {
|
|
7
|
+
transitionEndData: RefObject<TransitionEndData>;
|
|
8
|
+
fn: () => void;
|
|
9
|
+
}
|
|
10
|
+
interface TransitionEndObj {
|
|
11
|
+
elArray: (HTMLDivElement | null)[];
|
|
12
|
+
propertyName: 'opacity' | 'clip-path';
|
|
13
|
+
fn: (() => void) | null;
|
|
14
|
+
}
|
|
15
|
+
export declare function useTransitionEndObj({ transitionEndData, fn }: Props): RefObject<TransitionEndObj>;
|
|
16
|
+
export {};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { useRef, useEffect } from "react";
|
|
2
|
+
export function useTransitionEndObj({ transitionEndData, fn }) {
|
|
3
|
+
const transitionEndObj = useRef({
|
|
4
|
+
elArray: [null],
|
|
5
|
+
propertyName: transitionEndData.current.propertyName,
|
|
6
|
+
fn: null,
|
|
7
|
+
});
|
|
8
|
+
useEffect(() => {
|
|
9
|
+
transitionEndObj.current = {
|
|
10
|
+
...transitionEndData.current,
|
|
11
|
+
fn
|
|
12
|
+
};
|
|
13
|
+
}, []);
|
|
14
|
+
return transitionEndObj;
|
|
15
|
+
}
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
package/package.json
CHANGED
|
@@ -1,6 +1,24 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
2
|
+
"name": "page-transition",
|
|
3
|
+
"version": "0.1.0-beta.1",
|
|
4
|
+
"description": "A page transition library for the Next.js App Router.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"files": [
|
|
7
|
+
"dist"
|
|
8
|
+
],
|
|
9
|
+
"main": "./dist/index.js",
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"scripts": {
|
|
12
|
+
"build": "tsc"
|
|
13
|
+
},
|
|
14
|
+
"peerDependencies": {
|
|
15
|
+
"next": "^15.0.0 || ^16.0.0",
|
|
16
|
+
"react": "^18.0.0 || ^19.0.0",
|
|
17
|
+
"react-dom": "^18.0.0 || ^19.0.0"
|
|
18
|
+
},
|
|
19
|
+
"devDependencies": {
|
|
20
|
+
"@types/react": "^19.3.0",
|
|
21
|
+
"@types/react-dom": "^19.3.0",
|
|
22
|
+
"typescript": "^5.9.3"
|
|
23
|
+
}
|
|
24
|
+
}
|