Documentation
Code
Syntax highlighting, file labels, expandable source, and copyable commands with package manager tabs.
tsxapp/welcome.tsx
import { Button } from "@/components/ui/button";
export default function Welcome() {
return (
<section className="space-y-6">
<header>
<h1>Make it your own</h1>
<p>Components that live in your project.</p>
</header>
<Button>Get started</Button>
<Button variant="outline">Learn more</Button>
</section>
);
}$bunx knot-ui add codetsxapp/page.tsx
import { Code } from "@/components/ui/code";
export default function Example() {
return (
<div className="space-y-5">
<Code
language="tsx"
filename="app/page.tsx"
code={'export default function Page() { return <h1>Hello</h1>; }'}
/>
<Code language="bash" code="bunx knot-ui add button" />
</div>
);
}tsxcomponents/ui/code.tsx
"use client";
import * as React from "react";
import { Check, Copy, FileCode2 } from "lucide-react";
import Prism from "prismjs";
import "prismjs/components/prism-typescript";
import "prismjs/components/prism-jsx";
import "prismjs/components/prism-tsx";
import "prismjs/components/prism-bash";
import "prismjs/components/prism-json";
import { cn } from "@/lib/utils";
const packageManagers = ["bun", "npm", "pnpm", "yarn"] as const;
type PackageManager = (typeof packageManagers)[number];
export type CodeProps = {
code: string;
language?: string;
filename?: string;
commands?: Partial<Record<PackageManager, string>>;
className?: string;
theme?: "dark" | "light";
lineNumber?: boolean;
};
const languageAliases: Record<string, string> = {
js: "javascript",
ts: "typescript",
sh: "bash",
shell: "bash",
terminal: "bash",
};
const commandLanguages = new Set(["bash", "sh", "shell", "terminal", "zsh"]);
function commandForManager(line: string, manager: PackageManager) {
if (!line.trim()) return line;
const replacements: [string, Record<PackageManager, string>][] = [
["bun add -d ", { bun: "bun add -d ", npm: "npm install --save-dev ", pnpm: "pnpm add -D ", yarn: "yarn add -D " }],
["bun add --dev ", { bun: "bun add --dev ", npm: "npm install --save-dev ", pnpm: "pnpm add -D ", yarn: "yarn add -D " }],
["bunx --bun ", { bun: "bunx --bun ", npm: "npx ", pnpm: "pnpm dlx ", yarn: "yarn dlx " }],
["bunx ", { bun: "bunx ", npm: "npx ", pnpm: "pnpm dlx ", yarn: "yarn dlx " }],
["bun add ", { bun: "bun add ", npm: "npm install ", pnpm: "pnpm add ", yarn: "yarn add " }],
["bun run ", { bun: "bun run ", npm: "npm run ", pnpm: "pnpm run ", yarn: "yarn run " }],
];
if (line === "bun install") {
return { bun: "bun install", npm: "npm install", pnpm: "pnpm install", yarn: "yarn install" }[manager];
}
for (const [prefix, values] of replacements) {
if (line.startsWith(prefix)) return values[manager] + line.slice(prefix.length);
}
return null;
}
function getCommandVariants(code: string): Record<PackageManager, string> | null {
const lines = code.split("\n");
const variants = {} as Record<PackageManager, string>;
for (const manager of packageManagers) {
const converted = lines.map((line) => commandForManager(line, manager));
if (converted.some((line) => line === null)) return null;
variants[manager] = converted.join("\n");
}
return variants;
}
function highlightedCode(code: string, language: string) {
const prismLanguage = languageAliases[language] ?? language;
const grammar = Prism.languages[prismLanguage];
return grammar ? Prism.highlight(code, grammar, prismLanguage) : null;
}
const darkSyntax =
"[&_.token.comment]:text-zinc-500 [&_.token.keyword]:text-rose-300 [&_.token.string]:text-sky-300 [&_.token.number]:text-amber-300 [&_.token.boolean]:text-amber-300 [&_.token.function]:text-sky-300 [&_.token.operator]:text-zinc-300 [&_.token.punctuation]:text-zinc-400 [&_.token.class-name]:text-amber-200";
const lightSyntax =
"[&_.token.comment]:text-zinc-500 [&_.token.keyword]:text-rose-700 [&_.token.string]:text-blue-700 [&_.token.number]:text-amber-700 [&_.token.boolean]:text-amber-700 [&_.token.function]:text-blue-700 [&_.token.operator]:text-zinc-700 [&_.token.punctuation]:text-zinc-600 [&_.token.class-name]:text-amber-700";
export function Code({
code,
language = "text",
filename,
commands,
className,
theme = "dark",
lineNumber = false,
}: CodeProps) {
const [manager, setManager] = React.useState<PackageManager>("bun");
const [expanded, setExpanded] = React.useState(false);
const [copied, setCopied] = React.useState(false);
const isCommand = Boolean(commands) || commandLanguages.has(language);
const variants = isCommand ? commands ?? getCommandVariants(code) : null;
const shownCode = variants?.[manager] ?? code;
const isLight = theme === "light";
const isLong = !isCommand && code.split("\n").length > 12;
const isCollapsed = isLong && !expanded;
const highlighted = isCommand ? null : highlightedCode(code, language);
React.useEffect(() => {
if (!copied) return;
const timeout = window.setTimeout(() => setCopied(false), 2000);
return () => window.clearTimeout(timeout);
}, [copied]);
async function copyCode() {
try {
await navigator.clipboard.writeText(shownCode);
setCopied(true);
} catch {
setCopied(false);
}
}
const copyButton = (
<button
type="button"
onClick={copyCode}
className={cn(
"inline-flex size-8 shrink-0 items-center justify-center rounded-lg border transition-colors focus-visible:outline-2 focus-visible:outline-offset-2",
isLight
? "border-zinc-200 text-zinc-600 hover:bg-zinc-100"
: "border-zinc-800 text-zinc-400 hover:bg-zinc-800 hover:text-zinc-100",
)}
aria-label={copied ? "Copied to clipboard" : "Copy code"}
title={copied ? "Copied" : "Copy"}
>
{copied ? <Check aria-hidden="true" className="size-4" /> : <Copy aria-hidden="true" className="size-4" />}
</button>
);
return (
<div className={cn(
"overflow-hidden rounded-xl border font-mono text-[13px] shadow-sm",
isLight ? "border-zinc-200 bg-zinc-50 text-zinc-900" : "border-zinc-800 bg-[#171717] text-zinc-200",
className,
)}>
<div className={cn(
"flex min-h-12 items-center justify-between gap-3 border-b px-4",
isLight ? "border-zinc-200" : "border-zinc-800",
)}>
{isCommand && variants ? (
<div className="flex min-w-0 items-center gap-1 overflow-x-auto py-1" role="group" aria-label="Package manager">
{packageManagers.map((item) => (
<button
key={item}
type="button"
onClick={() => { setManager(item); setCopied(false); }}
aria-pressed={manager === item}
className={cn(
"rounded-md px-2.5 py-1.5 text-xs font-medium transition-colors focus-visible:outline-2 focus-visible:outline-offset-2",
manager === item
? isLight ? "bg-white text-zinc-900 shadow-sm" : "bg-zinc-950 text-zinc-100"
: isLight ? "text-zinc-500 hover:text-zinc-900" : "text-zinc-500 hover:text-zinc-200",
)}
>
{item}
</button>
))}
</div>
) : (
<div className="flex min-w-0 items-center gap-2 text-xs">
<span className={cn(
"rounded border px-1.5 py-0.5 uppercase",
isLight ? "border-zinc-200 text-zinc-600" : "border-zinc-800 text-zinc-400",
)}>
{isCommand ? "CLI" : language === "text" ? "Code" : language}
</span>
{filename && (
<span className="flex min-w-0 items-center gap-2 text-zinc-400">
<FileCode2 aria-hidden="true" className="size-3.5 shrink-0" />
<span className="truncate">{filename}</span>
</span>
)}
</div>
)}
{copyButton}
</div>
{isCommand ? (
<pre className={cn("overflow-x-auto px-5 py-5 leading-6", isLight ? lightSyntax : darkSyntax)}>
<code>
{shownCode.split("\n").map((line, index) => {
const highlightedLine = highlightedCode(line, "bash");
return (
<span className="block" key={index}>
<span aria-hidden="true" className="mr-2 select-none text-zinc-500">$</span>
{highlightedLine ? (
<span dangerouslySetInnerHTML={{ __html: highlightedLine }} />
) : line}
</span>
);
})}
</code>
</pre>
) : (
<div className="relative">
<div className={cn("overflow-x-auto px-5 py-5", isCollapsed && "max-h-[304px] overflow-y-hidden")}>
<div className="flex">
{lineNumber && (
<div aria-hidden="true" className="select-none pr-4 text-right leading-6 text-zinc-500">
{code.split("\n").map((_, index) => <div key={index}>{index + 1}</div>)}
</div>
)}
<pre className={cn("min-w-0 leading-6", isLight ? lightSyntax : darkSyntax)}>
{highlighted ? (
<code dangerouslySetInnerHTML={{ __html: highlighted }} />
) : (
<code>{code}</code>
)}
</pre>
</div>
</div>
{isCollapsed && (
<div className={cn(
"pointer-events-none absolute inset-x-0 bottom-0 h-24 bg-gradient-to-t",
isLight ? "from-zinc-50 to-transparent" : "from-[#171717] to-transparent",
)} />
)}
{isLong && (
<div className={cn("flex justify-center", isCollapsed ? "absolute inset-x-0 bottom-3" : "pb-4")}>
<button
type="button"
onClick={() => setExpanded((value) => !value)}
aria-expanded={expanded}
className={cn(
"relative rounded-full border px-4 py-1.5 font-sans text-xs font-medium shadow-sm transition-colors focus-visible:outline-2 focus-visible:outline-offset-2",
isLight
? "border-zinc-200 bg-white text-zinc-800 hover:bg-zinc-100"
: "border-zinc-800 bg-zinc-950 text-zinc-100 hover:bg-zinc-900",
)}
>
{expanded ? "Collapse Code" : "Expand Code"}
</button>
</div>
)}
</div>
)}
</div>
);
}
export default Code;
Installation
Initialize your project once, then add Code. The CLI copies the source and installs its dependencies.
$bunx knot-ui init$bunx knot-ui add codeUse a TypeScript project with Tailwind CSS v4 and an @/ alias pointing to your source folder. Need the theme tokens? Follow the project setup once.
1. Install dependencies
$bun add clsx tailwind-merge prismjs lucide-react$bun add -d @types/prismjs2. Add shared helpers
Copy these files into your source folder. Reuse them if they already exist.
tsxlib/utils.ts
import { type ClassValue, clsx } from "clsx";
import { twMerge } from "tailwind-merge";
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs));
}
3. Copy the component
tsxcomponents/ui/code.tsx
"use client";
import * as React from "react";
import { Check, Copy, FileCode2 } from "lucide-react";
import Prism from "prismjs";
import "prismjs/components/prism-typescript";
import "prismjs/components/prism-jsx";
import "prismjs/components/prism-tsx";
import "prismjs/components/prism-bash";
import "prismjs/components/prism-json";
import { cn } from "@/lib/utils";
const packageManagers = ["bun", "npm", "pnpm", "yarn"] as const;
type PackageManager = (typeof packageManagers)[number];
export type CodeProps = {
code: string;
language?: string;
filename?: string;
commands?: Partial<Record<PackageManager, string>>;
className?: string;
theme?: "dark" | "light";
lineNumber?: boolean;
};
const languageAliases: Record<string, string> = {
js: "javascript",
ts: "typescript",
sh: "bash",
shell: "bash",
terminal: "bash",
};
const commandLanguages = new Set(["bash", "sh", "shell", "terminal", "zsh"]);
function commandForManager(line: string, manager: PackageManager) {
if (!line.trim()) return line;
const replacements: [string, Record<PackageManager, string>][] = [
["bun add -d ", { bun: "bun add -d ", npm: "npm install --save-dev ", pnpm: "pnpm add -D ", yarn: "yarn add -D " }],
["bun add --dev ", { bun: "bun add --dev ", npm: "npm install --save-dev ", pnpm: "pnpm add -D ", yarn: "yarn add -D " }],
["bunx --bun ", { bun: "bunx --bun ", npm: "npx ", pnpm: "pnpm dlx ", yarn: "yarn dlx " }],
["bunx ", { bun: "bunx ", npm: "npx ", pnpm: "pnpm dlx ", yarn: "yarn dlx " }],
["bun add ", { bun: "bun add ", npm: "npm install ", pnpm: "pnpm add ", yarn: "yarn add " }],
["bun run ", { bun: "bun run ", npm: "npm run ", pnpm: "pnpm run ", yarn: "yarn run " }],
];
if (line === "bun install") {
return { bun: "bun install", npm: "npm install", pnpm: "pnpm install", yarn: "yarn install" }[manager];
}
for (const [prefix, values] of replacements) {
if (line.startsWith(prefix)) return values[manager] + line.slice(prefix.length);
}
return null;
}
function getCommandVariants(code: string): Record<PackageManager, string> | null {
const lines = code.split("\n");
const variants = {} as Record<PackageManager, string>;
for (const manager of packageManagers) {
const converted = lines.map((line) => commandForManager(line, manager));
if (converted.some((line) => line === null)) return null;
variants[manager] = converted.join("\n");
}
return variants;
}
function highlightedCode(code: string, language: string) {
const prismLanguage = languageAliases[language] ?? language;
const grammar = Prism.languages[prismLanguage];
return grammar ? Prism.highlight(code, grammar, prismLanguage) : null;
}
const darkSyntax =
"[&_.token.comment]:text-zinc-500 [&_.token.keyword]:text-rose-300 [&_.token.string]:text-sky-300 [&_.token.number]:text-amber-300 [&_.token.boolean]:text-amber-300 [&_.token.function]:text-sky-300 [&_.token.operator]:text-zinc-300 [&_.token.punctuation]:text-zinc-400 [&_.token.class-name]:text-amber-200";
const lightSyntax =
"[&_.token.comment]:text-zinc-500 [&_.token.keyword]:text-rose-700 [&_.token.string]:text-blue-700 [&_.token.number]:text-amber-700 [&_.token.boolean]:text-amber-700 [&_.token.function]:text-blue-700 [&_.token.operator]:text-zinc-700 [&_.token.punctuation]:text-zinc-600 [&_.token.class-name]:text-amber-700";
export function Code({
code,
language = "text",
filename,
commands,
className,
theme = "dark",
lineNumber = false,
}: CodeProps) {
const [manager, setManager] = React.useState<PackageManager>("bun");
const [expanded, setExpanded] = React.useState(false);
const [copied, setCopied] = React.useState(false);
const isCommand = Boolean(commands) || commandLanguages.has(language);
const variants = isCommand ? commands ?? getCommandVariants(code) : null;
const shownCode = variants?.[manager] ?? code;
const isLight = theme === "light";
const isLong = !isCommand && code.split("\n").length > 12;
const isCollapsed = isLong && !expanded;
const highlighted = isCommand ? null : highlightedCode(code, language);
React.useEffect(() => {
if (!copied) return;
const timeout = window.setTimeout(() => setCopied(false), 2000);
return () => window.clearTimeout(timeout);
}, [copied]);
async function copyCode() {
try {
await navigator.clipboard.writeText(shownCode);
setCopied(true);
} catch {
setCopied(false);
}
}
const copyButton = (
<button
type="button"
onClick={copyCode}
className={cn(
"inline-flex size-8 shrink-0 items-center justify-center rounded-lg border transition-colors focus-visible:outline-2 focus-visible:outline-offset-2",
isLight
? "border-zinc-200 text-zinc-600 hover:bg-zinc-100"
: "border-zinc-800 text-zinc-400 hover:bg-zinc-800 hover:text-zinc-100",
)}
aria-label={copied ? "Copied to clipboard" : "Copy code"}
title={copied ? "Copied" : "Copy"}
>
{copied ? <Check aria-hidden="true" className="size-4" /> : <Copy aria-hidden="true" className="size-4" />}
</button>
);
return (
<div className={cn(
"overflow-hidden rounded-xl border font-mono text-[13px] shadow-sm",
isLight ? "border-zinc-200 bg-zinc-50 text-zinc-900" : "border-zinc-800 bg-[#171717] text-zinc-200",
className,
)}>
<div className={cn(
"flex min-h-12 items-center justify-between gap-3 border-b px-4",
isLight ? "border-zinc-200" : "border-zinc-800",
)}>
{isCommand && variants ? (
<div className="flex min-w-0 items-center gap-1 overflow-x-auto py-1" role="group" aria-label="Package manager">
{packageManagers.map((item) => (
<button
key={item}
type="button"
onClick={() => { setManager(item); setCopied(false); }}
aria-pressed={manager === item}
className={cn(
"rounded-md px-2.5 py-1.5 text-xs font-medium transition-colors focus-visible:outline-2 focus-visible:outline-offset-2",
manager === item
? isLight ? "bg-white text-zinc-900 shadow-sm" : "bg-zinc-950 text-zinc-100"
: isLight ? "text-zinc-500 hover:text-zinc-900" : "text-zinc-500 hover:text-zinc-200",
)}
>
{item}
</button>
))}
</div>
) : (
<div className="flex min-w-0 items-center gap-2 text-xs">
<span className={cn(
"rounded border px-1.5 py-0.5 uppercase",
isLight ? "border-zinc-200 text-zinc-600" : "border-zinc-800 text-zinc-400",
)}>
{isCommand ? "CLI" : language === "text" ? "Code" : language}
</span>
{filename && (
<span className="flex min-w-0 items-center gap-2 text-zinc-400">
<FileCode2 aria-hidden="true" className="size-3.5 shrink-0" />
<span className="truncate">{filename}</span>
</span>
)}
</div>
)}
{copyButton}
</div>
{isCommand ? (
<pre className={cn("overflow-x-auto px-5 py-5 leading-6", isLight ? lightSyntax : darkSyntax)}>
<code>
{shownCode.split("\n").map((line, index) => {
const highlightedLine = highlightedCode(line, "bash");
return (
<span className="block" key={index}>
<span aria-hidden="true" className="mr-2 select-none text-zinc-500">$</span>
{highlightedLine ? (
<span dangerouslySetInnerHTML={{ __html: highlightedLine }} />
) : line}
</span>
);
})}
</code>
</pre>
) : (
<div className="relative">
<div className={cn("overflow-x-auto px-5 py-5", isCollapsed && "max-h-[304px] overflow-y-hidden")}>
<div className="flex">
{lineNumber && (
<div aria-hidden="true" className="select-none pr-4 text-right leading-6 text-zinc-500">
{code.split("\n").map((_, index) => <div key={index}>{index + 1}</div>)}
</div>
)}
<pre className={cn("min-w-0 leading-6", isLight ? lightSyntax : darkSyntax)}>
{highlighted ? (
<code dangerouslySetInnerHTML={{ __html: highlighted }} />
) : (
<code>{code}</code>
)}
</pre>
</div>
</div>
{isCollapsed && (
<div className={cn(
"pointer-events-none absolute inset-x-0 bottom-0 h-24 bg-gradient-to-t",
isLight ? "from-zinc-50 to-transparent" : "from-[#171717] to-transparent",
)} />
)}
{isLong && (
<div className={cn("flex justify-center", isCollapsed ? "absolute inset-x-0 bottom-3" : "pb-4")}>
<button
type="button"
onClick={() => setExpanded((value) => !value)}
aria-expanded={expanded}
className={cn(
"relative rounded-full border px-4 py-1.5 font-sans text-xs font-medium shadow-sm transition-colors focus-visible:outline-2 focus-visible:outline-offset-2",
isLight
? "border-zinc-200 bg-white text-zinc-800 hover:bg-zinc-100"
: "border-zinc-800 bg-zinc-950 text-zinc-100 hover:bg-zinc-900",
)}
>
{expanded ? "Collapse Code" : "Expand Code"}
</button>
</div>
)}
</div>
)}
</div>
);
}
export default Code;
Usage
tsxapp/page.tsx
import { Code } from "@/components/ui/code";
export default function Example() {
return (
<div className="space-y-5">
<Code
language="tsx"
filename="app/page.tsx"
code={'export default function Page() { return <h1>Hello</h1>; }'}
/>
<Code language="bash" code="bunx knot-ui add button" />
</div>
);
}Command tabs
Bun CLI commands automatically get npm, pnpm, and yarn alternatives. Supply a commands object when each package manager needs a specific command. Copying includes only the active command.
tsx
<Code
language="bash"
code="bunx knot-ui add code"
commands={{
bun: "bunx knot-ui add code",
npm: "npx knot-ui add code",
pnpm: "pnpm dlx knot-ui add code",
yarn: "yarn dlx knot-ui add code",
}}
/>Props
| Prop | Type | Default | Description |
|---|---|---|---|
| code | string | Required | The source or command text to display and copy. |
| language | string | "text" | The syntax language. Supports TSX, JSX, TypeScript, JavaScript, Bash, JSON, HTML, and CSS. |
| filename | string | — | An optional file path shown in the header. |
| commands | Partial<Record<"bun" | "npm" | "pnpm" | "yarn", string>> | — | Explicit commands for package manager tabs. |
| theme | "dark" | "light" | "dark" | The code panel color theme. |
| lineNumber | boolean | false | Shows line numbers beside source code. |
| className | string | — | Additional classes for the container. |
Source with more than twelve lines collapses into an expandable panel. Unknown languages display as plain text.