Reference

Watermark

Large, faint, rotated text behind each PDF page's content.

Watermark(_ text: String, on: Enum)

Since 5.2.0

PDF

on

all

first

rest

odd

even

No preview for this one: the example below shows how it is written.

Example

wf

Document(title: "Contract draft") { Watermark("DRAFT") Heading("Service agreement").h1 Paragraph("This draft is for review and is not binding.") }

Props

Props of Watermark
PropTypeUnsetMeaning

text

String (positional)

—

The text: 72pt, bold, 8% black, rotated behind the content (.wf-watermark restyles it)

on:

one of its cases

all

Which pages it is drawn on. Written as a flag, .all, or by name, on: .all.

  • .all (the default): Every page
  • .first: The first page only
  • .rest: Every page but the first
  • .odd: Odd pages (1, 3, 5 …)
  • .even: Even pages

Attribute families: global, aria, data. Plus the 22 universal props every element takes: animate:, exit:, speed:, duration:, delay:, easing:, stagger:, on:, count:, shared:, class:, ref:, drag:, dragGroup:, dropValue:, dropAxis:, dropInside:, roving:, trapFocus:, mount:, update:, cleanup:.

Flags and cases

A flag is written after the parentheses with a dot: a Bool prop, or a case of one of the element's enum props. A case the enum lacks is an error with a hint.

.all

.first

.rest

.odd

.even

Events

Every element also takes the props, the events and the attribute families listed on every element.

Slots

It takes no slots.

Renders with the class wf-watermark, stable across releases, so a stylesheet may target it.

These controls list the props' cases; the example below shows them written.