Document Viewer: Features

Every capability flag on the features prop, plus per-feature configuration shapes.

The features prop is a flat object of flags merged over sensible defaults. Disabled flags do not register their corresponding EmbedPDF plugin, which means the plugin package is tree-shaken from your bundle. The minimum required plugins (DocumentManager, Viewport, Scroll, Render, Tiling) are always registered.

Defaults are not all false. Out of the box you get a full read/navigate/search/print viewer: zoom, rotate, pan, fullscreen, search, selection, outline, thumbnails, print, download, keyboardShortcuts, and touchGestures default to true. You opt in to annotations, commentThreads, undoRedo, spread, and all Phase-2 editing features (they default to false). Pass only the flags you want to change — they’re merged over these defaults.

<DocumentViewer
  source="/doc.pdf"
  wasm-url="/pdfium.wasm"
  :features="{ zoom: true, search: true, annotations: true }"
/>

Changing features at runtime requires a :key. features (and featureConfig) are read once, at mount — EmbedPDF registers its plugin batch in onMounted and never re-reads it. Mutating a flag on a live viewer is silently ignored. To apply a change, remount the component with a :key derived from the feature set (the demo above does exactly this). See Reloading the viewer with :key for the full rule and the which-inputs table.

Flag reference

Navigation / view controls

Search / selection

Side panels

Export

Annotations (Phase 1)

Editing (Phase 2 — opt-in)

Not yet surfaced. Enabling these flags registers the EmbedPDF plugin (and so adds to your bundle), but Phase 2 has no toolbar UI and no DocumentViewerInstance methods wired up yet. The “What it enables” column below describes the intended Phase-2 behavior, not what ships today. Leave these false unless you’re driving the underlying plugin yourself.

Interaction

Screenshot protection

screenshotProtection is a deterrent, not a guarantee, and it’s purely additive. It deters casual capture only and is removable via browser DevTools. It does not change selection, print, or download — to also block copying or downloading, set those flags yourself. Full details and caveats live on the Screenshot Protection page.

Per-feature configuration: featureConfig

featureConfig is keyed by feature name and lets you tune a plugin’s behaviour without re-implementing it.

import type { FeatureConfig } from '@meldui/vue'

const featureConfig: FeatureConfig = {
  zoom: { min: 0.25, max: 10, defaultMode: 'fit-width' },
  annotations: {
    author: '[email protected]',
  },
}

zoom

annotations

Phase 2 config (stamps / signature / redaction) is plumbed to the plugin but not yet driven by any UI/API. These shapes pass through to createPluginRegistration so they’re ready for when the editing UI lands; they have no visible effect today.

stamps (Phase 2)

signature (Phase 2)

redaction (Phase 2)

Highlight colour palette

@meldui/vue exports the 5 canonical colours as HIGHLIGHT_COLORS so you can render swatches matching the floating tooltip:

import { HIGHLIGHT_COLORS, DEFAULT_HIGHLIGHT_COLOR } from '@meldui/vue'

console.log(HIGHLIGHT_COLORS)
// [
//   { name: 'Yellow', value: '#FFCD45' },
//   { name: 'Green',  value: '#92E89E' },
//   { name: 'Blue',   value: '#8FCFEF' },
//   { name: 'Pink',   value: '#FFA0BD' },
//   { name: 'Purple', value: '#C8A5DD' },
// ]
console.log(DEFAULT_HIGHLIGHT_COLOR) // '#FFCD45'

Pass any of these values directly into updateAnnotation(id, { color }).

See also

• Plugin reference — what each plugin actually does and what feature flag toggles it
• Bundle & Perf — bundle impact per feature profile
• Customization — for toolbar / panel layout, see ToolbarConfig