Skip to content

PDF viewer

A PDF's current page drawn in the page by PDF.js, with paging, zoom, keyboard and a file link.

<div class="cap-pdf" id="pdf-live" role="group" aria-label="PDF viewer, Spring newsletter" data-cap="pdf-viewer" data-src="./specimen/spring-update.pdf" data-pdfjs="./specimen/runtime/">
  <div class="cap-pdf-bar">
    <div class="cap-btn-group" role="group" aria-label="Pages">
      <button type="button" disabled class="cap-btn" data-size="sm" aria-label="Previous page" data-pdf="prev">Previous</button>
      <button type="button" disabled class="cap-btn" data-size="sm" aria-label="Next page" data-pdf="next">Next</button>
    </div>
    <p class="cap-pdf-status" aria-live="polite" data-pdf="status">Loading</p>
    <div class="cap-pdf-zoom" role="group" aria-label="Zoom">
      <button type="button" disabled class="cap-btn" data-size="sm" aria-label="Zoom out" data-pdf="zoom-out">Zoom out</button>
      <span class="cap-pdf-zoom-value" data-pdf="zoom">120%</span>
      <button type="button" disabled class="cap-btn" data-size="sm" aria-label="Zoom in" data-pdf="zoom-in">Zoom in</button>
    </div>
  </div>
  <div tabindex="0" class="cap-pdf-page" role="group" aria-label="PDF viewer, Spring newsletter. Use the arrow keys to change page and the plus and minus keys to zoom."><canvas></canvas></div>
  <p class="cap-pdf-fallback"><a href="./specimen/spring-update.pdf">Open the PDF</a></p>
</div>

Installation

// package.json: "capsomer": "github:DrDustinEdwards/capsomer#v0.152.2"
import "capsomer/tokens.css";
import "capsomer/base.css";
import "capsomer/pdf-viewer.css";
import { enhance } from "capsomer/behavior/pdf-viewer";

enhance();

Usage

<div class="cap-pdf" role="group" aria-label="PDF viewer, Spring newsletter" data-cap="pdf-viewer" data-src="/documents/spring/inline" data-pdfjs="/pdfjs/">
  <div class="cap-pdf-bar">
    <div class="cap-btn-group" role="group" aria-label="Pages">
      <button type="button" disabled class="cap-btn" data-size="sm" aria-label="Previous page" data-pdf="prev">Previous</button>
      <button type="button" disabled class="cap-btn" data-size="sm" aria-label="Next page" data-pdf="next">Next</button>
    </div>
    <p class="cap-pdf-status" aria-live="polite" data-pdf="status">Loading</p>
    <div class="cap-pdf-zoom" role="group" aria-label="Zoom">
      <button type="button" disabled class="cap-btn" data-size="sm" aria-label="Zoom out" data-pdf="zoom-out">Zoom out</button>
      <span class="cap-pdf-zoom-value" data-pdf="zoom">120%</span>
      <button type="button" disabled class="cap-btn" data-size="sm" aria-label="Zoom in" data-pdf="zoom-in">Zoom in</button>
    </div>
  </div>
  <div tabindex="0" class="cap-pdf-page" role="group" aria-label="PDF viewer, Spring newsletter. Use the arrow keys to change page and the plus and minus keys to zoom."><canvas></canvas></div>
  <p class="cap-pdf-fallback"><a href="/documents/spring/inline">Open the PDF</a></p>
</div>

Examples

Failed to load: the link stays

<div class="cap-pdf" id="pdf-failed" role="group" aria-label="PDF viewer, Annual report" data-cap="pdf-viewer" data-src="./specimen/missing.pdf" data-pdfjs="./specimen/runtime/">
  <div class="cap-pdf-bar">
    <div class="cap-btn-group" role="group" aria-label="Pages">
      <button type="button" disabled class="cap-btn" data-size="sm" aria-label="Previous page" data-pdf="prev">Previous</button>
      <button type="button" disabled class="cap-btn" data-size="sm" aria-label="Next page" data-pdf="next">Next</button>
    </div>
    <p class="cap-pdf-status" aria-live="polite" data-pdf="status">Loading</p>
    <div class="cap-pdf-zoom" role="group" aria-label="Zoom">
      <button type="button" disabled class="cap-btn" data-size="sm" aria-label="Zoom out" data-pdf="zoom-out">Zoom out</button>
      <span class="cap-pdf-zoom-value" data-pdf="zoom">120%</span>
      <button type="button" disabled class="cap-btn" data-size="sm" aria-label="Zoom in" data-pdf="zoom-in">Zoom in</button>
    </div>
  </div>
  <div tabindex="0" class="cap-pdf-page" role="group" aria-label="PDF viewer, Annual report. Use the arrow keys to change page and the plus and minus keys to zoom."><canvas></canvas></div>
  <p class="cap-pdf-fallback"><a href="./specimen/missing.pdf">Open the PDF</a></p>
</div>

API reference

PdfViewer

PropTypeRequiredDoes
srcstringYesThe PDF's address.
titlestringThe document's title, in the viewer's name.
pdfjsstringThe folder the site serves PDF.js from.

Functions

FunctionSignatureDoes
clampView(to: { page?: number | undefined; scale?: number | undefined; }, at: { page: number; scale: number; pages: number; }): { page: number; scale: number; }The next page and scale, kept inside the document and the zoom's range.
start(root: HTMLElement): () => void
enhance(root?: ParentNode): () => void

Parts and data attributes

ClassIs
.cap-pdfthe root
.cap-pdf-bara part
.cap-pdf-errora part
.cap-pdf-fallbacka part
.cap-pdf-pagea part
.cap-pdf-statusa part
.cap-pdf-zooma part
.cap-pdf-zoom-valuea part
AttributeValues
data-sizedpresent or absent

Accessibility

KeyDoes
TabMoves through Previous, Next, Zoom out, Zoom in, the page, the link
Left Arrow, Page UpThe page before (on the page)
Right Arrow, Page DownThe page after
Home, EndThe first page, the last
+ or =, -Zoom in, zoom out
  • A group named "PDF viewer, (title)"; the page indicator is a polite live region, so a page change is announced.
  • Buttons are disabled at the ends and while loading.
  • The canvas is a picture of the page: the link under it is the accessible copy (the PDF's own tags, if it has them).