feat: Add allowedRedirectProtocols documentation (#1767)

clerk · Dec 11, 2024 · 7177bf3 · 7177bf3
1 parent f34168a
commit 7177bf3
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 5 deletions.
diff --git a/docs/components/clerk-provider.mdx b/docs/components/clerk-provider.mdx
@@ -90,7 +90,14 @@ The recommended approach is to wrap your entire app with `<ClerkProvider>` at th
   - `allowedRedirectOrigins?`
   - `Array<string | RegExp>`
 
-  Optional array of domains used to validate against the query param of an auth redirect. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning passed to the console.
+  An optional array of domains to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console.
+
+  ---
+
+  - `allowedRedirectProtocols?`
+  - `Array<string>`
+
+  An optional array of protocols to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console.
 
   ---
 

diff --git a/docs/references/javascript/clerk/clerk.mdx b/docs/references/javascript/clerk/clerk.mdx
@@ -457,10 +457,17 @@ All props below are optional.
 
   ---
 
-  - `allowedRedirectOrigins`
-  - `Array<string | RegExp> | undefined`
+  - `allowedRedirectOrigins?`
+  - `Array<string | RegExp>`
 
-  Optional array of domains used to validate against the query param of an auth redirect.<br />If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning passed to the console.
+  An optional array of domains to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console.
+
+  ---
+
+  - `allowedRedirectProtocols?`
+  - `Array<string>`
+
+  An optional array of protocols to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console.
 
   ---
 

diff --git a/docs/references/remix/clerk-app.mdx b/docs/references/remix/clerk-app.mdx
@@ -80,7 +80,14 @@ export default ClerkApp(App)
   - `allowedRedirectOrigins?`
   - `Array<string | RegExp>`
 
-  Optional array of domains used to validate against the query param of an auth redirect. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning passed to the console.
+  An optional array of domains to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console.
+
+  ---
+
+  - `allowedRedirectProtocols?`
+  - `Array<string>`
+
+  An optional array of protocols to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console.
 </Properties>
 
 [components-ref]: /docs/components/overview