Skip to content

App screensLumen Halo

IntegrationsProv1.0.0

A directory of the services your product connects to. Search and counted category chips narrow it (the counts follow your search), Connected shows what's on, and Connect turns into Connected in place once your callback succeeds.

.md
pnpm dlx shadcn@latest add @beautiful-ui-pro/lumen-integrations

Needs your registry key. Your components.json style picks the Base UI or Radix build: radix-*, new-york and default get Radix, base-* gets Base UI.

Styles didn't apply?

The CLI adds the styles to the CSS file named in components.json (tailwind.css). Check that it points at your global stylesheet, that the project uses Tailwind CSS v4, and that the file is imported in your root layout. Installed by hand: paste styles.css into that file.

Set up the Beautiful UI registry

Free pieces install from their URL with no setup (that URL gives the Base UI build; Radix projects use /r/radix-nova/<name>.json, or add the registries below and the CLI picks your build). Pro pieces need the registries below and BEAUTIFUL_UI_TOKEN in .env.local.

components.json
{
  "registries": {
    "@beautiful-ui": "https://beautiful-ui.dev/r/{style}/{name}.json",
    "@beautiful-ui-pro": {
      "url": "https://beautiful-ui.dev/r/pro/{style}/{name}.json",
      "headers": { "Authorization": "Bearer ${BEAUTIFUL_UI_TOKEN}" }
    }
  }
}

MCP server

claude mcp add --transport http beautiful-ui https://beautiful-ui.dev/api/mcp
Catalog for agents: /llms.txt

Usage

Import it and pass your content. The props that matter most are listed next.

Example
"use client";
import * as React from "react";
import { Integrations, type Integration } from "@/components/ui/lumen/blocks/integrations";

export function IntegrationsPage({ initial }: { initial: Integration[] }) {
  const [items, setItems] = React.useState(initial);
  const mark = (id: string, connected: boolean) => setItems((all) => all.map((i) => (i.id === id ? { ...i, connected } : i)));
  return (
    <Integrations
      integrations={items}
      onConnect={async (item) => {
        const res = await fetch(`/api/integrations/${item.id}/connect`, { method: "POST" });
        if (!res.ok) throw new Error(`Couldn't connect ${item.name}. Try again.`);
        mark(item.id, true);
      }}
      onDisconnect={async (item) => {
        const res = await fetch(`/api/integrations/${item.id}`, { method: "DELETE" });
        if (!res.ok) throw new Error(`Couldn't disconnect ${item.name}.`);
        mark(item.id, false);
      }}
      onManage={(item) => (window.location.href = `/settings/integrations/${item.id}`)}
    />
  );
}

Props

  • integrations–

    Integration[]

    Integration = { id, name, description, category, connected?, logo?, tag? }. logo is any node (an <img> or svg); without it, a monogram on a tint.

  • onConnect–

    (item) => Promise<void>

    Connect it (open OAuth, save a key). Resolve when done and set connected yourself; throw to show the error on its card.

  • onDisconnect / onManage–

    (item) => unknown / (item) => void

    Shown on connected cards when given. onDisconnect may return a promise (progress on the button) and throw to show an error on the card.

  • categories–

    string[]

    Chip order. Default: as they first appear.

  • labels–

    Partial<IntegrationsLabels>

    Every word, for i18n.

Source

components/ui/lumen/blocks/integrations.tsx

This component is included with Pro.

Try the live preview above. Get Pro to install the source.