Skip to content

armgit / pdfcn

Public Imported from GitHub
0

Beautiful pdf components, built on Takumi and Forme. 100% Free, Zero config, one command setup.

2.2 KB
Raw Blame
---
title: "Alert"
description: "Alert box with info, success, warning, and error variants."
---

<ComponentPreview base="forme" name="alert" hideCode />

## Installation

<CodeTabs>

<TabsList>
  <TabsTrigger value="cli">Command</TabsTrigger>
  <TabsTrigger value="manual">Manual</TabsTrigger>
</TabsList>

<TabsContent value="cli">

```bash
npx shadcn@latest add @pdfcn/forme/alert
```

</TabsContent>

<TabsContent value="manual">

<Steps>

<Step>Install the following dependencies:</Step>

```bash
npm install @formepdf/react @formepdf/core
```

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

<ComponentSource
  src="registry/bases/forme/components/alert/alert.tsx"
  base="forme"
  title="components/pdf/alert/alert.tsx"
/>

<ComponentSource
  src="registry/bases/forme/components/theme-provider.tsx"
  base="forme"
  title="components/pdf/theme-provider.tsx"
/>

<ComponentSource
  src="registry/bases/forme/lib/resolve-color.ts"
  base="forme"
  title="lib/resolve-color.ts"
/>

<ComponentSource
  src="registry/themes/professional.ts"
  base="forme"
  title="lib/pdf-themes/professional.ts"
/>

<ComponentSource
  src="registry/themes/primitives.ts"
  base="forme"
  title="lib/pdf-themes/primitives.ts"
/>

<ComponentSource
  src="registry/types/pdf-themes.ts"
  base="forme"
  title="types/pdf-themes.ts"
/>

<ComponentSource
  src="registry/types/pdf-components.ts"
  base="forme"
  title="types/pdf-components.ts"
/>

<Step>Update the import paths to match your project setup.</Step>

</Steps>

</TabsContent>

</CodeTabs>

## Usage

```tsx
import { PdfAlert } from "@/components/pdf/alert";
```

```tsx
<PdfAlert variant="info" title="Info">
  Alert body
</PdfAlert>
```

## API Reference

### PdfAlert

| Prop         | Type                                          | Default |
| ------------ | --------------------------------------------- | ------- |
| `variant`    | `'info' \| 'success' \| 'warning' \| 'error'` | 'info'  |
| `title`      | `string`                                      | -       |
| `children`   | `ReactNode`                                   | -       |
| `showIcon`   | `boolean`                                     | true    |
| `showBorder` | `boolean`                                     | true    |