Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

fix(docs): address product switcher review

Brendan O'Leary72dbbcbee7d1
diff --git a/docs/components/docs-product-context.tsx b/docs/components/docs-product-context.tsx
index 4fd74415d..3251d6a7f 100644
--- a/docs/components/docs-product-context.tsx
+++ b/docs/components/docs-product-context.tsx
@@ -12,10 +12,8 @@ import {
} from 'react';
import { flushSync } from 'react-dom';
import { usePathname, useRouter } from 'next/navigation';
-import { useTheme } from 'fumadocs-ui/provider/base';
import {
classifyDocsProduct,
- DOCS_PRODUCTS,
serializeDocsProductCookie,
shouldAnimateDocsProductSwitch,
type DocsProduct,
@@ -56,7 +54,6 @@ export function DocsProductProvider({
}) {
const pathname = usePathname();
const router = useRouter();
- const { setTheme } = useTheme();
const [persistedProduct, setPersistedProduct] = useState(initialProduct);
const [pendingProduct, setPendingProduct] = useState<DocsProduct | null>(null);
const pendingNavigation = useRef<{
@@ -104,9 +101,8 @@ export function DocsProductProvider({
flushSync(() => {
setPersistedProduct(nextProduct);
setPendingProduct(nextProduct);
- setTheme(DOCS_PRODUCTS[nextProduct].defaultTheme);
});
- router.push(href);
+ if (href !== pathname) router.push(href);
};
const viewTransitionDocument = document as ViewTransitionDocument;
@@ -137,19 +133,28 @@ export function DocsProductProvider({
root.style.removeProperty('--docs-reveal-x');
root.style.removeProperty('--docs-reveal-y');
};
- window.setTimeout(cleanup, 6000);
+ window.setTimeout(cleanup, 2500);
try {
const transition = startViewTransition(() => {
+ if (href === pathname) {
+ commitNavigation();
+ return;
+ }
+
return new Promise<void>(resolve => {
pendingNavigation.current?.resolve();
- const timeout = window.setTimeout(resolve, 5000);
+ const finish = () => resolve();
+ window.setTimeout(() => {
+ if (pendingNavigation.current?.resolve === finish) {
+ pendingNavigation.current = null;
+ setPendingProduct(null);
+ }
+ finish();
+ }, 1500);
pendingNavigation.current = {
from: pathname,
- resolve: () => {
- window.clearTimeout(timeout);
- resolve();
- },
+ resolve: finish,
};
commitNavigation();
});
@@ -160,7 +165,7 @@ export function DocsProductProvider({
commitNavigation();
}
},
- [pathname, router, setTheme],
+ [pathname, router],
);
const value = useMemo(
diff --git a/docs/components/product-lockup.tsx b/docs/components/product-lockup.tsx
index a09ef4429..64f95944d 100644
--- a/docs/components/product-lockup.tsx
+++ b/docs/components/product-lockup.tsx
@@ -53,6 +53,27 @@ export function ProductBadge({ product }: { product: DocsProduct }) {
);
}
+export function ComposioWordmark({ compactOnMobile = false }: { compactOnMobile?: boolean }) {
+ return (
+ <span className={compactOnMobile ? 'max-[420px]:hidden' : undefined}>
+ <Image
+ alt="Composio"
+ className="h-[22px] w-auto dark:hidden"
+ height={20}
+ src="/Composio Logo.svg"
+ width={110}
+ />
+ <Image
+ alt="Composio"
+ className="hidden h-[22px] w-auto dark:block"
+ height={20}
+ src="/Composio Logo Dark.svg"
+ width={110}
+ />
+ </span>
+ );
+}
+
export function ProductLockup({
product,
compactOnMobile = false,
@@ -62,24 +83,7 @@ export function ProductLockup({
}) {
return (
<span className="inline-flex min-w-0 items-center gap-2">
- <span className={compactOnMobile ? 'max-[420px]:hidden' : undefined}>
- <Image
- alt="Composio"
- className="h-[22px] w-auto dark:hidden"
- height={20}
- priority
- src="/Composio Logo.svg"
- width={110}
- />
- <Image
- alt="Composio"
- className="hidden h-[22px] w-auto dark:block"
- height={20}
- priority
- src="/Composio Logo Dark.svg"
- width={110}
- />
- </span>
+ <ComposioWordmark compactOnMobile={compactOnMobile} />
<ProductBadge product={product} />
</span>
);
diff --git a/docs/components/product-selection-link.tsx b/docs/components/product-selection-link.tsx
index b3c8ccad8..d347b893f 100644
--- a/docs/components/product-selection-link.tsx
+++ b/docs/components/product-selection-link.tsx
@@ -1,13 +1,14 @@
'use client';
-import Link, { type LinkProps } from 'next/link';
+import Link from 'next/link';
import type { AnchorHTMLAttributes, MouseEvent, ReactNode } from 'react';
import type { DocsProduct } from '@/lib/home-navigation';
import { useDocsProduct } from './docs-product-context';
-type ProductSelectionLinkProps = LinkProps &
- Omit<AnchorHTMLAttributes<HTMLAnchorElement>, keyof LinkProps> & {
+type ProductSelectionLinkProps =
+ Omit<AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> & {
children: ReactNode;
+ href: string;
product: DocsProduct;
};
@@ -32,7 +33,7 @@ export function ProductSelectionLink({
}
event.preventDefault();
- navigateToProduct(product, String(href), event.currentTarget);
+ navigateToProduct(product, href, event.currentTarget);
};
return (
diff --git a/docs/components/product-switcher.tsx b/docs/components/product-switcher.tsx
index d81f6076b..7e8a9a642 100644
--- a/docs/components/product-switcher.tsx
+++ b/docs/components/product-switcher.tsx
@@ -1,7 +1,8 @@
'use client';
-import { useRef, useState } from 'react';
+import { useState } from 'react';
import type { ComponentProps } from 'react';
+import Link from 'next/link';
import { usePathname, useRouter } from 'next/navigation';
import { Check, ChevronsUpDown } from 'lucide-react';
import {
@@ -13,31 +14,19 @@ import {
DOCS_PRODUCT_ORDER,
DOCS_PRODUCTS,
docsProductDestination,
- type DocsProduct,
} from '@/lib/home-navigation';
-import { ProductLockup } from './product-lockup';
+import { ComposioWordmark, ProductBadge, ProductLockup } from './product-lockup';
+import { ProductSelectionLink } from './product-selection-link';
import { useDocsProduct } from './docs-product-context';
import { cn } from '@/lib/utils';
export function ProductSwitcher({ placement = 'sidebar' }: { placement?: 'nav' | 'sidebar' }) {
const pathname = usePathname();
const router = useRouter();
- const { product, navigateToProduct } = useDocsProduct();
+ const { product } = useDocsProduct();
const [open, setOpen] = useState(false);
- const triggerRef = useRef<HTMLButtonElement>(null);
const current = DOCS_PRODUCTS[product];
- const selectProduct = (nextProduct: DocsProduct) => {
- if (nextProduct === product) {
- setOpen(false);
- return;
- }
-
- const destination = docsProductDestination(pathname, nextProduct);
- setOpen(false);
- navigateToProduct(nextProduct, destination, triggerRef.current);
- };
-
return (
<Popover open={open} onOpenChange={setOpen}>
<PopoverTrigger asChild>
@@ -65,10 +54,13 @@ export function ProductSwitcher({ placement = 'sidebar' }: { placement?: 'nav' |
}
}
}}
- ref={triggerRef}
type="button"
>
- <ProductLockup compactOnMobile={placement === 'nav'} product={product} />
+ {placement === 'nav' ? (
+ <ProductBadge product={product} />
+ ) : (
+ <ProductLockup product={product} />
+ )}
<span className="inline-flex shrink-0 items-center gap-1 text-xs font-medium text-fd-muted-foreground group-hover:text-fd-foreground">
{placement === 'sidebar' && 'Switch'}
<ChevronsUpDown aria-hidden="true" className="size-3.5" />
@@ -77,25 +69,28 @@ export function ProductSwitcher({ placement = 'sidebar' }: { placement?: 'nav' |
</PopoverTrigger>
<PopoverContent
align="start"
+ aria-label="Choose a Composio product"
className="w-[min(20rem,calc(100vw-2rem))] p-1"
side="bottom"
sideOffset={8}
>
- <div aria-label="Choose a Composio product" role="radiogroup">
+ <div>
{DOCS_PRODUCT_ORDER.map((productId, index) => {
const option = DOCS_PRODUCTS[productId];
const isCurrent = productId === product;
+ const destination = docsProductDestination(pathname, productId);
return (
<div key={productId}>
{index > 0 && <div aria-hidden="true" className="mx-2 my-1 h-px bg-fd-border" />}
- <button
- aria-checked={isCurrent}
+ <ProductSelectionLink
aria-current={isCurrent ? 'page' : undefined}
- aria-label={`${option.product}: ${option.switcherDescription}`}
className="flex w-full items-start gap-3 p-2.5 text-left transition-colors hover:bg-fd-accent/60 focus-visible:outline-2 focus-visible:outline-offset-[-2px] focus-visible:outline-fd-ring"
- onClick={() => selectProduct(productId)}
- role="radio"
- type="button"
+ href={destination}
+ onClick={event => {
+ setOpen(false);
+ if (isCurrent) event.preventDefault();
+ }}
+ product={productId}
>
<span className="flex min-w-0 flex-1 flex-col gap-2">
<ProductLockup product={productId} />
@@ -107,7 +102,7 @@ export function ProductSwitcher({ placement = 'sidebar' }: { placement?: 'nav' |
aria-hidden="true"
className={`mt-1 size-4 shrink-0 text-fd-primary ${isCurrent ? '' : 'invisible'}`}
/>
- </button>
+ </ProductSelectionLink>
</div>
);
})}
@@ -119,7 +114,14 @@ export function ProductSwitcher({ placement = 'sidebar' }: { placement?: 'nav' |
export function ProductNavTitle({ className }: ComponentProps<'a'>) {
return (
- <div className={cn(className, 'min-w-0')}>
+ <div className={cn(className, 'flex min-w-0 items-center gap-1')}>
+ <Link
+ aria-label="Composio home"
+ className="shrink-0 rounded-sm px-1.5 max-[420px]:hidden"
+ href="/"
+ >
+ <ComposioWordmark />
+ </Link>
<ProductSwitcher placement="nav" />
</div>
);
diff --git a/docs/lib/home-navigation.ts b/docs/lib/home-navigation.ts
index dfb4fac2d..b47f30a85 100644
--- a/docs/lib/home-navigation.ts
+++ b/docs/lib/home-navigation.ts
@@ -29,15 +29,18 @@ interface DocsProductConfig {
product: HomeIntent['product'];
switcherDescription: string;
landingRoute: string;
- defaultTheme: 'light' | 'dark';
routePrefixes: readonly string[];
sidebar: readonly ProductSidebarGroup[];
home: Omit<HomeIntent, 'productId' | 'product'>;
}
-const SHARED_SIDEBAR_ITEMS = [
+const SHARED_SIDEBAR_ITEMS: readonly ProductSidebarItem[] = [
{ type: 'folder', path: 'security', label: 'Security and data' },
-] as const satisfies readonly ProductSidebarItem[];
+];
+
+const SHARED_ROUTE_PREFIXES = SHARED_SIDEBAR_ITEMS.map(item =>
+ item.type === 'page' ? item.url : `/docs/${item.path}`,
+);
/**
* Canonical product model for the docs shell and homepage.
@@ -56,7 +59,6 @@ export const DOCS_PRODUCTS = {
product: 'For You',
switcherDescription: 'Connect your apps to AI clients.',
landingRoute: '/docs/agent-plugins',
- defaultTheme: 'light',
routePrefixes: [
'/docs/agent-plugins',
'/docs/claude-code-plugin',
@@ -102,7 +104,6 @@ export const DOCS_PRODUCTS = {
product: 'Platform',
switcherDescription: 'Build agents with the Composio SDK.',
landingRoute: '/docs/quickstart',
- defaultTheme: 'dark',
routePrefixes: [
'/docs/quickstart',
'/docs/providers',
@@ -228,7 +229,9 @@ export function resolveDocsProduct(
export function docsProductDestination(pathname: string, target: DocsProduct): string {
const sourceProduct = target === 'platform' ? 'for-you' : 'platform';
const counterpart = PRODUCT_COUNTERPARTS.find(pair => matchesRoute(pathname, pair[sourceProduct]));
- return counterpart?.[target] ?? DOCS_PRODUCTS[target].landingRoute;
+ if (counterpart) return counterpart[target];
+ if (SHARED_ROUTE_PREFIXES.some(prefix => matchesRoute(pathname, prefix))) return pathname;
+ return DOCS_PRODUCTS[target].landingRoute;
}
export function serializeDocsProductCookie(product: DocsProduct): string {
diff --git a/docs/lib/layout.shared.tsx b/docs/lib/layout.shared.tsx
index 04b4890e9..2bd1ba664 100644
--- a/docs/lib/layout.shared.tsx
+++ b/docs/lib/layout.shared.tsx
@@ -1,40 +1,13 @@
import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';
-import Image from 'next/image';
import { Play } from 'lucide-react';
import { SearchAndAskAI, SearchAndAskAIMobile } from '@/components/ask-ai-button';
import { NavVersionSelector } from '@/components/version-selector';
import { ProductNavTitle } from '@/components/product-switcher';
-// Composio Logo Component with light/dark mode switching
-function ComposioLogo() {
- return (
- <>
- {/* Light mode logo (black) */}
- <Image
- src="/Composio Logo.svg"
- alt="Composio"
- width={110}
- height={20}
- className="dark:hidden"
- priority
- />
- {/* Dark mode logo (white) */}
- <Image
- src="/Composio Logo Dark.svg"
- alt="Composio"
- width={110}
- height={20}
- className="hidden dark:block"
- priority
- />
- </>
- );
-}
-
export function baseOptions(): BaseLayoutProps {
return {
nav: {
- title: <ComposioLogo />,
+ title: null,
transparentMode: 'top',
},
slots: { navTitle: ProductNavTitle },
diff --git a/docs/tests/static/product-navigation.test.ts b/docs/tests/static/product-navigation.test.ts
index 4ffc8dcb2..005900315 100644
--- a/docs/tests/static/product-navigation.test.ts
+++ b/docs/tests/static/product-navigation.test.ts
@@ -14,19 +14,17 @@ import { buildProductPageTree, pageTreeUrls } from '../../lib/product-page-tree'
import { source } from '../../lib/source';
describe('Docs product navigation', () => {
- test('defines the product labels, descriptions, landings, and theme defaults once', () => {
+ test('defines the product labels, descriptions, and landings once', () => {
expect(DEFAULT_DOCS_PRODUCT).toBe('platform');
expect(DOCS_PRODUCTS['for-you']).toMatchObject({
product: 'For You',
switcherDescription: 'Connect your apps to AI clients.',
landingRoute: '/docs/agent-plugins',
- defaultTheme: 'light',
});
expect(DOCS_PRODUCTS.platform).toMatchObject({
product: 'Platform',
switcherDescription: 'Build agents with the Composio SDK.',
landingRoute: '/docs/quickstart',
- defaultTheme: 'dark',
});
});
@@ -69,6 +67,12 @@ describe('Docs product navigation', () => {
'/docs/agent-plugins',
);
expect(docsProductDestination('/docs/cli', 'platform')).toBe('/docs/quickstart');
+ expect(docsProductDestination('/docs/security/overview', 'for-you')).toBe(
+ '/docs/security/overview',
+ );
+ expect(docsProductDestination('/docs/security/data-retention', 'platform')).toBe(
+ '/docs/security/data-retention',
+ );
});
test('animates only when view transitions are available and motion is allowed', () => {
@@ -122,6 +126,13 @@ describe('Docs product navigation', () => {
expect(forYouUrls).toContain(sharedUrl);
expect(platformUrls).toContain(sharedUrl);
}
+
+ const coveredUrls = new Set([...forYouUrls, ...platformUrls]);
+ const excludedUrls = new Set(['/docs']);
+ const omittedUrls = pageTreeUrls(source.pageTree).filter(
+ url => !coveredUrls.has(url) && !excludedUrls.has(url),
+ );
+ expect(omittedUrls).toEqual([]);
});
test('keeps accessibility-critical switcher semantics and visible focus styles', async () => {
@@ -133,11 +144,14 @@ describe('Docs product navigation', () => {
).text();
expect(switcherSource).toContain('aria-label={`Switch Composio product. Current product:');
- expect(switcherSource).toContain('role="radiogroup"');
- expect(switcherSource).toContain('role="radio"');
- expect(switcherSource).toContain('aria-checked={isCurrent}');
+ expect(switcherSource).toContain('ProductSelectionLink');
+ expect(switcherSource).not.toContain('role="radiogroup"');
+ expect(switcherSource).not.toContain('role="radio"');
+ expect(switcherSource).not.toContain('aria-checked={isCurrent}');
expect(switcherSource).toContain("aria-current={isCurrent ? 'page' : undefined}");
expect(switcherSource).toContain('focus-visible:outline-2');
+ expect(switcherSource).toContain('aria-label="Composio home"');
+ expect(switcherSource).toContain('href="/"');
expect(sharedLayoutSource).toContain('slots: { navTitle: ProductNavTitle }');
});
});