You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 5d845e9
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/_partials/clerk-middleware-options.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ The `clerkMiddleware()` function accepts an optional object. The following optio
11
11
-`authorizedParties?`
12
12
-`string[]`
13
13
14
-
An allowlist of origins to verify against, to protect your application from the subdomain cookie leaking attack.<br />For example: `['http://localhost:3000', 'https://example.com']`
14
+
An allowlist of origins to verify against, to protect your application from the subdomain cookie leaking attack.For example: `['http://localhost:3000', 'https://example.com']`
Copy file name to clipboardExpand all lines: docs/_partials/root-auth-loader.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ The `rootAuthLoader()` function accepts an optional object. The following option
11
11
-`authorizedParties?`
12
12
-`string[]`
13
13
14
-
An allowlist of origins to verify against, to protect your application from the subdomain cookie leaking attack.<br />For example: `['http://localhost:3000', 'https://example.com']`
14
+
An allowlist of origins to verify against, to protect your application from the subdomain cookie leaking attack.For example: `['http://localhost:3000', 'https://example.com']`
Copy file name to clipboardExpand all lines: docs/backend-requests/handling/nodejs.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -172,7 +172,7 @@ These options can be used with both [`ClerkExpressWithAuth`](#clerk-express-with
172
172
-`authorizedParties?`
173
173
-`string[]`
174
174
175
-
An allowlist of origins to verify against, to protect your application from the subdomain cookie leaking attack.<br />For example: `['http://localhost:3000', 'https://example.com']`
175
+
An allowlist of origins to verify against, to protect your application from the subdomain cookie leaking attack.For example: `['http://localhost:3000', 'https://example.com']`
Copy file name to clipboardExpand all lines: docs/components/authentication/sign-in.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,21 +25,21 @@ All props are optional.
25
25
-`routing`
26
26
-`'hash' | 'path'`
27
27
28
-
The [routing](/docs/how-clerk-works/routing) strategy for your pages.<br />Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.
28
+
The [routing](/docs/how-clerk-works/routing) strategy for your pages.Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.
29
29
30
30
---
31
31
32
32
-`path`
33
33
-`string`
34
34
35
-
The path where the component is mounted on when `routing` is set to `path`. It is ignored in hash- and virtual-based routing.<br />For example: `/sign-in`.
35
+
The path where the component is mounted on when `routing` is set to `path`. It is ignored in hash-based routing.For example: `/sign-in`.
36
36
37
37
---
38
38
39
39
-`signUpUrl`
40
40
-`string`
41
41
42
-
Used for the 'Sign Up' link that's rendered.<br />The full URL or path to the sign-up page. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
42
+
Used for the 'Sign Up' link that's rendered.The full URL or path to the sign-up page. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
43
43
44
44
---
45
45
@@ -60,14 +60,14 @@ All props are optional.
60
60
-`signUpForceRedirectUrl?`
61
61
-`string`
62
62
63
-
Used for the 'Sign Up' link that's rendered.<br />If provided, this URL will always used as the redirect destination after the user signs up. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
63
+
Used for the 'Sign Up' link that's rendered.If provided, this URL will always used as the redirect destination after the user signs up. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
64
64
65
65
---
66
66
67
67
-`signUpFallbackRedirectUrl?`
68
68
-`string`
69
69
70
-
Used for the 'Sign Up' link that's rendered.<br />The fallback URL to redirect to after the user signs up, if there's no `redirect_url` in the path already. Defaults to `/`. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
70
+
Used for the 'Sign Up' link that's rendered.The fallback URL to redirect to after the user signs up, if there's no `redirect_url` in the path already. Defaults to `/`. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
Copy file name to clipboardExpand all lines: docs/components/authentication/sign-up.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,21 +25,21 @@ All props are optional.
25
25
-`routing`
26
26
-`'hash' | 'path'`
27
27
28
-
The [routing](/docs/how-clerk-works/routing) strategy for your pages. <br />Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.
28
+
The [routing](/docs/how-clerk-works/routing) strategy for your pages. Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.
29
29
30
30
---
31
31
32
32
-`path`
33
33
-`string`
34
34
35
-
The path where the component is mounted on when `routing` is set to `path`. It is ignored in hash- and virtual-based routing.<br />For example: `/sign-up`.
35
+
The path where the component is mounted on when `routing` is set to `path`. It is ignored in hash-based routing.For example: `/sign-up`.
36
36
37
37
---
38
38
39
39
-`signInUrl`
40
40
-`string`
41
41
42
-
Used for the 'Sign In' link that's rendered.<br />The full URL or path to the sign-in page. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
42
+
Used for the 'Sign In' link that's rendered.The full URL or path to the sign-in page. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
43
43
44
44
---
45
45
@@ -60,14 +60,14 @@ All props are optional.
60
60
-`signInForceRedirectUrl?`
61
61
-`string`
62
62
63
-
Used for the 'Sign In' link that's rendered.<br />If provided, this URL will always be redirected to after the user signs in. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
63
+
Used for the 'Sign In' link that's rendered.If provided, this URL will always be redirected to after the user signs in. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
64
64
65
65
---
66
66
67
67
-`signInFallbackRedirectUrl?`
68
68
-`string`
69
69
70
-
Used for the 'Sign In' link that's rendered.<br />The fallback URL to redirect to after the user signs in, if there's no `redirect_url` in the path already. Defaults to `/`. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
70
+
Used for the 'Sign In' link that's rendered.The fallback URL to redirect to after the user signs in, if there's no `redirect_url` in the path already. Defaults to `/`. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
Copy file name to clipboardExpand all lines: docs/components/organization/create-organization.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,14 +29,14 @@ All props are optional.
29
29
-`routing`
30
30
-`'hash' | 'path'`
31
31
32
-
The [routing](/docs/how-clerk-works/routing) strategy for your pages. <br />Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.
32
+
The [routing](/docs/how-clerk-works/routing) strategy for your pages. Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.
33
33
34
34
---
35
35
36
36
-`path`
37
37
-`string`
38
38
39
-
The path where the component is mounted on when `routing` is set to `path`. It is ignored in hash- and virtual-based routing.<br />For example: `/create-organization`.
39
+
The path where the component is mounted on when `routing` is set to `path`. It is ignored in hash-based routing.For example: `/create-organization`.
Copy file name to clipboardExpand all lines: docs/components/organization/organization-list.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,14 +15,14 @@ All props are optional.
15
15
-`hidePersonal`
16
16
-`boolean`
17
17
18
-
By default, users can switch between organization and their personal account. This option controls whether `<OrganizationList />` will include the user's personal account in the organization list. Setting this to `false` will hide the personal account entry, and users will only be able to switch between organizations. <br />Defaults to `false`.
18
+
By default, users can switch between organization and their personal account. This option controls whether `<OrganizationList />` will include the user's personal account in the organization list. Setting this to `false` will hide the personal account entry, and users will only be able to switch between organizations. Defaults to `false`.
19
19
20
20
---
21
21
22
22
-`skipInvitationScreen`
23
23
-`boolean | undefined`
24
24
25
-
Hides the screen for sending invitations after an organization is created. When left undefined Clerk will automatically hide the screen if the number of max allowed members is equal to 1.<br />Defaults to `false`.
25
+
Hides the screen for sending invitations after an organization is created. When left undefined Clerk will automatically hide the screen if the number of max allowed members is equal to 1.Defaults to `false`.
Copy file name to clipboardExpand all lines: docs/components/organization/organization-profile.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,14 +33,14 @@ All props are optional.
33
33
-`routing`
34
34
-`'hash' | 'path'`
35
35
36
-
The [routing](/docs/how-clerk-works/routing) strategy for your pages. <br />Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.
36
+
The [routing](/docs/how-clerk-works/routing) strategy for your pages. Defaults to `'path'` for frameworks that handle routing, such as Next.js and Remix. Defaults to `hash` for all other SDK's, such as React.
37
37
38
38
---
39
39
40
40
-`path`
41
41
-`string`
42
42
43
-
The path where the component is mounted on when `routing` is set to `path`. It is ignored in hash- and virtual-based routing.<br />For example: `/organization-profile`.
43
+
The path where the component is mounted on when `routing` is set to `path`. It is ignored in hash-based routing.For example: `/organization-profile`.
Copy file name to clipboardExpand all lines: docs/components/organization/organization-switcher.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,14 +47,14 @@ All props below are optional.
47
47
-`createOrganizationMode`
48
48
-`'modal' | 'navigation'`
49
49
50
-
Controls whether clicking the "Create organization" button will cause the [`<CreateOrganization />`][createorg-ref] component to open as a modal, or if the browser will navigate to the `createOrganizationUrl` where `<CreateOrganization />` is mounted as a page.<br />Defaults to: `'modal'`.
50
+
Controls whether clicking the "Create organization" button will cause the [`<CreateOrganization />`][createorg-ref] component to open as a modal, or if the browser will navigate to the `createOrganizationUrl` where `<CreateOrganization />` is mounted as a page.Defaults to: `'modal'`.
51
51
52
52
---
53
53
54
54
-`organizationProfileMode`
55
55
-`'modal' | 'navigation'`
56
56
57
-
Controls whether clicking the **Manage organization** button will cause the [`<OrganizationProfile />`][orgprofile-ref] component to open as a modal, or if the browser will navigate to the `organizationProfileUrl` where `<OrganizationProfile />` is mounted as a page.<br />Defaults to: `'modal'`.
57
+
Controls whether clicking the **Manage organization** button will cause the [`<OrganizationProfile />`][orgprofile-ref] component to open as a modal, or if the browser will navigate to the `organizationProfileUrl` where `<OrganizationProfile />` is mounted as a page.Defaults to: `'modal'`.
58
58
59
59
---
60
60
@@ -75,7 +75,7 @@ All props below are optional.
75
75
-`hidePersonal`
76
76
-`boolean`
77
77
78
-
By default, users can switch between organizations and their personal workspace. This option controls whether `<OrganizationSwitcher />` will include the user's personal workspace in the organization list. Setting this to `true` will hide the personal workspace entry, and allow users to switch only between organizations.<br />Defaults to: `false`.
78
+
By default, users can switch between organizations and their personal workspace. This option controls whether `<OrganizationSwitcher />` will include the user's personal workspace in the organization list. Setting this to `true` will hide the personal workspace entry, and allow users to switch only between organizations.Defaults to: `false`.
79
79
80
80
---
81
81
@@ -89,7 +89,7 @@ All props below are optional.
89
89
-`organizationProfileProps`
90
90
-`object`
91
91
92
-
Specify options for the underlying [`<OrganizationProfile />`][orgprofile-ref] component.<br />For example: `{appearance: {...}}`
92
+
Specify options for the underlying [`<OrganizationProfile />`][orgprofile-ref] component.For example: `{appearance: {...}}`
Copy file name to clipboardExpand all lines: docs/components/unstyled/sign-in-button.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ The `<SignInButton>` component is a button that links to the sign-in page or dis
46
46
-`mode?`
47
47
-`'redirect' | 'modal'`
48
48
49
-
Determines what happens when a user clicks on the `<SignInButton>`. Setting this to `'redirect'` will redirect the user to the sign-in route. Setting this to `'modal'` will open a modal on the current route.<br />Defaults to `'redirect'`.
49
+
Determines what happens when a user clicks on the `<SignInButton>`. Setting this to `'redirect'` will redirect the user to the sign-in route. Setting this to `'modal'` will open a modal on the current route.Defaults to `'redirect'`.
0 commit comments