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.3 KB
Raw Blame
---
title: "QR Code"
description: "QR code generated from a string value."
---

<ComponentPreview base="forme" name="qrcode" 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/qrcode
```

</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/qrcode/qrcode.tsx"
  base="forme"
  title="components/pdf/qrcode/qrcode.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 { PdfQRCode } from "@/components/pdf/qrcode";
```

```tsx
<PdfQRCode value="https://pdfcn.dev" />
```

## API Reference

### PdfQRCode

| Prop              | Type                       | Default |
| ----------------- | -------------------------- | ------- |
| `value`           | `string`                   | -       |
| `size`            | `number`                   | -       |
| `color`           | `string`                   | -       |
| `backgroundColor` | `string`                   | -       |
| `errorLevel`      | `'L' \| 'M' \| 'Q' \| 'H'` | -       |
| `margin`          | `number`                   | -       |
| `caption`         | `string`                   | -       |
| `children`        | `never`                    | -       |