# Page Number

Current page number marker.

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

## Installation

```bash
npx shadcn@latest add @angular-pdfcn/forme/page-number
```

To install manually, add the dependencies:

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

Then copy these files into your project and update the import paths to match your setup:

- `components/pdf/page-number/page-number.ts`
- `lib/resolve-color.ts`
- `components/pdf/theme-provider.ts`
- `lib/pdf-renderer.ts`
- `lib/pdf-primitives.ts`
- `lib/render.ts`
- `lib/pdf-themes/professional.ts`
- `lib/pdf-themes/primitives.ts`
- `types/pdf-themes.ts`
- `types/pdf-components.ts`

## Usage

```ts
import { Component } from "@angular/core";

import { PdfHeading } from "@/components/pdf/heading/heading";
import { PdfPageNumber } from "@/components/pdf/page-number/page-number";
import { PdfText } from "@/components/pdf/text/text";
import {
  FormeDocument,
  FormePage,
  FormeView,
} from "@/lib/pdf-primitives";

@Component({
  imports: [
    FormeDocument,
    FormePage,
    FormeView,
    PdfHeading,
    PdfPageNumber,
    PdfText,
  ],
  template: `
    <forme-document>
      <forme-page size="A4" [margin]="40">
        <forme-view [style]="{ minHeight: 680, position: 'relative' }">
          <forme-view [style]="{ marginBottom: 60 }">
            <pdf-heading [level]="1">Multi-Page Report</pdf-heading>
            <pdf-text
              >Page numbers make long reports easier to review, reference, and
              print.</pdf-text
            >
            <pdf-text
              >The format token displays the current page together with the
              total page count.</pdf-text
            >
          </forme-view>
          <forme-view
            [style]="{ bottom: 0, left: 0, position: 'absolute', right: 0 }"
          >
            <pdf-page-number format="Page 1 of 1" align="center" />
          </forme-view>
        </forme-view>
      </forme-page>
    </forme-document>
  `,
})
export class PageNumberDemo {}
```

## API Reference

### PdfPageNumber

| Input    | Type                            | Default                    |
| -------- | ------------------------------- | -------------------------- |
| `format` | `string`                        | `'Page {page} of {total}'` |
| `align`  | `'left' \| 'center' \| 'right'` | `'center'`                 |
| `size`   | `'xs' \| 'sm' \| 'md'`          | `'sm'`                     |
| `fixed`  | `boolean`                       | `false`                    |
| `muted`  | `boolean`                       | `true`                     |