Plugin: Fullscreen

Fullscreen toggle for an immersive viewing experience.

The Fullscreen plugin adds a toolbar button that requests fullscreen on the viewer’s root element. Useful for presentation mode or focused reading.

Enabling flag

The Fullscreen plugin is always registered — useFullscreen is always available. features.fullscreen controls whether the fullscreen toolbar button is shown.

What it does

Toolbar button: Enter / Exit fullscreen
F11 keyboard shortcut (when features.keyboardShortcuts is on)
Uses the browser’s standard fullscreen API on the viewer root
Emits fullscreen-change so consumers can hide chrome accordingly

Composable

useFullscreen() from @embedpdf/plugin-fullscreen/vue. Returns:

{
  state: Ref<{ isFullscreen: boolean }>,
  toggle(),
  enter(),
  exit(),
}

Events

fullscreen-change — emits { isFullscreen: boolean } (surfaces as @fullscreen-change on DocumentViewer)

Dependencies

viewport

Configuration

No featureConfig.

Browser support

Requires the Fullscreen API. Supported in all evergreen browsers. iOS Safari requires user-gesture initiation and only fullscreens individual elements (not the page) — works fine for the viewer.