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.

1.8 KB
Raw Blame
---
title: "Page Break"
description: "Forces a page break in the document."
---

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

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

```tsx
<PageBreak />
```

## API Reference

### PageBreak

| Prop       | Type    | Default |
| ---------- | ------- | ------- |
| `children` | `never` | -       |