From 276b09fc9360a1934e4f46230d6a0b2c6b4057c5 Mon Sep 17 00:00:00 2001
From: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com>
Date: Thu, 12 Dec 2024 17:25:07 -0500
Subject: [PATCH] (chore) DOCS-9680 add list of components to component
reference overview (#1800)
---
docs/components/overview.mdx | 39 +++++++++++++++++++++++++++++++++---
1 file changed, 36 insertions(+), 3 deletions(-)
diff --git a/docs/components/overview.mdx b/docs/components/overview.mdx
index 30ef4f78aa..fbc6b591d8 100644
--- a/docs/components/overview.mdx
+++ b/docs/components/overview.mdx
@@ -5,15 +5,48 @@ description: A list of Clerk's comprehensive suite of components designed to sea
Clerk offers a comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application. With Clerk components, you can easily customize the appearance of authentication components and pages, manage the entire authentication flow to suit your specific needs, and even build robust SaaS applications.
-To get started, select a component from the navigation on the left.
+## UI components
-## What are control components?
+- [``](/docs/components/authentication/sign-in)
+- [``](/docs/components/authentication/sign-up)
+- [``](/docs/components/authentication/google-one-tap)
+- [``](/docs/components/user/user-button)
+- [``](/docs/components/user/user-profile)
+- [``](/docs/components/organization/create-organization)
+- [``](/docs/components/organization/organization-profile)
+- [``](/docs/components/organization/organization-switcher)
+- [``](/docs/components/organization/organization-list)
+- [``](/docs/components/waitlist)
+
+## Control components
+
+{/* TODO(Alexis): update with new callout */}
Control components manage authentication-related behaviors in your application. They handle tasks such as controlling content visibility based on user authentication status, managing loading states during authentication processes, and redirecting users to appropriate pages. Control components render at `` and `` states for assertions on the [`Clerk` object](/docs/references/javascript/clerk/clerk). A common example is the [``](/docs/components/control/signed-in) component, which allows you to conditionally render content only when a user is authenticated.
+- [``](/docs/components/control/authenticate-with-callback)
+- [``](/docs/components/control/clerk-loaded)
+- [``](/docs/components/control/clerk-loading)
+- [``](/docs/components/protect)
+- [``](/docs/components/control/multi-session)
+- [``](/docs/components/control/redirect-to-signin)
+- [``](/docs/components/control/redirect-to-signup)
+- [``](/docs/components/control/redirect-to-userprofile)
+- [``](/docs/components/control/redirect-to-organizationprofile)
+- [``](/docs/components/control/redirect-to-createorganization)
+- [``](/docs/components/control/signed-in)
+- [``](/docs/components/control/signed-out)
+
+## Unstyled components
+
+- [``](/docs/components/unstyled/sign-in-button)
+- [``](/docs/components/unstyled/sign-in-with-metamask)
+- [``](/docs/components/unstyled/sign-up-button)
+- [``](/docs/components/unstyled/sign-out-button)
+
## Customization Guides
-- [Theme components with the appearance prop](/docs/customization/overview)
+- [Customize components with the `appearance` prop](/docs/customization/overview)
- [Localize components with the `localization` prop (experimental)](/docs/customization/localization)
- [Add pages to the `` component](/docs/customization/user-profile)
- [Add pages to the `` component](/docs/customization/organization-profile)