Skip to content

UI Library for Design Engineers. Animated components and effects you can copy and paste into your apps. Free. Open Source.

2.0 KB
Raw Blame
---
title: Code Comparison
date: 2024-10-02
description: A component which compares two code snippets.
author: dillionverma
published: true
---

<ComponentPreview name="code-comparison-demo" />

## Installation

<Tabs defaultValue="cli">

<TabsList>
  <TabsTrigger value="cli">CLI</TabsTrigger>
  <TabsTrigger value="manual">Manual</TabsTrigger>
</TabsList>
<TabsContent value="cli">

```bash
npx shadcn@latest add @magicui/code-comparison
```

</TabsContent>

<TabsContent value="manual">

<Steps>

<Step>Copy and paste the following code into your project.</Step>

<ComponentSource name="code-comparison" />

</Steps>

</TabsContent>

</Tabs>

## Usage

```tsx showLineNumbers
import { CodeComparison } from "@/components/ui/code-comparison"
```

```tsx showLineNumbers
<CodeComparison beforeCode={beforeCode} afterCode={afterCode} />
```

## Props

| Prop             | Type     | Default                     | Description                                            |
| ---------------- | -------- | --------------------------- | ------------------------------------------------------ |
| `className`      | `string` | `-`                         | The class name to be applied to the component          |
| `beforeCode`     | `string` | `-`                         | The code snippet to display in the "before" section    |
| `afterCode`      | `string` | `-`                         | The code snippet to display in the "after" section     |
| `language`       | `string` | `-`                         | The language of the code snippets (e.g., "typescript") |
| `filename`       | `string` | `-`                         | The filename to display for the code snippets          |
| `lightTheme`     | `string` | `github-light`              | The theme to use for light mode                        |
| `darkTheme`      | `string` | `github-dark`               | The theme to use for dark mode                         |
| `highlightColor` | `string` | `rgba(101, 117, 133, 0.16)` | The color to use for highlighting the code snippets    |