Add Clickable URL Links

Recipe adds URL actions using top-left coordinates. Use link() when the clickable region is independent of its content, such as a custom drawing:

var recipe = new Recipe("new", "links.pdf")
  .createPage(595, 842)
  .rectangle(65, 100, 465, 120, { fill: "#dbeafe" })
  .link("https://example.com", 65, 100, 465, 120);

Text, images, and supported shapes can instead calculate their clickable rectangle from their rendered bounds:

recipe
  .text("Visit our site", 65, 250, {
    color: "#0563c1",
    underline: true,
    link: "https://example.com",
  })
  .image("logo.png", 65, 290, {
    width: 120,
    link: "https://example.com",
  })
  .rectangle(65, 450, 180, 48, {
    fill: "#dbeafe",
    link: "https://example.com",
  })
  .endPage()
  .endPDF();

With html: true, <a href="https://example.com">Visit our site</a> creates a link over the rendered text. PDF link annotations are rectangular; use link() to select the clickable region for complex drawings.

Use an ASCII URL. Percent-encode non-ASCII path or query text, for example encodeURI("https://example.com/✓"), before passing it to link() or a link option. Unsupported URLs throw when the link is added, so the page can still be finalized.

With textBox.wrap: "clip", text links are limited to the line's clipping region. Hidden overflow does not create clickable areas outside the text box.

If an overflow or textBox.onClip callback ends the active page, links stay on the page where their text was drawn. The callback can start another page without transferring earlier text links to it.

The low-level API attaches a URL to a rectangle on the current page. Pause the active content context before adding links, then write the page.

var context = pdfWriter.startPageContentContext(page);
context.writeText("Visit our site", 90, 710, textOptions);

pdfWriter
  .pausePageContentContext(context)
  .attachURLLinktoCurrentPage("https://example.com", 88, 694, 200, 720)
  .writePage(page)
  .end();

The rectangle values are PDF coordinates: left, bottom, right, and top.