forked from clerk/javascript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathuiComponents.tsx
More file actions
489 lines (430 loc) · 15.5 KB
/
Copy pathuiComponents.tsx
File metadata and controls
489 lines (430 loc) · 15.5 KB
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
import { without } from '@clerk/shared/object';
import { isDeeplyEqual } from '@clerk/shared/react';
import { logErrorInDevMode } from '@clerk/shared/utils';
import type {
CreateOrganizationProps,
GoogleOneTapProps,
OrganizationListProps,
OrganizationProfileProps,
OrganizationSwitcherProps,
SignInProps,
SignUpProps,
UserButtonProps,
UserProfileProps,
WaitlistProps,
Without,
} from '@clerk/types';
import type { PropsWithChildren } from 'react';
import React, { createContext, createElement, useContext } from 'react';
import {
organizationProfileLinkRenderedError,
organizationProfilePageRenderedError,
userButtonMenuActionRenderedError,
userButtonMenuItemsRenderedError,
userButtonMenuLinkRenderedError,
userProfileLinkRenderedError,
userProfilePageRenderedError,
} from '../errors/messages';
import type {
CustomPortalsRendererProps,
MountProps,
OpenProps,
OrganizationProfileLinkProps,
OrganizationProfilePageProps,
UserButtonActionProps,
UserButtonLinkProps,
UserProfileLinkProps,
UserProfilePageProps,
WithClerkProp,
} from '../types';
import {
useOrganizationProfileCustomPages,
useSanitizedChildren,
useUserButtonCustomMenuItems,
useUserProfileCustomPages,
} from '../utils';
import { withClerk } from './withClerk';
type UserProfileExportType = typeof _UserProfile & {
Page: typeof UserProfilePage;
Link: typeof UserProfileLink;
};
type UserButtonExportType = typeof _UserButton & {
UserProfilePage: typeof UserProfilePage;
UserProfileLink: typeof UserProfileLink;
MenuItems: typeof MenuItems;
Action: typeof MenuAction;
Link: typeof MenuLink;
/**
* The `<Outlet />` component can be used in conjunction with `asProvider` in order to control rendering
* of the `<OrganizationSwitcher />` without affecting its configuration or any custom pages
* that could be mounted
* @experimental This API is experimental and may change at any moment.
*/
__experimental_Outlet: typeof UserButtonOutlet;
};
type UserButtonPropsWithoutCustomPages = Without<
UserButtonProps,
'userProfileProps' | '__experimental_asStandalone'
> & {
userProfileProps?: Pick<UserProfileProps, 'additionalOAuthScopes' | 'appearance'>;
/**
* Adding `asProvider` will defer rendering until the `<Outlet />` component is mounted.
* @experimental This API is experimental and may change at any moment.
* @default undefined
*/
__experimental_asProvider?: boolean;
};
type OrganizationProfileExportType = typeof _OrganizationProfile & {
Page: typeof OrganizationProfilePage;
Link: typeof OrganizationProfileLink;
};
type OrganizationSwitcherExportType = typeof _OrganizationSwitcher & {
OrganizationProfilePage: typeof OrganizationProfilePage;
OrganizationProfileLink: typeof OrganizationProfileLink;
/**
* The `<Outlet />` component can be used in conjunction with `asProvider` in order to control rendering
* of the `<OrganizationSwitcher />` without affecting its configuration or any custom pages
* that could be mounted
* @experimental This API is experimental and may change at any moment.
*/
__experimental_Outlet: typeof OrganizationSwitcherOutlet;
};
type OrganizationSwitcherPropsWithoutCustomPages = Without<
OrganizationSwitcherProps,
'organizationProfileProps' | '__experimental_asStandalone'
> & {
organizationProfileProps?: Pick<OrganizationProfileProps, 'appearance'>;
/**
* Adding `asProvider` will defer rendering until the `<Outlet />` component is mounted.
* @experimental This API is experimental and may change at any moment.
* @default undefined
*/
__experimental_asProvider?: boolean;
};
const isMountProps = (props: any): props is MountProps => {
return 'mount' in props;
};
const isOpenProps = (props: any): props is OpenProps => {
return 'open' in props;
};
// README: <Portal/> should be a class pure component in order for mount and unmount
// lifecycle props to be invoked correctly. Replacing the class component with a
// functional component wrapped with a React.memo is not identical to the original
// class implementation due to React intricacies such as the useEffect’s cleanup
// seems to run AFTER unmount, while componentWillUnmount runs BEFORE.
// More information can be found at https://clerk.slack.com/archives/C015S0BGH8R/p1624891993016300
// The function Portal implementation is commented out for future reference.
// const Portal = React.memo(({ props, mount, unmount }: MountProps) => {
// const portalRef = React.createRef<HTMLDivElement>();
// useEffect(() => {
// if (portalRef.current) {
// mount(portalRef.current, props);
// }
// return () => {
// if (portalRef.current) {
// unmount(portalRef.current);
// }
// };
// }, []);
// return <div ref={portalRef} />;
// });
// Portal.displayName = 'ClerkPortal';
class Portal extends React.PureComponent<
PropsWithChildren<(MountProps | OpenProps) & { hideRootHtmlElement?: boolean }>
> {
private portalRef = React.createRef<HTMLDivElement>();
componentDidUpdate(_prevProps: Readonly<MountProps | OpenProps>) {
if (!isMountProps(_prevProps) || !isMountProps(this.props)) {
return;
}
// Remove children and customPages from props before comparing
// children might hold circular references which deepEqual can't handle
// and the implementation of customPages or customMenuItems relies on props getting new references
const prevProps = without(_prevProps.props, 'customPages', 'customMenuItems', 'children');
const newProps = without(this.props.props, 'customPages', 'customMenuItems', 'children');
// instead, we simply use the length of customPages to determine if it changed or not
const customPagesChanged = prevProps.customPages?.length !== newProps.customPages?.length;
const customMenuItemsChanged = prevProps.customMenuItems?.length !== newProps.customMenuItems?.length;
if (!isDeeplyEqual(prevProps, newProps) || customPagesChanged || customMenuItemsChanged) {
if (this.portalRef.current) {
this.props.updateProps({ node: this.portalRef.current, props: this.props.props });
}
}
}
componentDidMount() {
if (this.portalRef.current) {
if (isMountProps(this.props)) {
this.props.mount(this.portalRef.current, this.props.props);
}
if (isOpenProps(this.props)) {
this.props.open(this.props.props);
}
}
}
componentWillUnmount() {
if (this.portalRef.current) {
if (isMountProps(this.props)) {
this.props.unmount(this.portalRef.current);
}
if (isOpenProps(this.props)) {
this.props.close();
}
}
}
render() {
const { hideRootHtmlElement = false } = this.props;
return (
<>
{!hideRootHtmlElement && <div ref={this.portalRef} />}
{this.props.children}
</>
);
}
}
const CustomPortalsRenderer = (props: CustomPortalsRendererProps) => {
return (
<>
{props?.customPagesPortals?.map((portal, index) => createElement(portal, { key: index }))}
{props?.customMenuItemsPortals?.map((portal, index) => createElement(portal, { key: index }))}
</>
);
};
export const SignIn = withClerk(({ clerk, ...props }: WithClerkProp<SignInProps>) => {
return (
<Portal
mount={clerk.mountSignIn}
unmount={clerk.unmountSignIn}
updateProps={(clerk as any).__unstable__updateProps}
props={props}
/>
);
}, 'SignIn');
export const SignUp = withClerk(({ clerk, ...props }: WithClerkProp<SignUpProps>) => {
return (
<Portal
mount={clerk.mountSignUp}
unmount={clerk.unmountSignUp}
updateProps={(clerk as any).__unstable__updateProps}
props={props}
/>
);
}, 'SignUp');
export function UserProfilePage({ children }: PropsWithChildren<UserProfilePageProps>) {
logErrorInDevMode(userProfilePageRenderedError);
return <>{children}</>;
}
export function UserProfileLink({ children }: PropsWithChildren<UserProfileLinkProps>) {
logErrorInDevMode(userProfileLinkRenderedError);
return <>{children}</>;
}
const _UserProfile = withClerk(
({ clerk, ...props }: WithClerkProp<PropsWithChildren<Without<UserProfileProps, 'customPages'>>>) => {
const { customPages, customPagesPortals } = useUserProfileCustomPages(props.children);
return (
<Portal
mount={clerk.mountUserProfile}
unmount={clerk.unmountUserProfile}
updateProps={(clerk as any).__unstable__updateProps}
props={{ ...props, customPages }}
>
<CustomPortalsRenderer customPagesPortals={customPagesPortals} />
</Portal>
);
},
'UserProfile',
);
export const UserProfile: UserProfileExportType = Object.assign(_UserProfile, {
Page: UserProfilePage,
Link: UserProfileLink,
});
const UserButtonContext = createContext<MountProps>({
mount: () => {},
unmount: () => {},
updateProps: () => {},
});
const _UserButton = withClerk(
({ clerk, ...props }: WithClerkProp<PropsWithChildren<UserButtonPropsWithoutCustomPages>>) => {
const { customPages, customPagesPortals } = useUserProfileCustomPages(props.children, {
allowForAnyChildren: !!props.__experimental_asProvider,
});
const userProfileProps = Object.assign(props.userProfileProps || {}, { customPages });
const { customMenuItems, customMenuItemsPortals } = useUserButtonCustomMenuItems(props.children);
const sanitizedChildren = useSanitizedChildren(props.children);
const passableProps = {
mount: clerk.mountUserButton,
unmount: clerk.unmountUserButton,
updateProps: (clerk as any).__unstable__updateProps,
props: { ...props, userProfileProps, customMenuItems },
};
const portalProps = {
customPagesPortals: customPagesPortals,
customMenuItemsPortals: customMenuItemsPortals,
};
return (
<UserButtonContext.Provider value={passableProps}>
<Portal
{...passableProps}
hideRootHtmlElement={!!props.__experimental_asProvider}
>
{/*This mimics the previous behaviour before asProvider existed*/}
{props.__experimental_asProvider ? sanitizedChildren : null}
<CustomPortalsRenderer {...portalProps} />
</Portal>
</UserButtonContext.Provider>
);
},
'UserButton',
);
export function MenuItems({ children }: PropsWithChildren) {
logErrorInDevMode(userButtonMenuItemsRenderedError);
return <>{children}</>;
}
export function MenuAction({ children }: PropsWithChildren<UserButtonActionProps>) {
logErrorInDevMode(userButtonMenuActionRenderedError);
return <>{children}</>;
}
export function MenuLink({ children }: PropsWithChildren<UserButtonLinkProps>) {
logErrorInDevMode(userButtonMenuLinkRenderedError);
return <>{children}</>;
}
export function UserButtonOutlet(outletProps: Without<UserButtonProps, 'userProfileProps'>) {
const providerProps = useContext(UserButtonContext);
const portalProps = {
...providerProps,
props: {
...providerProps.props,
...outletProps,
},
} satisfies MountProps;
return <Portal {...portalProps} />;
}
export const UserButton: UserButtonExportType = Object.assign(_UserButton, {
UserProfilePage,
UserProfileLink,
MenuItems,
Action: MenuAction,
Link: MenuLink,
__experimental_Outlet: UserButtonOutlet,
});
export function OrganizationProfilePage({ children }: PropsWithChildren<OrganizationProfilePageProps>) {
logErrorInDevMode(organizationProfilePageRenderedError);
return <>{children}</>;
}
export function OrganizationProfileLink({ children }: PropsWithChildren<OrganizationProfileLinkProps>) {
logErrorInDevMode(organizationProfileLinkRenderedError);
return <>{children}</>;
}
const _OrganizationProfile = withClerk(
({ clerk, ...props }: WithClerkProp<PropsWithChildren<Without<OrganizationProfileProps, 'customPages'>>>) => {
const { customPages, customPagesPortals } = useOrganizationProfileCustomPages(props.children);
return (
<Portal
mount={clerk.mountOrganizationProfile}
unmount={clerk.unmountOrganizationProfile}
updateProps={(clerk as any).__unstable__updateProps}
props={{ ...props, customPages }}
>
<CustomPortalsRenderer customPagesPortals={customPagesPortals} />
</Portal>
);
},
'OrganizationProfile',
);
export const OrganizationProfile: OrganizationProfileExportType = Object.assign(_OrganizationProfile, {
Page: OrganizationProfilePage,
Link: OrganizationProfileLink,
});
export const CreateOrganization = withClerk(({ clerk, ...props }: WithClerkProp<CreateOrganizationProps>) => {
return (
<Portal
mount={clerk.mountCreateOrganization}
unmount={clerk.unmountCreateOrganization}
updateProps={(clerk as any).__unstable__updateProps}
props={props}
/>
);
}, 'CreateOrganization');
const OrganizationSwitcherContext = createContext<MountProps>({
mount: () => {},
unmount: () => {},
updateProps: () => {},
});
const _OrganizationSwitcher = withClerk(
({ clerk, ...props }: WithClerkProp<PropsWithChildren<OrganizationSwitcherPropsWithoutCustomPages>>) => {
const { customPages, customPagesPortals } = useOrganizationProfileCustomPages(props.children, {
allowForAnyChildren: !!props.__experimental_asProvider,
});
const organizationProfileProps = Object.assign(props.organizationProfileProps || {}, { customPages });
const sanitizedChildren = useSanitizedChildren(props.children);
const passableProps = {
mount: clerk.mountOrganizationSwitcher,
unmount: clerk.unmountOrganizationSwitcher,
updateProps: (clerk as any).__unstable__updateProps,
props: { ...props, organizationProfileProps },
};
/**
* Prefetch organization list
*/
clerk.__experimental_prefetchOrganizationSwitcher();
return (
<OrganizationSwitcherContext.Provider value={passableProps}>
<Portal
{...passableProps}
hideRootHtmlElement={!!props.__experimental_asProvider}
>
{/*This mimics the previous behaviour before asProvider existed*/}
{props.__experimental_asProvider ? sanitizedChildren : null}
<CustomPortalsRenderer customPagesPortals={customPagesPortals} />
</Portal>
</OrganizationSwitcherContext.Provider>
);
},
'OrganizationSwitcher',
);
export function OrganizationSwitcherOutlet(
outletProps: Without<OrganizationSwitcherProps, 'organizationProfileProps'>,
) {
const providerProps = useContext(OrganizationSwitcherContext);
const portalProps = {
...providerProps,
props: {
...providerProps.props,
...outletProps,
},
} satisfies MountProps;
return <Portal {...portalProps} />;
}
export const OrganizationSwitcher: OrganizationSwitcherExportType = Object.assign(_OrganizationSwitcher, {
OrganizationProfilePage,
OrganizationProfileLink,
__experimental_Outlet: OrganizationSwitcherOutlet,
});
export const OrganizationList = withClerk(({ clerk, ...props }: WithClerkProp<OrganizationListProps>) => {
return (
<Portal
mount={clerk.mountOrganizationList}
unmount={clerk.unmountOrganizationList}
updateProps={(clerk as any).__unstable__updateProps}
props={props}
/>
);
}, 'OrganizationList');
export const GoogleOneTap = withClerk(({ clerk, ...props }: WithClerkProp<GoogleOneTapProps>) => {
return (
<Portal
open={clerk.openGoogleOneTap}
close={clerk.closeGoogleOneTap}
props={props}
/>
);
}, 'GoogleOneTap');
export const Waitlist = withClerk(({ clerk, ...props }: WithClerkProp<WaitlistProps>) => {
return (
<Portal
mount={clerk.mountWaitlist}
unmount={clerk.unmountWaitlist}
updateProps={(clerk as any).__unstable__updateProps}
props={props}
/>
);
}, 'Waitlist');