Beautiful pdf components, built on Takumi and Forme. 100% Free, Zero config, one command setup.
---
title: "PDF Image"
description: "Embedded image with fit options."
---
<ComponentPreview base="forme" name="pdf-image" 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/pdf-image
```
</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/pdf-image/pdf-image.tsx"
base="forme"
title="components/pdf/pdf-image/pdf-image.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 { PdfImage } from "@/components/pdf/pdf-image";
```
```tsx
<PdfImage src="/logo.png" width={120} />
```
## API Reference
### PdfImage
| Prop | Type | Default |
| -------------- | ------------------------------------------------------------------------------------------------------- | ----------- |
| `src` | `string \| { uri: string; method?: string; headers?: Record<string, string>; body?: string }` | - |
| `variant` | `'default' \| 'full-width' \| 'thumbnail' \| 'avatar' \| 'cover' \| 'bordered' \| 'rounded'` | `'default'` |
| `width` | `number \| string` | - |
| `height` | `number \| string` | - |
| `fit` | `'cover' \| 'contain' \| 'fill' \| 'none'` | - |
| `position` | `string` | `'50% 50%'` |
| `caption` | `string` | - |
| `aspectRatio` | `number` | - |
| `borderRadius` | `number` | - |
| `noWrap` | `boolean` | `true` |
| `style` | `Style` | - |