This commit is contained in:
Ubuntu
2026-07-03 16:58:28 +08:00
commit 32b43f85bd
6240 changed files with 1987678 additions and 0 deletions
+148
View File
@@ -0,0 +1,148 @@
---
title: Area Chart
description: A customizable area chart component to visualize your data with gradient fills and smooth curves. 📈
lastUpdated: 12 Aug, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/charts/AreaChart.tsx
---
<ComponentShowcase name="area-chart-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add 'https://retroui.dev/r/area-chart.json'" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install recharts
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="areaChart" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="area-chart-style-default" />
<br />
<br />
### Multiple Categories
<ComponentShowcase name="area-chart-style-multiple" />
<br />
<br />
### Stacked Areas
<ComponentShowcase name="area-chart-style-stacked" />
<br />
<br />
## API Reference
<Table>
<Table.Header>
<Table.Row>
<Table.Head>Prop</Table.Head>
<Table.Head>Type</Table.Head>
<Table.Head>Default</Table.Head>
<Table.Head>Description</Table.Head>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell className="font-medium">data</Table.Cell>
<Table.Cell className="*:text-xs">`Record<string, any>[]`</Table.Cell>
<Table.Cell className="*:text-xs">`[]`</Table.Cell>
<Table.Cell>Array of data objects to display</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">index</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">-</Table.Cell>
<Table.Cell>Key for the x-axis (category) data</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">categories</Table.Cell>
<Table.Cell className="*:text-xs">`string[]`</Table.Cell>
<Table.Cell className="*:text-xs">`[]`</Table.Cell>
<Table.Cell>Array of keys for the data values to display as areas</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">fill</Table.Cell>
<Table.Cell className="*:text-xs">`"gradient" | "solid"`</Table.Cell>
<Table.Cell className="*:text-xs">`"gradient"`</Table.Cell>
<Table.Cell>Fill style for the areas</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">strokeColors</Table.Cell>
<Table.Cell className="*:text-xs">`string[]`</Table.Cell>
<Table.Cell className="*:text-xs">`["var(--foreground)"]`</Table.Cell>
<Table.Cell>Array of stroke colors for the areas</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">fillColors</Table.Cell>
<Table.Cell className="*:text-xs">`string[]`</Table.Cell>
<Table.Cell className="*:text-xs">`["var(--primary)"]`</Table.Cell>
<Table.Cell>Array of fill colors for the areas</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">tooltipBgColor</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">`"var(--background)"`</Table.Cell>
<Table.Cell>Background color for tooltips</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">tooltipBorderColor</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">`"var(--border)"`</Table.Cell>
<Table.Cell>Border color for tooltips</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">gridColor</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">`"var(--muted)"`</Table.Cell>
<Table.Cell>Color for the grid lines</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">valueFormatter</Table.Cell>
<Table.Cell className="*:text-xs">`(value: number) => string`</Table.Cell>
<Table.Cell className="*:text-xs">`(value) => value.toString()`</Table.Cell>
<Table.Cell>Function to format values</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">showGrid</Table.Cell>
<Table.Cell className="*:text-xs">`boolean`</Table.Cell>
<Table.Cell className="*:text-xs">`true`</Table.Cell>
<Table.Cell>Whether to show grid lines</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">showTooltip</Table.Cell>
<Table.Cell className="*:text-xs">`boolean`</Table.Cell>
<Table.Cell className="*:text-xs">`true`</Table.Cell>
<Table.Cell>Whether to show tooltips on hover</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">className</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">-</Table.Cell>
<Table.Cell>Additional CSS classes</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
+160
View File
@@ -0,0 +1,160 @@
---
title: Bar Chart
description: A customizable bar chart component to visualize your data with support for multiple categories, custom colors, and horizontal alignment. 📊
lastUpdated: 02 Jan, 2026
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/charts/BarChart.tsx
---
<ComponentShowcase name="bar-chart-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add 'https://retroui.dev/r/bar-chart.json'" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install recharts
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="barChart" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="bar-chart-style-default" />
<br />
<br />
### Grouped Data
<ComponentShowcase name="bar-chart-style-grouped" />
<br />
<br />
### Stacked Data
<ComponentShowcase name="bar-chart-style-stacked" />
<br />
<br />
### Horizontal Alignment
<ComponentShowcase name="bar-chart-style-horizontal" />
<br />
<br />
## API Reference
<Table>
<Table.Header>
<Table.Row>
<Table.Head>Prop</Table.Head>
<Table.Head>Type</Table.Head>
<Table.Head>Default</Table.Head>
<Table.Head>Description</Table.Head>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell className="font-medium">data</Table.Cell>
<Table.Cell className="*:text-xs">`Record<string, any>[]`</Table.Cell>
<Table.Cell className="*:text-xs">`[]`</Table.Cell>
<Table.Cell>Array of data objects to display</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">index</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">-</Table.Cell>
<Table.Cell>Key for the x-axis (category) data</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">categories</Table.Cell>
<Table.Cell className="*:text-xs">`string[]`</Table.Cell>
<Table.Cell className="*:text-xs">`[]`</Table.Cell>
<Table.Cell>Array of keys for the data values to display as bars</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">alignment</Table.Cell>
<Table.Cell className="*:text-xs">`"vertical" | "horizontal"`</Table.Cell>
<Table.Cell className="*:text-xs">`"vertical"`</Table.Cell>
<Table.Cell>Orientation of the bars</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">strokeColors</Table.Cell>
<Table.Cell className="*:text-xs">`string[]`</Table.Cell>
<Table.Cell className="*:text-xs">`["var(--foreground)"]`</Table.Cell>
<Table.Cell>Array of stroke colors for the bars</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">fillColors</Table.Cell>
<Table.Cell className="*:text-xs">`string[]`</Table.Cell>
<Table.Cell className="*:text-xs">`["var(--primary)"]`</Table.Cell>
<Table.Cell>Array of fill colors for the bars</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">tooltipBgColor</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">`"var(--background)"`</Table.Cell>
<Table.Cell>Background color for tooltips</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">tooltipBorderColor</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">`"var(--border)"`</Table.Cell>
<Table.Cell>Border color for tooltips</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">gridColor</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">`"var(--muted)"`</Table.Cell>
<Table.Cell>Color for the grid lines</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">valueFormatter</Table.Cell>
<Table.Cell className="*:text-xs">`(value: number) => string`</Table.Cell>
<Table.Cell className="*:text-xs">`(value) => value.toString()`</Table.Cell>
<Table.Cell>Function to format values</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">showGrid</Table.Cell>
<Table.Cell className="*:text-xs">`boolean`</Table.Cell>
<Table.Cell className="*:text-xs">`true`</Table.Cell>
<Table.Cell>Whether to show grid lines</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">showTooltip</Table.Cell>
<Table.Cell className="*:text-xs">`boolean`</Table.Cell>
<Table.Cell className="*:text-xs">`true`</Table.Cell>
<Table.Cell>Whether to show tooltips on hover</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">stacked</Table.Cell>
<Table.Cell className="*:text-xs">`boolean`</Table.Cell>
<Table.Cell className="*:text-xs">`false`</Table.Cell>
<Table.Cell>Whether to stack the bars</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">className</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">-</Table.Cell>
<Table.Cell>Additional CSS classes</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
+142
View File
@@ -0,0 +1,142 @@
---
title: Line Chart
description: A customizable line chart component to visualize trends and data over time with smooth curves and data points. 📉
lastUpdated: 12 Aug, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/charts/LineChart.tsx
---
<ComponentShowcase name="line-chart-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add 'https://retroui.dev/r/line-chart.json'" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install recharts
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="lineChart" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="line-chart-style-default" />
<br />
<br />
### Multiple Lines
<ComponentShowcase name="line-chart-style-multiple" />
<br />
<br />
## API Reference
<Table>
<Table.Header>
<Table.Row>
<Table.Head>Prop</Table.Head>
<Table.Head>Type</Table.Head>
<Table.Head>Default</Table.Head>
<Table.Head>Description</Table.Head>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell className="font-medium">data</Table.Cell>
<Table.Cell className="*:text-xs">`Record<string, any>[]`</Table.Cell>
<Table.Cell className="*:text-xs">`[]`</Table.Cell>
<Table.Cell>Array of data objects to display</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">index</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">-</Table.Cell>
<Table.Cell>Key for the x-axis (category) data</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">categories</Table.Cell>
<Table.Cell className="*:text-xs">`string[]`</Table.Cell>
<Table.Cell className="*:text-xs">`[]`</Table.Cell>
<Table.Cell>Array of keys for the data values to display as lines</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">strokeColors</Table.Cell>
<Table.Cell className="*:text-xs">`string[]`</Table.Cell>
<Table.Cell className="*:text-xs">`["var(--foreground)"]`</Table.Cell>
<Table.Cell>Array of stroke colors for the lines</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">strokeWidth</Table.Cell>
<Table.Cell className="*:text-xs">`number`</Table.Cell>
<Table.Cell className="*:text-xs">`2`</Table.Cell>
<Table.Cell>Width of the line strokes</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">dotSize</Table.Cell>
<Table.Cell className="*:text-xs">`number`</Table.Cell>
<Table.Cell className="*:text-xs">`4`</Table.Cell>
<Table.Cell>Size of the data point dots</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">tooltipBgColor</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">`"var(--background)"`</Table.Cell>
<Table.Cell>Background color for tooltips</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">tooltipBorderColor</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">`"var(--border)"`</Table.Cell>
<Table.Cell>Border color for tooltips</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">gridColor</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">`"var(--muted)"`</Table.Cell>
<Table.Cell>Color for the grid lines</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">valueFormatter</Table.Cell>
<Table.Cell className="*:text-xs">`(value: number) => string`</Table.Cell>
<Table.Cell className="*:text-xs">`(value) => value.toString()`</Table.Cell>
<Table.Cell>Function to format values</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">showGrid</Table.Cell>
<Table.Cell className="*:text-xs">`boolean`</Table.Cell>
<Table.Cell className="*:text-xs">`true`</Table.Cell>
<Table.Cell>Whether to show grid lines</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">showTooltip</Table.Cell>
<Table.Cell className="*:text-xs">`boolean`</Table.Cell>
<Table.Cell className="*:text-xs">`true`</Table.Cell>
<Table.Cell>Whether to show tooltips on hover</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">className</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">-</Table.Cell>
<Table.Cell>Additional CSS classes</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
+130
View File
@@ -0,0 +1,130 @@
---
title: Pie Chart
description: A customizable pie chart component to visualize proportional data with support for donut charts. 🍰
lastUpdated: 12 Aug, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/charts/PieChart.tsx
---
<ComponentShowcase name="pie-chart-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add 'https://retroui.dev/r/pie-chart.json'" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install recharts
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="pieChart" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="pie-chart-style-default" />
<br />
<br />
### Donut Chart
<ComponentShowcase name="pie-chart-style-donut" />
<br />
<br />
## API Reference
<Table>
<Table.Header>
<Table.Row>
<Table.Head>Prop</Table.Head>
<Table.Head>Type</Table.Head>
<Table.Head>Default</Table.Head>
<Table.Head>Description</Table.Head>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell className="font-medium">data</Table.Cell>
<Table.Cell className="*:text-xs">`Record<string, any>[]`</Table.Cell>
<Table.Cell className="*:text-xs">`[]`</Table.Cell>
<Table.Cell>Array of data objects to display</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">dataKey</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">-</Table.Cell>
<Table.Cell>Key for the data values</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">nameKey</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">-</Table.Cell>
<Table.Cell>Key for the category names</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">colors</Table.Cell>
<Table.Cell className="*:text-xs">`string[]`</Table.Cell>
<Table.Cell className="*:text-xs">`["var(--chart-1)", ...]`</Table.Cell>
<Table.Cell>Array of colors for the pie segments</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">innerRadius</Table.Cell>
<Table.Cell className="*:text-xs">`number`</Table.Cell>
<Table.Cell className="*:text-xs">`0`</Table.Cell>
<Table.Cell>Inner radius (use > 0 for donut chart)</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">outerRadius</Table.Cell>
<Table.Cell className="*:text-xs">`number`</Table.Cell>
<Table.Cell className="*:text-xs">`80`</Table.Cell>
<Table.Cell>Outer radius of the pie</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">tooltipBgColor</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">`"var(--background)"`</Table.Cell>
<Table.Cell>Background color for tooltips</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">tooltipBorderColor</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">`"var(--border)"`</Table.Cell>
<Table.Cell>Border color for tooltips</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">valueFormatter</Table.Cell>
<Table.Cell className="*:text-xs">`(value: number) => string`</Table.Cell>
<Table.Cell className="*:text-xs">`(value) => value.toString()`</Table.Cell>
<Table.Cell>Function to format values</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">showTooltip</Table.Cell>
<Table.Cell className="*:text-xs">`boolean`</Table.Cell>
<Table.Cell className="*:text-xs">`true`</Table.Cell>
<Table.Cell>Whether to show tooltips on hover</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell className="font-medium">className</Table.Cell>
<Table.Cell className="*:text-xs">`string`</Table.Cell>
<Table.Cell className="*:text-xs">-</Table.Cell>
<Table.Cell>Additional CSS classes</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
@@ -0,0 +1,41 @@
---
title: Accordion
description: This collapsible component let's your users read only the content they care about. 😌
lastUpdated: 19 Oct, 2024
links:
api_reference: https://www.radix-ui.com/primitives/docs/components/accordion#api-reference
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Accordion.tsx
---
<ComponentShowcase name="accordion-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/accordion" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-accordion lucide-react
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="accordion" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="accordion-style-default" />
+56
View File
@@ -0,0 +1,56 @@
---
title: Alert
description: Notify your users about important events and updates. 📣
lastUpdated: 24 Oct, 2024
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Alert.tsx
---
<ComponentShowcase name="alert-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/alert" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install class-variance-authority
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="alert" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="alert-style-default" />
<br />
<br />
### Solid
<ComponentShowcase name="alert-style-solid" />
<br />
<br />
### With Icon
<ComponentShowcase name="alert-style-with-icon" />
<br />
<br />
### Status
<ComponentShowcase name="alert-style-all-status" />
@@ -0,0 +1,50 @@
---
title: Avatar
description: Default rounded avatar that can show your users profile picture. ✨
lastUpdated: 12 Oct, 2024
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Avatar.tsx
---
<ComponentShowcase name="avatar-style-circle" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/avatar" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-avatar
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="avatar" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Size variants
<ComponentShowcase name="avatar-style-circle-sizes" />
<br />
<br />
### Fallbacks
Fallbacks are helpfull when there ia an error loading the src of the avatar.
You can set fallbacks with `Avatar.Fallback` component.
<br />
<ComponentShowcase name="avatar-style-circle-fallbacks" />
+60
View File
@@ -0,0 +1,60 @@
---
title: Badge
description: The component that looks like a button but isn't clickable!
lastUpdated: 30 Oct, 2024
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Badge.tsx
---
<ComponentShowcase name="badge-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/badge" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install class-variance-authority
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="badge" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<hr />
<br />
<ComponentShowcase name="badge-style-default" />
<br />
<br />
### Variants
<hr />
<br />
<ComponentShowcase name="badge-style-variants" />
<br />
<br />
### Rounded
<ComponentShowcase name="badge-style-rounded" />
<br />
<br />
### Sizes
<ComponentShowcase name="badge-style-sizes" />
@@ -0,0 +1,66 @@
---
title: Breadcrumb
description: A navigation component that shows users where they are within a hierarchy.
lastUpdated: 12 May, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Breadcrumb.tsx
---
<ComponentShowcase name="breadcrumb-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/breadcrumb" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install lucide-react class-variance-authority
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="breadcrumb" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<hr />
<br />
<ComponentShowcase name="breadcrumb-style-default" />
<br />
<br />
### Custom Separator
<hr />
<br />
<ComponentShowcase name="breadcrumb-custom-separator" />
<br />
<br />
### Collapsed
<hr />
<br />
<ComponentShowcase name="breadcrumb-style-collapsed" />
<br />
<br />
### Link Component
<hr />
<br />
<ComponentShowcase name="breadcrumb-link-component" />
<br />
<br />
@@ -0,0 +1,68 @@
---
title: Button
description: This bold button makes sure your users click on it and perform the actions you want! 🚀
lastUpdated: 17 Oct, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Button.tsx
---
<ComponentShowcase name="button-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/button" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install class-variance-authority
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="button" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Primary
<ComponentShowcase name="button-style-default" />
<br />
<br />
### Secondary
<ComponentShowcase name="button-style-secondary" />
<br />
<br />
### Outline
<ComponentShowcase name="button-style-outline" />
<br />
<br />
### Link
<ComponentShowcase name="button-style-link" />
<br />
<br />
### Icon
<ComponentShowcase name="button-style-icon" />
<br />
<br />
### With Icon
<ComponentShowcase name="button-style-with-icon" />
@@ -0,0 +1,39 @@
---
title: Calendar
description: Let your users select a date to cancel subscription.
lastUpdated: 14 Nov, 2025
---
<ComponentShowcase name="calendar-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/calendar" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install react-day-picker lucide-react
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="calendar" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="calendar-style-default" />
+51
View File
@@ -0,0 +1,51 @@
---
title: Card
description: A customizable card component to visualize your content. 📝
lastUpdated: 09 Sep, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Card.tsx
---
<ComponentShowcase name="card-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/card" />
<ComponentInstall.Manual>
#### Copy the code 👇 into your project:
<ComponentSource name="card" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Title with description
<ComponentShowcase name="card-style-default" />
<br />
<br />
### Product card
<ComponentShowcase name="card-style-commerce" />
<br />
<br />
### Testimonial card
<ComponentShowcase name="card-style-testimonial" />
<br />
<br />
### Retro player card
<ComponentShowcase name="retro-player" />
@@ -0,0 +1,54 @@
---
title: Carousel
description: Let your users select a date to cancel subscription.
lastUpdated: 14 Nov, 2025
---
<ComponentShowcase name="carousel-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/carousel" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install react-day-picker lucide-react
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="carousel" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="carousel-style-default" />
<br />
<br />
### Sizes
<ComponentShowcase name="carousel-style-sizes" />
<br />
<br />
### Vertical
<ComponentShowcase name="carousel-style-vertical" />
@@ -0,0 +1,48 @@
---
title: Checkbox
description: Let users confirm or reject an option.
lastUpdated: 13 Feb, 2024
links:
api_reference: https://www.radix-ui.com/primitives/docs/components/checkbox#api-reference
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Checkbox.tsx
---
<ComponentShowcase name="checkbox-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/checkbox" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-checkbox class-variance-authority lucide-react
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="checkbox" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Variants
<ComponentShowcase name="checkbox-style-variants" />
<br />
<br />
### Sizes
<ComponentShowcase name="checkbox-style-sizes" />
@@ -0,0 +1,40 @@
---
title: Command
description: A command palette component for quick navigation and actions
lastUpdated: 21 Aug, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Command.tsx
---
<ComponentShowcase name="command-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/command" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install class-variance-authority cmdk
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="command" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Dialog
<ComponentShowcase name="command-style-dialog" />
<br />
<br />
@@ -0,0 +1,32 @@
---
title: Context Menu
description: Displays a menu to the user — such as a set of actions or functions — triggered by a button.
lastUpdated: 09 Sep, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/ContextMenu.tsx
---
<ComponentShowcase name="context-menu-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/context-menu" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install class-variance-authority
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="context-menu" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
@@ -0,0 +1,74 @@
---
title: Dialog
description: An impactful dialog that ensures your important messages and actions get the attention they deserve! 💬✨
lastUpdated: 09 Sep, 2025
links:
api_reference: https://www.radix-ui.com/primitives/docs/components/dialog#api-reference
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Dialog.tsx
---
<ComponentShowcase name="dialog-style-default" />
<br />
<br />
## Instalation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/dialog" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-dialog @radix-ui/react-visually-hidden tailwindcss-animate
```
<br />
#### 2. Configure your `tailwind.config.ts` add:
```sh
{
content: [...],
theme: [...],
// add plugin
plugins: [require("tailwindcss-animate")],
}
```
#### 3. Copy the code 👇 into your project:
<ComponentSource name="dialog" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Example
### Confirm dialog message
<ComponentShowcase name="dialog-style-default" />
<br />
<br />
### With footer
<ComponentShowcase name="dialog-style-with-footer" />
<br />
<br />
### Size variants
<ComponentShowcase name="dialog-style-width-variant" />
<br />
<br />
### With form
<ComponentShowcase name="dialog-style-with-form" />
@@ -0,0 +1,46 @@
---
title: Drawer
description: A component that can slide in from any side of the screen.
lastUpdated: 21 Aug, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Command.tsx
---
<ComponentShowcase name="drawer-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/drawer" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install vaul
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="drawer" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="drawer-style-default" />
<br />
<br />
### Different Direction
<ComponentShowcase name="drawer-style-right-direction" />
<br />
<br />
+70
View File
@@ -0,0 +1,70 @@
---
title: Empty
description: The component that shows when there is no data to show!
lastUpdated: 13 Jan, 2026
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Empty.tsx
---
<ComponentShowcase name="empty-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/empty" />
<ComponentInstall.Manual>
#### Copy the code 👇 into your project:
<ComponentSource name="empty" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="empty-style-default" />
<br />
<br />
### Custom Icon
<ComponentShowcase name="empty-style-custom-icon" />
<br />
<br />
### Customize everything
<ComponentShowcase name="empty-style-custom-everything" />
<br />
<br />
### Using with table
<ComponentShowcase name="empty-style-table" />
<br />
<br />
## API Reference
The Empty component is composed of several sub-components:
<br />
- `Empty` - The main component wrapper
- `Empty.Content` - Wrapper for the content elements
- `Empty.Icon` - Section for displaying an icon
- `Empty.Title` - The main heading for the empty state
- `Empty.Separator` - A visual separator line
- `Empty.Description` - Supporting text for the empty state
+46
View File
@@ -0,0 +1,46 @@
---
title: Input
description: This pretty input makes your users want to type stuff! ⌨️
lastUpdated: 09 Sep, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Input.tsx
---
<ComponentShowcase name="input-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/input" />
<ComponentInstall.Manual>
#### 1. Copy the code 👇 into your project:
<ComponentSource name="input" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="input-style-default" />
<br />
<br />
### With label
<ComponentShowcase name="input-style-with-label" />
<br />
<br />
### Error
<ComponentShowcase name="input-style-error" />
<br />
+38
View File
@@ -0,0 +1,38 @@
---
title: Label
description: A universal component for labeling various inputs.
lastUpdated: 09 Sep, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Label.tsx
---
<ComponentShowcase name="label-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/label" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-label
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="label" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Usage
```tsx
import { Label } from "@/components/retroui/Label";
```
+145
View File
@@ -0,0 +1,145 @@
---
title: Loader
description: A customizable loading indicator with bouncing squares. 🔄
lastUpdated: 20 Aug, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Loader.tsx
---
<ComponentShowcase name="loader-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/loader" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install class-variance-authority
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="loader" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="loader-style-default" />
<br />
<br />
### Secondary
<ComponentShowcase name="loader-style-solid" />
<br />
<br />
### Outline
<ComponentShowcase name="loader-style-outline" />
<br />
<br />
### Sizes
<ComponentShowcase name="loader-style-sizes" />
<br />
<br />
### Custom Configurations
<ComponentShowcase name="loader-style-custom" />
<br />
<br />
## Usage
```tsx
import { Loader } from "@/components/ui/loader"
// Default
<Loader />
// With variants
<Loader variant="secondary" size="lg" />
// Custom configuration
<Loader
count={4} // Number of squares
duration={1.2} // Animation duration in seconds
delayStep={120} // Delay between squares in milliseconds
/>
// Fully customized
<Loader
variant="secondary"
size="lg"
count={4}
duration={1.2}
delayStep={120}
className="my-4"
/>
```
## Props
- - `variant`
* Type: `default` | `secondary` | `outline`
* Default: `default`
* Description: Defines the style variant for the component
- - `size`
* Type: `sm` | `md` | `lg`
* Default: `md`
* Description: Controls the size of the loader squares
- - `count`
* Type: `number`
* Default: `3`
* Description: Sets the number of bouncing squares
- - `duration`
* Type: `number`
* Default: `0.5`
* Description: Controls the animation duration in seconds
- - `delayStep`
* Type: `number`
* Default: `100`
* Description: Defines the delay between squares in milliseconds
- - `className`
* Type: `string`
* Default: `undefined`
* Description: Allows for adding additional CSS classes for custom styling
- - `asChild`
* Type: `boolean`
* Default: `false`
* Description: When `true`, merges the component's props onto its immediate child element
## Accessibility
The Loader component includes the following attributes:
- `role="status"`
- `aria-label="Loading..."`
This ensures screen readers can properly announce the loading state to users.
+40
View File
@@ -0,0 +1,40 @@
---
title: Menu
description: Show your users a list of actions they can take. 📋
lastUpdated: 09 Sep, 2025
links:
api_reference: https://www.radix-ui.com/primitives/docs/components/dropdown-menu#api-reference
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Menu.tsx
---
<ComponentShowcase name="menu-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/menu" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-dropdown-menu
```
#### 2. Copy the code 👇 into your project:
<ComponentSource name="menu" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="menu-style-default" />
@@ -0,0 +1,66 @@
---
title: Popover
description: A handy small component for your little input needs...😉
lastUpdated: 09 Sep, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Popover.tsx
---
<ComponentShowcase name="popover-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/popover" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-popover
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="popover" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Usage
```typescript
import {
Popover,
PopoverContent,
PopoverTrigger,
} from "@/components/retroui/Popover";
```
```typescript
<Popover>
<PopoverTrigger>Open</PopoverTrigger>
<PopoverContent>Place content for the popover here.</PopoverContent>
</Popover>
```
<br />
<br />
## Examples
### Default
<ComponentShowcase name="popover-style-default" />
<br />
<br />
### Shadowed
<ComponentShowcase name="popover-style-default-shadow" />
<br />
<br />
@@ -0,0 +1,41 @@
---
title: Progress
description: Let's you users know how long to wait.
lastUpdated: 09 Sep, 2025
links:
api_reference: https://www.radix-ui.com/docs/primitives/components/progress#api-reference
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Progress.tsx
---
<ComponentShowcase name="progress-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/progress" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-progress lucide-react
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="progress" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="progress-style-default" />
+48
View File
@@ -0,0 +1,48 @@
---
title: Radio
description: Sometimes you need to pick multiple options! That's where the Radio component comes into play.
lastUpdated: 09 Sep, 2025
links:
api_reference: https://www.radix-ui.com/primitives/docs/components/radio-group#api-reference
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Radio.tsx
---
<ComponentShowcase name="radio-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/radio" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-radio-group class-variance-authority
```
#### 2. Copy the code 👇 into your project:
<ComponentSource name="radio" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Variants
<ComponentShowcase name="radio-style-variants" />
<br />
<br />
### Sizes
<ComponentShowcase name="radio-style-sizes" />
<br />
<br />
@@ -0,0 +1,42 @@
---
title: Select
description: Let your users pick what they want.
lastUpdated: 09 Sep, 2025
links:
api_reference: https://www.radix-ui.com/primitives/docs/components/select#api-reference
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Select.tsx
---
<ComponentShowcase name="select-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/select" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-select class-variance-authority
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="select" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="select-style-default" />
@@ -0,0 +1,42 @@
---
title: Slider
description: A customizable slider component with two variants.
lastUpdated: 09 Sep, 2025
links:
api_reference: https://www.radix-ui.com/docs/primitives/components/slider#api-reference
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Slider.tsx
---
<ComponentShowcase name="slider-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/slider" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-slider
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="slider" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="slider-style-default" />
@@ -0,0 +1,78 @@
---
title: Sonner
description: A beautiful toast component that can grab audience attention from any place.
lastUpdated: 09 Sep, 2025
links:
api_reference: https://sonner.emilkowal.ski/toast#api-reference
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Sonner.tsx
---
<ComponentShowcase name="sonner-style-default" />
<br />
<br />
## About
[Sonner](https://sonner.emilkowal.ski) is built and maintained by [Emil Kowalski](https://x.com/emilkowalski_)
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/sonner" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install sonner
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="sonner" />
<br/>
### 3. Add ``Toaster`` in your ``app/layout.tsx``
```tsx
import { Toaster } from "@/components/retroui/sonner"
export default function RootLayout({ children }) {
return (
<html lang="en">
<head />
<body>
<main>{children}</main>
<Toaster />
</body>
</html>
)
}
```
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="sonner-style-default" />
<br />
<br />
### Status
<ComponentShowcase name="sonner-style-status" />
<br />
<br />
### Colored Status
<ComponentShowcase name="sonner-style-colored-status" />
@@ -0,0 +1,50 @@
---
title: Switch
description: Let users to turn on or off your marketing emails or notifications.
lastUpdated: 09 Sep, 2025
links:
api_reference: https://www.radix-ui.com/primitives/docs/components/switch#api-reference
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Switch.tsx
---
<ComponentShowcase name="switch-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/switch" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-switch
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="switch" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="switch-style-default" />
<br />
<br />
### Disabled
<ComponentShowcase name="switch-style-disabled" />
<br />
<br />
+13
View File
@@ -0,0 +1,13 @@
---
title: Tabs
description: Switch between different views using tabs.
lastUpdated: 08 Oct, 2024
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Tab.tsx
---
### Default
<hr />
<br />
<ComponentShowcase name="tab-style-default" />
+65
View File
@@ -0,0 +1,65 @@
---
title: Table
description: Display your data in a structured tabular format.
lastUpdated: 14 Nov, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Table.tsx
---
<ComponentShowcase name="table-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/table" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install class-variance-authority
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="table" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="table-style-default" />
<br />
<br />
### With Checkbox Selection
<ComponentShowcase name="table-with-checkbox" />
<br />
<br />
### With Sticky Header
<ComponentShowcase name="table-with-sticky-header" />
<br />
<br />
## API Reference
The Table component is composed of several sub-components:
<br />
- `Table` - The main table wrapper
- `Table.Header` - Table header section (`<thead>`)
- `Table.Body` - Table body section (`<tbody>`)
- `Table.Footer` - Table footer section (`<tfoot>`)
- `Table.Row` - Table row (`<tr>`)
- `Table.Head` - Table header cell (`<th>`)
- `Table.Cell` - Table data cell (`<td>`)
+58
View File
@@ -0,0 +1,58 @@
---
title: Text
description: Show your texts in different styles. 💅
lastUpdated: 09 Sep, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Text.tsx
---
## Headings
The `Text` component is a versatile React component that provides various heading styles. It leverages class-variance-authority for managing variants and allows for the customization of heading elements.
<hr />
<br />
<ComponentShowcase name="text-headings" />
<br />
#### Props
`className`: Additional CSS classes to customize the component's styling.
<br />
`as`: Determines the heading and text style. Default is `p`. Variants include:
- `"h1", "h2", "h3", "h4", "h5", "h6", "p"`
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/text" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install class-variance-authority
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="text" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Paragraph
<ComponentShowcase name="typography-p" />
@@ -0,0 +1,13 @@
---
title: Textarea
description: This pretty input makes your users want to type lots of stuff! ⌨️ ⌨️
lastUpdated: 08 Oct, 2024
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Textarea.tsx
---
### Default
<hr />
<br />
<ComponentShowcase name="textarea-style-default" />
+48
View File
@@ -0,0 +1,48 @@
---
title: Table of Contents
description: Generate a table of contents for your markdown content.
lastUpdated: 08 Oct, 2024
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Tab.tsx
---
<ComponentShowcase name="toc-style-default" />
<br />
<br />
## Installation
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/toc" />
<ComponentInstall.Manual>
#### 1. Copy the code 👇 into your project:
<ComponentSource name="toc" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="toc-style-default" />
<br />
<br />
### Adjust depth
<ComponentShowcase name="toc-style-depth" />
<br />
<br />
### Manual data
<ComponentShowcase name="toc-style-manual" />
<br />
<br />
@@ -0,0 +1,82 @@
---
title: Toggle Group
description: Group of toggling buttons...🤙
lastUpdated: 09 Sep, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/ToggleGroup.tsx
---
<ComponentShowcase name="toggle-group-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/toggle-group" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-toggle-group @radix-ui/react-toggle
```
<br />
#### 2. Copy the code 👇 into your project `toggle.tsx`:
<ComponentSource name="toggle" />
<br />
#### 3. Copy the code 👇 into your project `toggle-group.tsx`:
<ComponentSource name="toggle-group" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Usage
```tsx
import {
ToggleGroup,
ToggleGroupItem,
} from "@/components/retroui/toggle-group";
```
```tsx
<ToggleGroup type="single">
<ToggleGroupItem value="a">A</ToggleGroupItem>
<ToggleGroupItem value="b">B</ToggleGroupItem>
<ToggleGroupItem value="c">C</ToggleGroupItem>
</ToggleGroup>
```
<br />
<br />
## Examples
### Default
<ComponentShowcase name="toggle-group-style-default" />
<br />
<br />
### Outlined
<ComponentShowcase name="toggle-group-style-outlined" />
<br />
<br />
### Solid
<ComponentShowcase name="toggle-group-style-solid" />
<br />
<br />
### Outline Muted
<ComponentShowcase name="toggle-group-style-outline-muted" />
@@ -0,0 +1,56 @@
---
title: Toggle
description: This crazy toggling button keeps people toggling...😃
lastUpdated: 09 Sep, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Toggle.tsx
---
<ComponentShowcase name="toggle-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/toggle" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-toggle
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="toggle" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="toggle-style-default" />
<br />
<br />
### Outlined
<ComponentShowcase name="toggle-style-outlined" />
<br />
<br />
### Solid
<ComponentShowcase name="toggle-style-solid" />
<br />
<br />
### Outline Muted
<ComponentShowcase name="toggle-style-outline-muted" />
@@ -0,0 +1,51 @@
---
title: Tooltip
description: A cool way to give your users a hint of what a component does...😉
lastUpdated: 09 Sep, 2025
links:
source: https://github.com/logging-studio/RetroUI/blob/main/components/retroui/Tooltip.tsx
api_reference: https://www.radix-ui.com/primitives/docs/components/tooltip#api-reference
---
<ComponentShowcase name="tooltip-style-default" />
<br />
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add @retroui/tooltip" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install @radix-ui/react-tooltip
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="tooltip" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
<br />
## Examples
### Default
<ComponentShowcase name="tooltip-style-default" />
<br />
<br />
### Primary
<ComponentShowcase name="tooltip-style-primary" />
<br />
<br />
### Solid
<ComponentShowcase name="tooltip-style-solid" />
+52
View File
@@ -0,0 +1,52 @@
---
title: Introduction
description: Why another UI Library?
lastUpdated: 7 Mar, 2024
---
If you don't want to put much effort and time into designing your websites, It's hard to build something unique looking these days.
Most of the UI libraries out here are very generic and hard to distinguish from each other.
<br />
So when I started getting into `Retro/Neobrutalist design system`, I wanted to
build my personal website with this design. But I couldn't find a UI library
that fit what I was looking for, So I start building my own!
<br />
### Welcome to RetroUI, The UI library that let's you build unique and playful websites.
Follow the [Installation Guide](/docs/install) to get started.
<br />
<br />
<div className="max-w-xl">
<iframe
width="100%"
height="300px"
src="https://www.youtube.com/embed/7goHwy6k3gU?si=jwBAOm4ls_QtnN5r"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
referrerpolicy="strict-origin-when-cross-origin"
allowfullscreen
></iframe>
</div>
<br />
<br />
<br />
<div className="max-w-xl">
<iframe
width="100%"
height="300px"
src="https://www.youtube.com/embed/t1a0IH-KAkw?si=yvUevTYbxloSFMJm"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
referrerpolicy="strict-origin-when-cross-origin"
allowfullscreen
></iframe>
</div>
+38
View File
@@ -0,0 +1,38 @@
---
title: Installation
description: This guide will help you get started with RetroUI.
lastUpdated: 30 May, 2025
---
RetroUI is meant to be compatible with all major `React` frameworks. But for now we are primarily working on `Next.js` , documentation for other frameworks will be live soon...
<br />
## Pick Framework
<div className="grid grid-cols-1 lg:grid-cols-2 gap-8">
<Card>
<Link href="/docs/install/nextjs">
<Card.Header className="flex items-center justify-center space-y-4 py-8">
<Image
src="/images/logos/nextjs.png"
alt="nextjs logo"
height={50}
width={50}
/>
<Card.Description className="text-xl">Next.js</Card.Description>
</Card.Header>
</Link>
</Card>
<Card>
<Link href="/docs/install/vite">
<Card.Header className="flex items-center justify-center space-y-4 py-8">
<Image src="/images/logos/vite.png" alt="vite logo" height={50} width={50} />
<div className="flex items-center space-x-2">
<Card.Description className="text-xl">Vite</Card.Description>
</div>
</Card.Header>
</Link>
</Card>
</div>
+184
View File
@@ -0,0 +1,184 @@
---
title: Next.js
description: RetroUI ❤️ Next.js
lastUpdated: 6 Mar, 2024
---
### 1. Create Project
Run the init command to create a new Next.js project or to setup an existing one:
<CliCommand npmCommand="npx shadcn@latest init" />
<br />
### 2. Install utilities
If the `libs/utils.ts` file is not present in your project, you can install it using the following command:
<CliCommand npmCommand="npx shadcn@latest add https://retroui.dev/r/utils.json" />
<br />
### 3. That's it 🚀
Now you can start using RetroUI components in your project. You can install them through CLI or manually.
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add 'https://retroui.dev/r/button.json'" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
```sh
npm install class-variance-authority
```
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="button" />
</ComponentInstall.Manual>
</ComponentInstall>
<br />
After installing the component in your project, you can then simply import it like this:
```tsx
import { Button } from "@/components/retroui/Button";
export default function ButtonExample() {
return <Button>Click Me!</Button>;
}
```
<br />
<br />
### Optional
You are free to pick your own fonts and theme, but if you'd like to use RetroUI theme then use the following guide.
<br />
#### 1. Add Fonts
We are using `Archivo Black` for headings and `Space Grotesk` for everything else. You can install them from Nextjs fonts or manually from Google fonts.
```tsx
import { Archivo_Black, Space_Grotesk } from "next/font/google";
const archivoBlack = Archivo_Black({
subsets: ["latin"],
weight: "400",
variable: "--font-head",
display: "swap",
});
const space = Space_Grotesk({
subsets: ["latin"],
weight: "400",
variable: "--font-sans",
display: "swap",
});
export default function RootLayout({
children,
}: {
children: React.ReactNode;
}) {
return (
<html lang="en">
<body className={`${archivoBlack.variable} ${space.variable}`}>
{children}
</body>
</html>
);
}
```
<br />
#### 2. Add Theme
Save your theme as CSS variables in `global.css`:
```scss
@theme {
--font-head: var(--font-head);
--font-sans: var(--font-sans);
--radius: var(--radius);
--shadow-xs: 1px 1px 0 0 var(--border);
--shadow-sm: 2px 2px 0 0 var(--border);
--shadow: 3px 3px 0 0 var(--border);
--shadow-md: 4px 4px 0 0 var(--border);
--shadow-lg: 6px 6px 0 0 var(--border);
--shadow-xl: 10px 10px 0 1px var(--border);
--shadow-2xl: 16px 16px 0 1px var(--border);
--color-background: var(--background);
--color-foreground: var(--foreground);
--color-primary: var(--primary);
--color-primary-foreground: var(--primary-foreground);
--color-secondary: var(--secondary);
--color-secondary-foreground: var(--secondary-foreground);
--color-primary-hover: var(--primary-hover);
--color-card: var(--card);
--color-card-foreground: var(--card-foreground);
--color-muted: var(--muted);
--color-muted-foreground: var(--muted-foreground);
--color-accent: var(--accent);
--color-accent-foreground: var(--accent-foreground);
--color-destructive: var(--destructive);
--color-destructive-foreground: var(--destructive-foreground);
--color-border: var(--border);
}
:root {
--radius: 0;
--background: #fff;
--foreground: #000;
--card: #fff;
--card-foreground: #000;
--primary: #ffdb33;
--primary-hover: #ffcc00;
--primary-foreground: #000;
--secondary: #000;
--secondary-foreground: #fff;
--muted: #aeaeae;
--muted-foreground: #5a5a5a;
--accent: #fae583;
--accent-foreground: #000;
--destructive: #e63946;
--destructive-foreground: #fff;
--border: #000;
}
.dark {
--radius: 0;
--background: #1a1a1a;
--foreground: #f5f5f5;
--card: #242424;
--card-foreground: #f5f5f5;
--primary: #ffdb33;
--primary-hover: #ffcc00;
--primary-foreground: #000;
--secondary: #3a3a3a;
--secondary-foreground: #f5f5f5;
--muted: #3f3f46;
--muted-foreground: #a0a0a0;
--accent: #fae583;
--accent-foreground: #000;
--destructive: #e63946;
--destructive-foreground: #fff;
--border: #3a3a3a;
}
```
<br />
If you need any additional help, you can feel free to ask it in our Discord community.
+248
View File
@@ -0,0 +1,248 @@
---
title: Vite
description: RetroUI ❤️ Vite
lastUpdated: 30 May, 2025
---
### 1. Create Project
Start by creating a new React project using vite. Select the React + TypeScript template:
<CliCommand npmCommand="npm create vite@latest" />
<br />
### 2. Install Tailwind CSS
Install Tailwind CSS using the following command:
<CliCommand npmCommand="npm install tailwindcss @tailwindcss/vite" />
Replace everything in src/index.css with the following:
```css
@import "tailwindcss";
```
<br />
### 3. Edit tsconfig.json file
The current version of Vite splits TypeScript configuration into three files, two of which need to be edited. Add the `baseUrl` and `paths` properties to the `compilerOptions` section of the `tsconfig.json` and `tsconfig.app.json` files:
```json
{
"files": [],
"references": [
{
"path": "./tsconfig.app.json"
},
{
"path": "./tsconfig.node.json"
}
],
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@/*": ["./src/*"]
}
}
}
```
<br />
### 4. Edit tsconfig.app.json file
Add the following code to the tsconfig.app.json file to resolve paths, for your IDE:
```json
{
"compilerOptions": {
// ...
"baseUrl": ".",
"paths": {
"@/*": [
"./src/*"
]
}
// ...
}
}
```
<br />
### 5. Update vite.config.ts
Add the following code to the vite.config.ts so your app can resolve paths without error:
<CliCommand npmCommand="npm install -D @types/node" />
vite.config.ts
```ts
import path from "path"
import tailwindcss from "@tailwindcss/vite"
import react from "@vitejs/plugin-react"
import { defineConfig } from "vite"
// https://vite.dev/config/
export default defineConfig({
plugins: [react(), tailwindcss()],
resolve: {
alias: {
"@": path.resolve(__dirname, "./src"),
},
},
})
```
<br />
### 6. Install Shadcn
Run the `shadcn init` command to setup your project:
<CliCommand npmCommand="npx shadcn@latest init" />
You will be asked a few questions to configure components.json. Select the option you want to use.
<br />
### 7. Add RetroUI Theme
To make your app look like RetroUI, you need to add the theme to your app. You can later customize it to your liking.
#### 1. Install fonts
We are using `Archivo Black` for headings and `Space Grotesk` for everything else. You can install them from Google fonts.
Once your have the fonts, import them in your `index.html` or `styles.css` file:
```html
<!-- index.html -->
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
href="https://fonts.googleapis.com/css2?family=Archivo+Black&family=Space+Grotesk:wght@300..700&display=swap"
rel="stylesheet"
/>
```
or,
```css
/* styles.css */
@import url('https://fonts.googleapis.com/css2?family=Archivo+Black&family=Space+Grotesk:wght@300;400;500;600;700&display=swap');
```
<br />
#### 2. Add Theme
Save your theme as CSS variables in `styles.css` file:
```scss
@theme {
--font-head: 'Archivo Black', sans-serif;
--font-sans: 'Space Grotesk', sans-serif;
--radius: var(--radius);
--shadow-xs: 1px 1px 0 0 var(--border);
--shadow-sm: 2px 2px 0 0 var(--border);
--shadow: 3px 3px 0 0 var(--border);
--shadow-md: 4px 4px 0 0 var(--border);
--shadow-lg: 6px 6px 0 0 var(--border);
--shadow-xl: 10px 10px 0 1px var(--border);
--shadow-2xl: 16px 16px 0 1px var(--border);
--color-background: var(--background);
--color-foreground: var(--foreground);
--color-primary: var(--primary);
--color-primary-foreground: var(--primary-foreground);
--color-secondary: var(--secondary);
--color-secondary-foreground: var(--secondary-foreground);
--color-primary-hover: var(--primary-hover);
--color-card: var(--card);
--color-card-foreground: var(--card-foreground);
--color-muted: var(--muted);
--color-muted-foreground: var(--muted-foreground);
--color-accent: var(--accent);
--color-accent-foreground: var(--accent-foreground);
--color-destructive: var(--destructive);
--color-destructive-foreground: var(--destructive-foreground);
--color-border: var(--border);
}
:root {
--radius: 0;
--background: #fff;
--foreground: #000;
--card: #fff;
--card-foreground: #000;
--primary: #ffdb33;
--primary-hover: #ffcc00;
--primary-foreground: #000;
--secondary: #000;
--secondary-foreground: #fff;
--muted: #aeaeae;
--muted-foreground: #5a5a5a;
--accent: #fae583;
--accent-foreground: #000;
--destructive: #e63946;
--destructive-foreground: #fff;
--border: #000;
}
.dark {
--radius: 0;
--background: #1a1a1a;
--foreground: #f5f5f5;
--card: #242424;
--card-foreground: #f5f5f5;
--primary: #ffdb33;
--primary-hover: #ffcc00;
--primary-foreground: #000;
--secondary: #3a3a3a;
--secondary-foreground: #f5f5f5;
--muted: #3f3f46;
--muted-foreground: #a0a0a0;
--accent: #fae583;
--accent-foreground: #000;
--destructive: #e63946;
--destructive-foreground: #fff;
--border: #3a3a3a;
}
```
<br />
### 8. That's it!
Now you can start using RetroUI components in your project. You can install them through CLI or manually.
<br />
<ComponentInstall>
<ComponentInstall.Cli npmCommand="npx shadcn@latest add 'https://retroui.dev/r/button.json'" />
<ComponentInstall.Manual>
#### 1. Install dependencies:
<CliCommand npmCommand="npm install class-variance-authority" />
<br />
#### 2. Copy the code 👇 into your project:
<ComponentSource name="button" />
</ComponentInstall.Manual>
</ComponentInstall>
After installing the component in your project, you can then simply import it like this:
```tsx
import { Button } from "@/components/retroui/Button";
export default function ButtonExample() {
return <Button>Click Me!</Button>;
}
```
If you need any additional help, you can feel free to ask it in our [Discord community](https://discord.gg/Jum3NJxK6Q).
+34
View File
@@ -0,0 +1,34 @@
---
title: cn
description: A utilily function that saves you from style conflicts.
lastUpdated: 17 Oct, 2024
links:
source: https://github.com/logging-studio/RetroUI/blob/main/lib/utils.ts
---
The `cn` utility function combines `clsx` and `tw-merge`.
This enables you to construct className strings conditionally without having to worry about Tailwind CSS style conflicts.
<br />
<br />
## Installation
#### 1. Install the dependencies:
```sh
npm install clsx tailwind-merge
```
<br />
#### 2. Copy the code 👇 into your `lib/utils.ts` file:
```ts
import clsx from "clsx";
import { ClassNameValue, twMerge } from "tailwind-merge";
export function cn(...classes: ClassNameValue[]) {
return twMerge(clsx(classes));
}
```