-
Notifications
You must be signed in to change notification settings - Fork 4.2k
/
component.tsx
307 lines (277 loc) · 7.22 KB
/
component.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
/**
* External dependencies
*/
import type { ForwardedRef } from 'react';
import { css } from '@emotion/react';
/**
* WordPress dependencies
*/
import {
useMemo,
useState,
useCallback,
useReducer,
useRef,
useEffect,
} from '@wordpress/element';
import isShallowEqual from '@wordpress/is-shallow-equal';
/**
* Internal dependencies
*/
import {
contextConnect,
useContextSystem,
WordPressComponentProps,
} from '../../ui/context';
import { useCx } from '../../utils/hooks/use-cx';
import { View } from '../../view';
import { NavigatorContext } from '../context';
import type {
NavigatorProviderProps,
NavigatorLocation,
NavigatorContext as NavigatorContextType,
Screen,
} from '../types';
import { patternMatch, findParent } from '../utils/router';
type MatchedPath = ReturnType< typeof patternMatch >;
type ScreenAction = { type: string; screen: Screen };
const MAX_HISTORY_LENGTH = 50;
function screensReducer(
state: Screen[] = [],
action: ScreenAction
): Screen[] {
switch ( action.type ) {
case 'add':
return [ ...state, action.screen ];
case 'remove':
return state.filter( ( s: Screen ) => s.id !== action.screen.id );
}
return state;
}
function UnconnectedNavigatorProvider(
props: WordPressComponentProps< NavigatorProviderProps, 'div' >,
forwardedRef: ForwardedRef< any >
) {
const { initialPath, children, className, ...otherProps } =
useContextSystem( props, 'NavigatorProvider' );
const [ locationHistory, setLocationHistory ] = useState<
NavigatorLocation[]
>( [
{
path: initialPath,
},
] );
const currentLocationHistory = useRef< NavigatorLocation[] >( [] );
const [ screens, dispatch ] = useReducer( screensReducer, [] );
const currentScreens = useRef< Screen[] >( [] );
useEffect( () => {
currentScreens.current = screens;
}, [ screens ] );
useEffect( () => {
currentLocationHistory.current = locationHistory;
}, [ locationHistory ] );
const currentMatch = useRef< MatchedPath >();
const matchedPath = useMemo( () => {
let currentPath: string | undefined;
if (
locationHistory.length === 0 ||
( currentPath =
locationHistory[ locationHistory.length - 1 ].path ) ===
undefined
) {
currentMatch.current = undefined;
return undefined;
}
const resolvePath = ( path: string ) => {
const newMatch = patternMatch( path, screens );
// If the new match is the same as the current match,
// return the previous one for performance reasons.
if (
currentMatch.current &&
newMatch &&
isShallowEqual(
newMatch.params,
currentMatch.current.params
) &&
newMatch.id === currentMatch.current.id
) {
return currentMatch.current;
}
return newMatch;
};
const newMatch = resolvePath( currentPath );
currentMatch.current = newMatch;
return newMatch;
}, [ screens, locationHistory ] );
const addScreen = useCallback(
( screen: Screen ) => dispatch( { type: 'add', screen } ),
[]
);
const removeScreen = useCallback(
( screen: Screen ) => dispatch( { type: 'remove', screen } ),
[]
);
const goBack: NavigatorContextType[ 'goBack' ] = useCallback( () => {
setLocationHistory( ( prevLocationHistory ) => {
if ( prevLocationHistory.length <= 1 ) {
return prevLocationHistory;
}
return [
...prevLocationHistory.slice( 0, -2 ),
{
...prevLocationHistory[ prevLocationHistory.length - 2 ],
isBack: true,
hasRestoredFocus: false,
},
];
} );
}, [] );
const goTo: NavigatorContextType[ 'goTo' ] = useCallback(
( path, options = {} ) => {
const {
focusTargetSelector,
isBack = false,
skipFocus = false,
replace = false,
...restOptions
} = options;
const isNavigatingToPreviousPath =
isBack &&
currentLocationHistory.current.length > 1 &&
currentLocationHistory.current[
currentLocationHistory.current.length - 2
].path === path;
if ( isNavigatingToPreviousPath ) {
goBack();
return;
}
setLocationHistory( ( prevLocationHistory ) => {
const newLocation = {
...restOptions,
path,
isBack,
hasRestoredFocus: false,
skipFocus,
};
if ( prevLocationHistory.length === 0 ) {
return replace ? [] : [ newLocation ];
}
const newLocationHistory = prevLocationHistory.slice(
prevLocationHistory.length > MAX_HISTORY_LENGTH - 1 ? 1 : 0,
-1
);
if ( ! replace ) {
newLocationHistory.push(
// Assign `focusTargetSelector` to the previous location in history
// (the one we just navigated from).
{
...prevLocationHistory[
prevLocationHistory.length - 1
],
focusTargetSelector,
}
);
}
newLocationHistory.push( newLocation );
return newLocationHistory;
} );
},
[ goBack ]
);
const goToParent: NavigatorContextType[ 'goToParent' ] = useCallback(
( options = {} ) => {
const currentPath =
currentLocationHistory.current[
currentLocationHistory.current.length - 1
].path;
if ( currentPath === undefined ) {
return;
}
const parentPath = findParent(
currentPath,
currentScreens.current
);
if ( parentPath === undefined ) {
return;
}
goTo( parentPath, { ...options, isBack: true } );
},
[ goTo ]
);
const navigatorContextValue: NavigatorContextType = useMemo(
() => ( {
location: {
...locationHistory[ locationHistory.length - 1 ],
isInitial: locationHistory.length === 1,
},
params: matchedPath ? matchedPath.params : {},
match: matchedPath ? matchedPath.id : undefined,
goTo,
goBack,
goToParent,
addScreen,
removeScreen,
} ),
[
locationHistory,
matchedPath,
goTo,
goBack,
goToParent,
addScreen,
removeScreen,
]
);
const cx = useCx();
const classes = useMemo(
// Prevents horizontal overflow while animating screen transitions.
() => cx( css( { overflowX: 'hidden' } ), className ),
[ className, cx ]
);
return (
<View ref={ forwardedRef } className={ classes } { ...otherProps }>
<NavigatorContext.Provider value={ navigatorContextValue }>
{ children }
</NavigatorContext.Provider>
</View>
);
}
/**
* The `NavigatorProvider` component allows rendering nested views/panels/menus
* (via the `NavigatorScreen` component and navigate between these different
* view (via the `NavigatorButton` and `NavigatorBackButton` components or the
* `useNavigator` hook).
*
* @example
* ```jsx
* import {
* __experimentalNavigatorProvider as NavigatorProvider,
* __experimentalNavigatorScreen as NavigatorScreen,
* __experimentalNavigatorButton as NavigatorButton,
* __experimentalNavigatorBackButton as NavigatorBackButton,
* } from '@wordpress/components';
*
* const MyNavigation = () => (
* <NavigatorProvider initialPath="/">
* <NavigatorScreen path="/">
* <p>This is the home screen.</p>
* <NavigatorButton path="/child">
* Navigate to child screen.
* </NavigatorButton>
* </NavigatorScreen>
*
* <NavigatorScreen path="/child">
* <p>This is the child screen.</p>
* <NavigatorBackButton>
* Go back
* </NavigatorBackButton>
* </NavigatorScreen>
* </NavigatorProvider>
* );
* ```
*/
export const NavigatorProvider = contextConnect(
UnconnectedNavigatorProvider,
'NavigatorProvider'
);
export default NavigatorProvider;