Files
composiohq__composio/docs/mdx-components.tsx
T
Rahul Tarak a13c883845 docs: package-manager picker for install commands (#3802)
## What

Two changes to the docs install experience:

**1. Package-manager picker on install code blocks.** New
`PackageInstall` client component
(`docs/components/package-install.tsx`): the code block's copy button
opens a dropdown of package managers. Selecting one rewrites the
displayed command and copies it to the clipboard.

- TypeScript blocks: npm (default, `npm install`) / pnpm / bun / yarn
(`<pm> add`)
- Python blocks: uv (default, `uv add`) / pip (`pip install`)
- The menu is portaled to `document.body` so it isn't clipped by the
`Tabs`/`CodeBlock` overflow containers, and closes on outside click,
Escape, or real scroll movement.

**2. `@composio/slim` callout in the quickstart.** The quickstart
TypeScript install blocks carry display-only `#` comment lines noting
that `@composio/core` ships its docs and TypeScript source in the
package (inspectable to coding agents) and that `@composio/slim` is the
smaller install with the same API. Comment lines are rendered muted and
are **never copied** — the picker copies only the command.

## Where

Converted every plain `npm install` / `pip install` code block under
`docs/content` (quickstart, all provider pages, single-toolkit MCP,
custom tools, migration guides, standup example, SDK reference indexes).
The TS reference index's manual npm/pnpm/yarn/bun tabs collapse into one
picker. The two SDK-reference generators
(`ts/packages/core/scripts/generate-docs.ts`,
`python/scripts/generate-docs.py`) emit the new component so
regeneration keeps it. Flagged upgrade commands (`pip install
-U/--upgrade`) and the bun-first examples were left as-is.

## Verification

- `bun run types:check` — pass
- `bun run build` — pass
- `eslint` on touched TS files — clean (remaining repo lint errors are
pre-existing on `next`)
- Visual check via dev server + browser: comment lines render muted
below the command, picker opens npm/pnpm/bun/yarn (uv/pip on Python
tabs), selecting a manager rewrites the command, and the clipboard
receives exactly the command with no comment lines.

Docs-only behavior change; no changeset (generator-script edits don't
touch published code).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-10 06:33:42 -07:00

174 lines
5.5 KiB
TypeScript

import defaultMdxComponents from 'fumadocs-ui/mdx';
import type { MDXComponents } from 'mdx/types';
import type { ComponentProps } from 'react';
import { Accordion as BaseAccordion, Accordions } from 'fumadocs-ui/components/accordion';
import { Tabs, Tab, TabsList, TabsTrigger, TabsContent } from 'fumadocs-ui/components/tabs';
import { Callout } from '@/components/callout';
import { Step, Steps } from 'fumadocs-ui/components/steps';
import { Card, Cards } from 'fumadocs-ui/components/card';
import { ImageZoom } from 'fumadocs-ui/components/image-zoom';
import { Heading } from '@/components/heading';
import { YouTube } from '@/components/youtube';
import { ProviderCard, ProviderGrid } from '@/components/provider-card';
import { FrameworkSelector, QuickstartFlow, FrameworkOption } from '@/components/quickstart';
import { IntegrationTabs, IntegrationContent } from '@/components/quickstart/integration-tabs';
import { ToolTypeFlow, ToolTypeOption } from '@/components/tool-type-selector';
import { ConnectFlow, ConnectClientOption } from '@/components/connect-flow';
import { Figure } from '@/components/figure';
import { StepTitle } from '@/components/step-title';
import { Video } from '@/components/video';
import { CapabilityCard, CapabilityList } from '@/components/capability-card';
import { TemplateCard, TemplateGrid } from '@/components/template-card';
import { ToolkitsLanding } from '@/components/toolkits/toolkits-landing';
import { ManagedAuthList } from '@/components/toolkits/managed-auth-list';
import { Mermaid } from '@/components/mermaid';
import { AIToolsBanner } from '@/components/ai-tools-banner';
import { DocsHero } from '@/components/docs-hero';
import { HomeFeatures } from '@/components/home-features';
import { SessionFlow } from '@/components/session-flow';
import { TriggersFlow } from '@/components/triggers-flow';
import { SlackBotFlow } from '@/components/slack-bot-flow';
import { LocalWorkbenchFlow } from '@/components/local-workbench-flow';
import { LocalSandboxBoundary } from '@/components/local-sandbox-boundary';
import { FileBuildup } from '@/components/file-buildup';
import { RepoBrowser } from '@/components/repo-browser';
import { AppLogo } from '@/components/standup-example';
import { ImessageFlow } from '@/components/imessage-flow';
import { WorkbenchFlow } from '@/components/workbench-flow';
import { AuthConfigFlow } from '@/components/auth-config-flow';
import { WhiteLabelFlow } from '@/components/white-label-flow';
import { ImportConnectionFlow } from '@/components/import-connection-flow';
import { HomeSurfaces } from '@/components/home-surfaces';
import { HomeResources } from '@/components/home-resources';
import { Glossary, GlossaryTerm } from '@/components/glossary';
import { ApiBaseUrl } from '@/components/api-base-url';
import { ApiEndpointsTable } from '@/components/api-endpoints-table';
import { ClaudeMockUI } from '@/components/claude-mock-ui';
import { InChatAuthTerminal } from '@/components/in-chat-auth-terminal';
import { MediaSplit } from '@/components/media-split';
import { PackageInstall } from '@/components/package-install';
import { ManageConnectionsVisual } from '@/components/manage-connections-visual';
import { ConnectionRefreshVisual } from '@/components/connection-refresh-visual';
import {
ShieldCheck,
Route as RouteIcon,
Key,
Search,
Wrench,
Database,
Zap,
Rocket,
Code,
Blocks,
Plug,
Play,
Terminal,
Palette,
BookOpen,
Monitor,
MessageCircle,
LayoutDashboard,
} from 'lucide-react';
function slugify(text: string): string {
return text.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/(^-|-$)/g, '');
}
export function Accordion({ id, title, ...props }: ComponentProps<typeof BaseAccordion>) {
return <BaseAccordion id={id ?? (typeof title === 'string' ? slugify(title) : undefined)} title={title} {...props} />;
}
export { Accordions };
export function getMDXComponents(components?: MDXComponents): MDXComponents {
return {
...defaultMdxComponents,
h2: (props) => <Heading as="h2" {...props} />,
h3: (props) => <Heading as="h3" {...props} />,
h4: (props) => <Heading as="h4" {...props} />,
img: (props) => <ImageZoom {...(props as any)} />,
YouTube,
Tabs,
Tab,
TabsList,
TabsTrigger,
TabsContent,
Accordion,
Accordions,
Callout,
Step,
Steps,
Card,
Cards,
ProviderCard,
ProviderGrid,
FrameworkSelector,
QuickstartFlow,
FrameworkOption,
IntegrationTabs,
IntegrationContent,
ToolTypeFlow,
ToolTypeOption,
ConnectFlow,
ConnectClientOption,
Figure,
Video,
CapabilityCard,
CapabilityList,
TemplateCard,
TemplateGrid,
ToolkitsLanding,
ManagedAuthList,
Mermaid,
AIToolsBanner,
DocsHero,
HomeFeatures,
SessionFlow,
TriggersFlow,
SlackBotFlow,
LocalWorkbenchFlow,
LocalSandboxBoundary,
FileBuildup,
RepoBrowser,
AppLogo,
ImessageFlow,
WorkbenchFlow,
AuthConfigFlow,
WhiteLabelFlow,
ImportConnectionFlow,
HomeSurfaces,
HomeResources,
StepTitle,
Glossary,
GlossaryTerm,
ApiBaseUrl,
ApiEndpointsTable,
ClaudeMockUI,
InChatAuthTerminal,
MediaSplit,
PackageInstall,
ManageConnectionsVisual,
ConnectionRefreshVisual,
// Lucide icons
ShieldCheck,
RouteIcon,
Key,
Search,
Wrench,
Database,
Zap,
Rocket,
Code,
Blocks,
Plug,
Play,
Terminal,
Palette,
BookOpen,
Monitor,
MessageCircle,
LayoutDashboard,
...components,
};
}