@clerk/react 5.54.0
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 +71 -0
- package/dist/chunk-KLK6ZMZX.mjs +1011 -0
- package/dist/chunk-KLK6ZMZX.mjs.map +1 -0
- package/dist/chunk-MB46WFKC.mjs +28 -0
- package/dist/chunk-MB46WFKC.mjs.map +1 -0
- package/dist/chunk-OANWQR3B.mjs +16 -0
- package/dist/chunk-OANWQR3B.mjs.map +1 -0
- package/dist/chunk-PS5BRRRD.mjs +282 -0
- package/dist/chunk-PS5BRRRD.mjs.map +1 -0
- package/dist/chunk-Z2DSM5QN.mjs +171 -0
- package/dist/chunk-Z2DSM5QN.mjs.map +1 -0
- package/dist/errors.d.mts +1 -0
- package/dist/errors.d.ts +1 -0
- package/dist/errors.js +45 -0
- package/dist/errors.js.map +1 -0
- package/dist/errors.mjs +24 -0
- package/dist/errors.mjs.map +1 -0
- package/dist/experimental.d.mts +125 -0
- package/dist/experimental.d.ts +125 -0
- package/dist/experimental.js +1301 -0
- package/dist/experimental.js.map +1 -0
- package/dist/experimental.mjs +164 -0
- package/dist/experimental.mjs.map +1 -0
- package/dist/index.d.mts +217 -0
- package/dist/index.d.ts +217 -0
- package/dist/index.js +3304 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +1940 -0
- package/dist/index.mjs.map +1 -0
- package/dist/internal.d.mts +18 -0
- package/dist/internal.d.ts +18 -0
- package/dist/internal.js +260 -0
- package/dist/internal.js.map +1 -0
- package/dist/internal.mjs +58 -0
- package/dist/internal.mjs.map +1 -0
- package/dist/legacy.d.mts +95 -0
- package/dist/legacy.d.ts +95 -0
- package/dist/legacy.js +90 -0
- package/dist/legacy.js.map +1 -0
- package/dist/legacy.mjs +48 -0
- package/dist/legacy.mjs.map +1 -0
- package/dist/types-BS-xjOf_.d.mts +77 -0
- package/dist/types-BS-xjOf_.d.ts +77 -0
- package/dist/useAuth-CibrZ7p3.d.mts +182 -0
- package/dist/useAuth-yh0dHssU.d.ts +182 -0
- package/package.json +116 -0
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
import * as _clerk_shared_types from '@clerk/shared/types';
|
|
2
|
+
import { Without, APIKeysProps, CreateOrganizationProps, OrganizationListProps, OrganizationProfileProps, OrganizationSwitcherProps, SignInProps, SignUpProps, TaskChooseOrganizationProps, UserAvatarProps, UserButtonProps, UserProfileProps, WaitlistProps, SignInButtonProps, SignOutOptions, SignUpButtonProps, SignInResource, CreateEmailLinkFlowReturn, SignInStartEmailLinkFlowParams, SignUpResource, StartEmailLinkFlowParams, EmailAddressResource, SignInSignalValue, SignUpSignalValue } from '@clerk/shared/types';
|
|
3
|
+
export { BrowserClerk, BrowserClerkConstructor, ClerkProp, HeadlessBrowserClerk, HeadlessBrowserClerkConstructor, IsomorphicClerkOptions } from '@clerk/shared/types';
|
|
4
|
+
import React, { ReactNode, PropsWithChildren } from 'react';
|
|
5
|
+
import { W as WithClerkProp, O as OrganizationProfilePageProps, a as OrganizationProfileLinkProps, U as UserProfilePageProps, b as UserProfileLinkProps, c as UserButtonActionProps, d as UserButtonLinkProps, S as SignInWithMetamaskButtonProps, C as ClerkProviderProps } from './types-BS-xjOf_.mjs';
|
|
6
|
+
export { A as AuthenticateWithRedirectCallback, C as ClerkDegraded, a as ClerkFailed, b as ClerkLoaded, c as ClerkLoading, P as Protect, j as ProtectProps, R as RedirectToCreateOrganization, d as RedirectToOrganizationProfile, e as RedirectToSignIn, f as RedirectToSignUp, g as RedirectToTasks, h as RedirectToUserProfile, S as SignedIn, i as SignedOut, k as useAuth } from './useAuth-CibrZ7p3.mjs';
|
|
7
|
+
export { __experimental_CheckoutProvider, __experimental_PaymentElement, __experimental_PaymentElementProvider, __experimental_useCheckout, __experimental_usePaymentElement, useClerk, useOrganization, useOrganizationList, useReverification, useSession, useSessionList, useUser } from '@clerk/shared/react';
|
|
8
|
+
import '@clerk/shared/ui';
|
|
9
|
+
|
|
10
|
+
type FallbackProp = {
|
|
11
|
+
/**
|
|
12
|
+
* An optional element to render while the component is mounting.
|
|
13
|
+
*/
|
|
14
|
+
fallback?: ReactNode;
|
|
15
|
+
};
|
|
16
|
+
type UserProfileExportType = typeof _UserProfile & {
|
|
17
|
+
Page: typeof UserProfilePage;
|
|
18
|
+
Link: typeof UserProfileLink;
|
|
19
|
+
};
|
|
20
|
+
type UserButtonExportType = typeof _UserButton & {
|
|
21
|
+
UserProfilePage: typeof UserProfilePage;
|
|
22
|
+
UserProfileLink: typeof UserProfileLink;
|
|
23
|
+
MenuItems: typeof MenuItems;
|
|
24
|
+
Action: typeof MenuAction;
|
|
25
|
+
Link: typeof MenuLink;
|
|
26
|
+
/**
|
|
27
|
+
* The `<Outlet />` component can be used in conjunction with `asProvider` in order to control rendering
|
|
28
|
+
* of the `<UserButton />` without affecting its configuration or any custom pages that could be mounted
|
|
29
|
+
* @experimental This API is experimental and may change at any moment.
|
|
30
|
+
*/
|
|
31
|
+
__experimental_Outlet: typeof UserButtonOutlet;
|
|
32
|
+
};
|
|
33
|
+
type UserButtonPropsWithoutCustomPages = Without<UserButtonProps, 'userProfileProps' | '__experimental_asStandalone'> & {
|
|
34
|
+
userProfileProps?: Pick<UserProfileProps, 'additionalOAuthScopes' | 'appearance'>;
|
|
35
|
+
/**
|
|
36
|
+
* Adding `asProvider` will defer rendering until the `<Outlet />` component is mounted.
|
|
37
|
+
*
|
|
38
|
+
* @experimental This API is experimental and may change at any moment.
|
|
39
|
+
* @default undefined
|
|
40
|
+
*/
|
|
41
|
+
__experimental_asProvider?: boolean;
|
|
42
|
+
};
|
|
43
|
+
type OrganizationProfileExportType = typeof _OrganizationProfile & {
|
|
44
|
+
Page: typeof OrganizationProfilePage;
|
|
45
|
+
Link: typeof OrganizationProfileLink;
|
|
46
|
+
};
|
|
47
|
+
type OrganizationSwitcherExportType = typeof _OrganizationSwitcher & {
|
|
48
|
+
OrganizationProfilePage: typeof OrganizationProfilePage;
|
|
49
|
+
OrganizationProfileLink: typeof OrganizationProfileLink;
|
|
50
|
+
/**
|
|
51
|
+
* The `<Outlet />` component can be used in conjunction with `asProvider` in order to control rendering
|
|
52
|
+
* of the `<OrganizationSwitcher />` without affecting its configuration or any custom pages that could be mounted
|
|
53
|
+
*
|
|
54
|
+
* @experimental This API is experimental and may change at any moment.
|
|
55
|
+
*/
|
|
56
|
+
__experimental_Outlet: typeof OrganizationSwitcherOutlet;
|
|
57
|
+
};
|
|
58
|
+
type OrganizationSwitcherPropsWithoutCustomPages = Without<OrganizationSwitcherProps, 'organizationProfileProps' | '__experimental_asStandalone'> & {
|
|
59
|
+
organizationProfileProps?: Pick<OrganizationProfileProps, 'appearance'>;
|
|
60
|
+
/**
|
|
61
|
+
* Adding `asProvider` will defer rendering until the `<Outlet />` component is mounted.
|
|
62
|
+
*
|
|
63
|
+
* @experimental This API is experimental and may change at any moment.
|
|
64
|
+
* @default undefined
|
|
65
|
+
*/
|
|
66
|
+
__experimental_asProvider?: boolean;
|
|
67
|
+
};
|
|
68
|
+
declare const SignIn: {
|
|
69
|
+
(props: Without<WithClerkProp<SignInProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
70
|
+
displayName: string;
|
|
71
|
+
};
|
|
72
|
+
declare const SignUp: {
|
|
73
|
+
(props: Without<WithClerkProp<SignUpProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
74
|
+
displayName: string;
|
|
75
|
+
};
|
|
76
|
+
declare function UserProfilePage({ children }: PropsWithChildren<UserProfilePageProps>): React.JSX.Element;
|
|
77
|
+
declare function UserProfileLink({ children }: PropsWithChildren<UserProfileLinkProps>): React.JSX.Element;
|
|
78
|
+
declare const _UserProfile: {
|
|
79
|
+
(props: Without<WithClerkProp<PropsWithChildren<Without<UserProfileProps, "customPages">> & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
80
|
+
displayName: string;
|
|
81
|
+
};
|
|
82
|
+
declare const UserProfile: UserProfileExportType;
|
|
83
|
+
declare const _UserButton: {
|
|
84
|
+
(props: Without<WithClerkProp<PropsWithChildren<UserButtonPropsWithoutCustomPages> & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
85
|
+
displayName: string;
|
|
86
|
+
};
|
|
87
|
+
declare function MenuItems({ children }: PropsWithChildren): React.JSX.Element;
|
|
88
|
+
declare function MenuAction({ children }: PropsWithChildren<UserButtonActionProps>): React.JSX.Element;
|
|
89
|
+
declare function MenuLink({ children }: PropsWithChildren<UserButtonLinkProps>): React.JSX.Element;
|
|
90
|
+
declare function UserButtonOutlet(outletProps: Without<UserButtonProps, 'userProfileProps'>): React.JSX.Element;
|
|
91
|
+
declare const UserButton: UserButtonExportType;
|
|
92
|
+
declare function OrganizationProfilePage({ children }: PropsWithChildren<OrganizationProfilePageProps>): React.JSX.Element;
|
|
93
|
+
declare function OrganizationProfileLink({ children }: PropsWithChildren<OrganizationProfileLinkProps>): React.JSX.Element;
|
|
94
|
+
declare const _OrganizationProfile: {
|
|
95
|
+
(props: Without<WithClerkProp<PropsWithChildren<Without<OrganizationProfileProps, "customPages">> & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
96
|
+
displayName: string;
|
|
97
|
+
};
|
|
98
|
+
declare const OrganizationProfile: OrganizationProfileExportType;
|
|
99
|
+
declare const CreateOrganization: {
|
|
100
|
+
(props: Without<WithClerkProp<CreateOrganizationProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
101
|
+
displayName: string;
|
|
102
|
+
};
|
|
103
|
+
declare const _OrganizationSwitcher: {
|
|
104
|
+
(props: Without<WithClerkProp<PropsWithChildren<OrganizationSwitcherPropsWithoutCustomPages> & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
105
|
+
displayName: string;
|
|
106
|
+
};
|
|
107
|
+
declare function OrganizationSwitcherOutlet(outletProps: Without<OrganizationSwitcherProps, 'organizationProfileProps'>): React.JSX.Element;
|
|
108
|
+
declare const OrganizationSwitcher: OrganizationSwitcherExportType;
|
|
109
|
+
declare const OrganizationList: {
|
|
110
|
+
(props: Without<WithClerkProp<OrganizationListProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
111
|
+
displayName: string;
|
|
112
|
+
};
|
|
113
|
+
declare const GoogleOneTap: {
|
|
114
|
+
(props: Without<WithClerkProp<_clerk_shared_types.SignInForceRedirectUrl & _clerk_shared_types.SignUpForceRedirectUrl & {
|
|
115
|
+
cancelOnTapOutside?: boolean;
|
|
116
|
+
itpSupport?: boolean;
|
|
117
|
+
fedCmSupport?: boolean;
|
|
118
|
+
appearance?: _clerk_shared_types.SignInTheme;
|
|
119
|
+
} & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
120
|
+
displayName: string;
|
|
121
|
+
};
|
|
122
|
+
declare const Waitlist: {
|
|
123
|
+
(props: Without<WithClerkProp<WaitlistProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
124
|
+
displayName: string;
|
|
125
|
+
};
|
|
126
|
+
declare const PricingTable: {
|
|
127
|
+
(props: Without<WithClerkProp<{
|
|
128
|
+
for?: _clerk_shared_types.ForPayerType;
|
|
129
|
+
appearance?: _clerk_shared_types.PricingTableTheme;
|
|
130
|
+
checkoutProps?: Pick<_clerk_shared_types.__internal_CheckoutProps, "appearance">;
|
|
131
|
+
} & {
|
|
132
|
+
ctaPosition?: "top" | "bottom";
|
|
133
|
+
collapseFeatures?: boolean;
|
|
134
|
+
newSubscriptionRedirectUrl?: string;
|
|
135
|
+
} & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
136
|
+
displayName: string;
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* @experimental This component is in early access and may change in future releases.
|
|
140
|
+
*/
|
|
141
|
+
declare const APIKeys: {
|
|
142
|
+
(props: Without<WithClerkProp<APIKeysProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
143
|
+
displayName: string;
|
|
144
|
+
};
|
|
145
|
+
declare const UserAvatar: {
|
|
146
|
+
(props: Without<WithClerkProp<UserAvatarProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
147
|
+
displayName: string;
|
|
148
|
+
};
|
|
149
|
+
declare const TaskChooseOrganization: {
|
|
150
|
+
(props: Without<WithClerkProp<TaskChooseOrganizationProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
151
|
+
displayName: string;
|
|
152
|
+
};
|
|
153
|
+
|
|
154
|
+
declare const SignInButton: {
|
|
155
|
+
(props: _clerk_shared_types.Without<WithClerkProp<React.PropsWithChildren<SignInButtonProps>>, "clerk">): React.JSX.Element | null;
|
|
156
|
+
displayName: string;
|
|
157
|
+
};
|
|
158
|
+
|
|
159
|
+
declare const SignInWithMetamaskButton: {
|
|
160
|
+
(props: _clerk_shared_types.Without<WithClerkProp<SignInWithMetamaskButtonProps>, "clerk">): React.JSX.Element | null;
|
|
161
|
+
displayName: string;
|
|
162
|
+
};
|
|
163
|
+
|
|
164
|
+
type SignOutButtonProps = {
|
|
165
|
+
redirectUrl?: string;
|
|
166
|
+
signOutOptions?: SignOutOptions;
|
|
167
|
+
children?: React.ReactNode;
|
|
168
|
+
};
|
|
169
|
+
declare const SignOutButton: {
|
|
170
|
+
(props: _clerk_shared_types.Without<React.PropsWithChildren<WithClerkProp<SignOutButtonProps>>, "clerk">): React.JSX.Element | null;
|
|
171
|
+
displayName: string;
|
|
172
|
+
};
|
|
173
|
+
|
|
174
|
+
declare const SignUpButton: {
|
|
175
|
+
(props: _clerk_shared_types.Without<WithClerkProp<React.PropsWithChildren<SignUpButtonProps>>, "clerk">): React.JSX.Element | null;
|
|
176
|
+
displayName: string;
|
|
177
|
+
};
|
|
178
|
+
|
|
179
|
+
declare const ClerkProvider: React.ComponentType<ClerkProviderProps>;
|
|
180
|
+
|
|
181
|
+
type UseEmailLinkSignInReturn = CreateEmailLinkFlowReturn<SignInStartEmailLinkFlowParams, SignInResource>;
|
|
182
|
+
type UseEmailLinkSignUpReturn = CreateEmailLinkFlowReturn<StartEmailLinkFlowParams, SignUpResource>;
|
|
183
|
+
type UseEmailLinkEmailAddressReturn = CreateEmailLinkFlowReturn<StartEmailLinkFlowParams, EmailAddressResource>;
|
|
184
|
+
declare function useEmailLink(resource: SignInResource): UseEmailLinkSignInReturn;
|
|
185
|
+
declare function useEmailLink(resource: SignUpResource): UseEmailLinkSignUpReturn;
|
|
186
|
+
declare function useEmailLink(resource: EmailAddressResource): UseEmailLinkEmailAddressReturn;
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* This hook allows you to access the Signal-based `SignIn` resource.
|
|
190
|
+
*
|
|
191
|
+
* @example
|
|
192
|
+
* import { useSignInSignal } from "@clerk/react/experimental";
|
|
193
|
+
*
|
|
194
|
+
* function SignInForm() {
|
|
195
|
+
* const { signIn, errors, fetchStatus } = useSignInSignal();
|
|
196
|
+
* //
|
|
197
|
+
* }
|
|
198
|
+
*
|
|
199
|
+
* @experimental This experimental API is subject to change.
|
|
200
|
+
*/
|
|
201
|
+
declare function useSignIn(): SignInSignalValue;
|
|
202
|
+
/**
|
|
203
|
+
* This hook allows you to access the Signal-based `SignUp` resource.
|
|
204
|
+
*
|
|
205
|
+
* @example
|
|
206
|
+
* import { useSignUpSignal } from "@clerk/react/experimental";
|
|
207
|
+
*
|
|
208
|
+
* function SignUpForm() {
|
|
209
|
+
* const { signUp, errors, fetchStatus } = useSignUpSignal();
|
|
210
|
+
* //
|
|
211
|
+
* }
|
|
212
|
+
*
|
|
213
|
+
* @experimental This experimental API is subject to change.
|
|
214
|
+
*/
|
|
215
|
+
declare function useSignUp(): SignUpSignalValue;
|
|
216
|
+
|
|
217
|
+
export { APIKeys, ClerkProvider, ClerkProviderProps, CreateOrganization, GoogleOneTap, OrganizationList, OrganizationProfile, OrganizationSwitcher, PricingTable, SignIn, SignInButton, SignInWithMetamaskButton, SignOutButton, SignUp, SignUpButton, TaskChooseOrganization, UserAvatar, UserButton, UserProfile, Waitlist, useEmailLink, useSignIn, useSignUp };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
import * as _clerk_shared_types from '@clerk/shared/types';
|
|
2
|
+
import { Without, APIKeysProps, CreateOrganizationProps, OrganizationListProps, OrganizationProfileProps, OrganizationSwitcherProps, SignInProps, SignUpProps, TaskChooseOrganizationProps, UserAvatarProps, UserButtonProps, UserProfileProps, WaitlistProps, SignInButtonProps, SignOutOptions, SignUpButtonProps, SignInResource, CreateEmailLinkFlowReturn, SignInStartEmailLinkFlowParams, SignUpResource, StartEmailLinkFlowParams, EmailAddressResource, SignInSignalValue, SignUpSignalValue } from '@clerk/shared/types';
|
|
3
|
+
export { BrowserClerk, BrowserClerkConstructor, ClerkProp, HeadlessBrowserClerk, HeadlessBrowserClerkConstructor, IsomorphicClerkOptions } from '@clerk/shared/types';
|
|
4
|
+
import React, { ReactNode, PropsWithChildren } from 'react';
|
|
5
|
+
import { W as WithClerkProp, O as OrganizationProfilePageProps, a as OrganizationProfileLinkProps, U as UserProfilePageProps, b as UserProfileLinkProps, c as UserButtonActionProps, d as UserButtonLinkProps, S as SignInWithMetamaskButtonProps, C as ClerkProviderProps } from './types-BS-xjOf_.js';
|
|
6
|
+
export { A as AuthenticateWithRedirectCallback, C as ClerkDegraded, a as ClerkFailed, b as ClerkLoaded, c as ClerkLoading, P as Protect, j as ProtectProps, R as RedirectToCreateOrganization, d as RedirectToOrganizationProfile, e as RedirectToSignIn, f as RedirectToSignUp, g as RedirectToTasks, h as RedirectToUserProfile, S as SignedIn, i as SignedOut, k as useAuth } from './useAuth-yh0dHssU.js';
|
|
7
|
+
export { __experimental_CheckoutProvider, __experimental_PaymentElement, __experimental_PaymentElementProvider, __experimental_useCheckout, __experimental_usePaymentElement, useClerk, useOrganization, useOrganizationList, useReverification, useSession, useSessionList, useUser } from '@clerk/shared/react';
|
|
8
|
+
import '@clerk/shared/ui';
|
|
9
|
+
|
|
10
|
+
type FallbackProp = {
|
|
11
|
+
/**
|
|
12
|
+
* An optional element to render while the component is mounting.
|
|
13
|
+
*/
|
|
14
|
+
fallback?: ReactNode;
|
|
15
|
+
};
|
|
16
|
+
type UserProfileExportType = typeof _UserProfile & {
|
|
17
|
+
Page: typeof UserProfilePage;
|
|
18
|
+
Link: typeof UserProfileLink;
|
|
19
|
+
};
|
|
20
|
+
type UserButtonExportType = typeof _UserButton & {
|
|
21
|
+
UserProfilePage: typeof UserProfilePage;
|
|
22
|
+
UserProfileLink: typeof UserProfileLink;
|
|
23
|
+
MenuItems: typeof MenuItems;
|
|
24
|
+
Action: typeof MenuAction;
|
|
25
|
+
Link: typeof MenuLink;
|
|
26
|
+
/**
|
|
27
|
+
* The `<Outlet />` component can be used in conjunction with `asProvider` in order to control rendering
|
|
28
|
+
* of the `<UserButton />` without affecting its configuration or any custom pages that could be mounted
|
|
29
|
+
* @experimental This API is experimental and may change at any moment.
|
|
30
|
+
*/
|
|
31
|
+
__experimental_Outlet: typeof UserButtonOutlet;
|
|
32
|
+
};
|
|
33
|
+
type UserButtonPropsWithoutCustomPages = Without<UserButtonProps, 'userProfileProps' | '__experimental_asStandalone'> & {
|
|
34
|
+
userProfileProps?: Pick<UserProfileProps, 'additionalOAuthScopes' | 'appearance'>;
|
|
35
|
+
/**
|
|
36
|
+
* Adding `asProvider` will defer rendering until the `<Outlet />` component is mounted.
|
|
37
|
+
*
|
|
38
|
+
* @experimental This API is experimental and may change at any moment.
|
|
39
|
+
* @default undefined
|
|
40
|
+
*/
|
|
41
|
+
__experimental_asProvider?: boolean;
|
|
42
|
+
};
|
|
43
|
+
type OrganizationProfileExportType = typeof _OrganizationProfile & {
|
|
44
|
+
Page: typeof OrganizationProfilePage;
|
|
45
|
+
Link: typeof OrganizationProfileLink;
|
|
46
|
+
};
|
|
47
|
+
type OrganizationSwitcherExportType = typeof _OrganizationSwitcher & {
|
|
48
|
+
OrganizationProfilePage: typeof OrganizationProfilePage;
|
|
49
|
+
OrganizationProfileLink: typeof OrganizationProfileLink;
|
|
50
|
+
/**
|
|
51
|
+
* The `<Outlet />` component can be used in conjunction with `asProvider` in order to control rendering
|
|
52
|
+
* of the `<OrganizationSwitcher />` without affecting its configuration or any custom pages that could be mounted
|
|
53
|
+
*
|
|
54
|
+
* @experimental This API is experimental and may change at any moment.
|
|
55
|
+
*/
|
|
56
|
+
__experimental_Outlet: typeof OrganizationSwitcherOutlet;
|
|
57
|
+
};
|
|
58
|
+
type OrganizationSwitcherPropsWithoutCustomPages = Without<OrganizationSwitcherProps, 'organizationProfileProps' | '__experimental_asStandalone'> & {
|
|
59
|
+
organizationProfileProps?: Pick<OrganizationProfileProps, 'appearance'>;
|
|
60
|
+
/**
|
|
61
|
+
* Adding `asProvider` will defer rendering until the `<Outlet />` component is mounted.
|
|
62
|
+
*
|
|
63
|
+
* @experimental This API is experimental and may change at any moment.
|
|
64
|
+
* @default undefined
|
|
65
|
+
*/
|
|
66
|
+
__experimental_asProvider?: boolean;
|
|
67
|
+
};
|
|
68
|
+
declare const SignIn: {
|
|
69
|
+
(props: Without<WithClerkProp<SignInProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
70
|
+
displayName: string;
|
|
71
|
+
};
|
|
72
|
+
declare const SignUp: {
|
|
73
|
+
(props: Without<WithClerkProp<SignUpProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
74
|
+
displayName: string;
|
|
75
|
+
};
|
|
76
|
+
declare function UserProfilePage({ children }: PropsWithChildren<UserProfilePageProps>): React.JSX.Element;
|
|
77
|
+
declare function UserProfileLink({ children }: PropsWithChildren<UserProfileLinkProps>): React.JSX.Element;
|
|
78
|
+
declare const _UserProfile: {
|
|
79
|
+
(props: Without<WithClerkProp<PropsWithChildren<Without<UserProfileProps, "customPages">> & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
80
|
+
displayName: string;
|
|
81
|
+
};
|
|
82
|
+
declare const UserProfile: UserProfileExportType;
|
|
83
|
+
declare const _UserButton: {
|
|
84
|
+
(props: Without<WithClerkProp<PropsWithChildren<UserButtonPropsWithoutCustomPages> & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
85
|
+
displayName: string;
|
|
86
|
+
};
|
|
87
|
+
declare function MenuItems({ children }: PropsWithChildren): React.JSX.Element;
|
|
88
|
+
declare function MenuAction({ children }: PropsWithChildren<UserButtonActionProps>): React.JSX.Element;
|
|
89
|
+
declare function MenuLink({ children }: PropsWithChildren<UserButtonLinkProps>): React.JSX.Element;
|
|
90
|
+
declare function UserButtonOutlet(outletProps: Without<UserButtonProps, 'userProfileProps'>): React.JSX.Element;
|
|
91
|
+
declare const UserButton: UserButtonExportType;
|
|
92
|
+
declare function OrganizationProfilePage({ children }: PropsWithChildren<OrganizationProfilePageProps>): React.JSX.Element;
|
|
93
|
+
declare function OrganizationProfileLink({ children }: PropsWithChildren<OrganizationProfileLinkProps>): React.JSX.Element;
|
|
94
|
+
declare const _OrganizationProfile: {
|
|
95
|
+
(props: Without<WithClerkProp<PropsWithChildren<Without<OrganizationProfileProps, "customPages">> & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
96
|
+
displayName: string;
|
|
97
|
+
};
|
|
98
|
+
declare const OrganizationProfile: OrganizationProfileExportType;
|
|
99
|
+
declare const CreateOrganization: {
|
|
100
|
+
(props: Without<WithClerkProp<CreateOrganizationProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
101
|
+
displayName: string;
|
|
102
|
+
};
|
|
103
|
+
declare const _OrganizationSwitcher: {
|
|
104
|
+
(props: Without<WithClerkProp<PropsWithChildren<OrganizationSwitcherPropsWithoutCustomPages> & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
105
|
+
displayName: string;
|
|
106
|
+
};
|
|
107
|
+
declare function OrganizationSwitcherOutlet(outletProps: Without<OrganizationSwitcherProps, 'organizationProfileProps'>): React.JSX.Element;
|
|
108
|
+
declare const OrganizationSwitcher: OrganizationSwitcherExportType;
|
|
109
|
+
declare const OrganizationList: {
|
|
110
|
+
(props: Without<WithClerkProp<OrganizationListProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
111
|
+
displayName: string;
|
|
112
|
+
};
|
|
113
|
+
declare const GoogleOneTap: {
|
|
114
|
+
(props: Without<WithClerkProp<_clerk_shared_types.SignInForceRedirectUrl & _clerk_shared_types.SignUpForceRedirectUrl & {
|
|
115
|
+
cancelOnTapOutside?: boolean;
|
|
116
|
+
itpSupport?: boolean;
|
|
117
|
+
fedCmSupport?: boolean;
|
|
118
|
+
appearance?: _clerk_shared_types.SignInTheme;
|
|
119
|
+
} & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
120
|
+
displayName: string;
|
|
121
|
+
};
|
|
122
|
+
declare const Waitlist: {
|
|
123
|
+
(props: Without<WithClerkProp<WaitlistProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
124
|
+
displayName: string;
|
|
125
|
+
};
|
|
126
|
+
declare const PricingTable: {
|
|
127
|
+
(props: Without<WithClerkProp<{
|
|
128
|
+
for?: _clerk_shared_types.ForPayerType;
|
|
129
|
+
appearance?: _clerk_shared_types.PricingTableTheme;
|
|
130
|
+
checkoutProps?: Pick<_clerk_shared_types.__internal_CheckoutProps, "appearance">;
|
|
131
|
+
} & {
|
|
132
|
+
ctaPosition?: "top" | "bottom";
|
|
133
|
+
collapseFeatures?: boolean;
|
|
134
|
+
newSubscriptionRedirectUrl?: string;
|
|
135
|
+
} & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
136
|
+
displayName: string;
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* @experimental This component is in early access and may change in future releases.
|
|
140
|
+
*/
|
|
141
|
+
declare const APIKeys: {
|
|
142
|
+
(props: Without<WithClerkProp<APIKeysProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
143
|
+
displayName: string;
|
|
144
|
+
};
|
|
145
|
+
declare const UserAvatar: {
|
|
146
|
+
(props: Without<WithClerkProp<UserAvatarProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
147
|
+
displayName: string;
|
|
148
|
+
};
|
|
149
|
+
declare const TaskChooseOrganization: {
|
|
150
|
+
(props: Without<WithClerkProp<TaskChooseOrganizationProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
151
|
+
displayName: string;
|
|
152
|
+
};
|
|
153
|
+
|
|
154
|
+
declare const SignInButton: {
|
|
155
|
+
(props: _clerk_shared_types.Without<WithClerkProp<React.PropsWithChildren<SignInButtonProps>>, "clerk">): React.JSX.Element | null;
|
|
156
|
+
displayName: string;
|
|
157
|
+
};
|
|
158
|
+
|
|
159
|
+
declare const SignInWithMetamaskButton: {
|
|
160
|
+
(props: _clerk_shared_types.Without<WithClerkProp<SignInWithMetamaskButtonProps>, "clerk">): React.JSX.Element | null;
|
|
161
|
+
displayName: string;
|
|
162
|
+
};
|
|
163
|
+
|
|
164
|
+
type SignOutButtonProps = {
|
|
165
|
+
redirectUrl?: string;
|
|
166
|
+
signOutOptions?: SignOutOptions;
|
|
167
|
+
children?: React.ReactNode;
|
|
168
|
+
};
|
|
169
|
+
declare const SignOutButton: {
|
|
170
|
+
(props: _clerk_shared_types.Without<React.PropsWithChildren<WithClerkProp<SignOutButtonProps>>, "clerk">): React.JSX.Element | null;
|
|
171
|
+
displayName: string;
|
|
172
|
+
};
|
|
173
|
+
|
|
174
|
+
declare const SignUpButton: {
|
|
175
|
+
(props: _clerk_shared_types.Without<WithClerkProp<React.PropsWithChildren<SignUpButtonProps>>, "clerk">): React.JSX.Element | null;
|
|
176
|
+
displayName: string;
|
|
177
|
+
};
|
|
178
|
+
|
|
179
|
+
declare const ClerkProvider: React.ComponentType<ClerkProviderProps>;
|
|
180
|
+
|
|
181
|
+
type UseEmailLinkSignInReturn = CreateEmailLinkFlowReturn<SignInStartEmailLinkFlowParams, SignInResource>;
|
|
182
|
+
type UseEmailLinkSignUpReturn = CreateEmailLinkFlowReturn<StartEmailLinkFlowParams, SignUpResource>;
|
|
183
|
+
type UseEmailLinkEmailAddressReturn = CreateEmailLinkFlowReturn<StartEmailLinkFlowParams, EmailAddressResource>;
|
|
184
|
+
declare function useEmailLink(resource: SignInResource): UseEmailLinkSignInReturn;
|
|
185
|
+
declare function useEmailLink(resource: SignUpResource): UseEmailLinkSignUpReturn;
|
|
186
|
+
declare function useEmailLink(resource: EmailAddressResource): UseEmailLinkEmailAddressReturn;
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* This hook allows you to access the Signal-based `SignIn` resource.
|
|
190
|
+
*
|
|
191
|
+
* @example
|
|
192
|
+
* import { useSignInSignal } from "@clerk/react/experimental";
|
|
193
|
+
*
|
|
194
|
+
* function SignInForm() {
|
|
195
|
+
* const { signIn, errors, fetchStatus } = useSignInSignal();
|
|
196
|
+
* //
|
|
197
|
+
* }
|
|
198
|
+
*
|
|
199
|
+
* @experimental This experimental API is subject to change.
|
|
200
|
+
*/
|
|
201
|
+
declare function useSignIn(): SignInSignalValue;
|
|
202
|
+
/**
|
|
203
|
+
* This hook allows you to access the Signal-based `SignUp` resource.
|
|
204
|
+
*
|
|
205
|
+
* @example
|
|
206
|
+
* import { useSignUpSignal } from "@clerk/react/experimental";
|
|
207
|
+
*
|
|
208
|
+
* function SignUpForm() {
|
|
209
|
+
* const { signUp, errors, fetchStatus } = useSignUpSignal();
|
|
210
|
+
* //
|
|
211
|
+
* }
|
|
212
|
+
*
|
|
213
|
+
* @experimental This experimental API is subject to change.
|
|
214
|
+
*/
|
|
215
|
+
declare function useSignUp(): SignUpSignalValue;
|
|
216
|
+
|
|
217
|
+
export { APIKeys, ClerkProvider, ClerkProviderProps, CreateOrganization, GoogleOneTap, OrganizationList, OrganizationProfile, OrganizationSwitcher, PricingTable, SignIn, SignInButton, SignInWithMetamaskButton, SignOutButton, SignUp, SignUpButton, TaskChooseOrganization, UserAvatar, UserButton, UserProfile, Waitlist, useEmailLink, useSignIn, useSignUp };
|