# Watermark

Diagonal or centered watermark overlay.

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available by appending `.md` to any URL or sending an `Accept: text/markdown` header. An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).



<ComponentPreview base="forme" name="watermark" />

## Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

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

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @pdfcn/forme/watermark
    ```
  </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/watermark/watermark.tsx" base="forme" title="components/pdf/watermark/watermark.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 [#usage]

```tsx
import { PdfWatermark } from "@/components/pdf/watermark";
import { Text } from "@/components/pdf/text";
```

```tsx
<PdfWatermark text="DRAFT" />
```

## API Reference [#api-reference]

### PdfWatermark [#pdfwatermark]

| Prop       | Type                                                                       | Default |
| ---------- | -------------------------------------------------------------------------- | ------- |
| `text`     | `string`                                                                   | -       |
| `opacity`  | `number`                                                                   | -       |
| `fontSize` | `number`                                                                   | -       |
| `color`    | `string`                                                                   | -       |
| `angle`    | `number`                                                                   | -       |
| `position` | `'center' \| 'top-left' \| 'top-right' \| 'bottom-left' \| 'bottom-right'` | -       |
| `fixed`    | `boolean`                                                                  | true    |
| `children` | `never`                                                                    | -       |