Syncfusion Javascript PDF Viewer

Syncfusion TypeScript PdfViewer – UI Sample Generator

Generate Code for the User's Project (default)

Trigger keywords: "how to", "add pdfviewer", "code sample", "show me", "example", "snippet", "integrate", "component", "create sample", "typescript sample".

Purpose: Generate minimal, copy-pasteable TypeScript (.ts) and HTML code that the user can integrate directly into their TypeScript EJ2 project.

Workflow: ⚠️ CRITICAL — Feature Support Policy (STRICT MODE):

FUNDAMENTAL RULE: Only generate code using APIs and properties that are EXPLICITLY listed in the reference files. ANY deviation is a VIOLATION.

• MANDATORY CHECKS BEFORE GENERATING ANY CODE:

  1. Search the reference files for the exact API/property name
  2. Verify it appears in the Method Reference, Properties, or Events tables
  3. If NOT found in ANY reference file, STOP immediately
  4. Do NOT generate or suggest undocumented APIs under any circumstances

• STRICT ENFORCEMENT - ZERO TOLERANCE:

  • NO custom properties - Only use properties from reference file tables
  • NO invented methods - Only use methods from reference file tables
  • NO workarounds with undefined APIs - Forbidden
  • NO assumptions about undocumented behavior - Forbidden
  • NO alternative implementations using guess-work - Forbidden
  • NO pretending support exists - Forbidden

• MANDATORY RESPONSE FOR UNSUPPORTED FEATURES:

  • If a requested scenario/feature/API is NOT listed in any reference file, you MUST respond with:

    "This feature is not supported in the current Syncfusion TypeScript PDF Viewer implementation."
    

  • Then list what IS supported from the appropriate reference file
  • Never suggest alternatives unless explicitly documented in reference files

• REFERENCE FILE HIERARCHY:

  • Each reference file contains complete, authoritative documentation for its domain
  • The tables (Method Reference, Properties, Events) are the SOURCE OF TRUTH
  • Content outside these tables in reference files is explanatory only
  • Do NOT extend beyond what appears in the reference file tables

• AUDIT YOUR GENERATION:

  • Before providing any code, verify EVERY API used appears in a reference file table
  • Document which reference file each API comes from
  • If you cannot cite a reference file table entry, DELETE that code

• This is a CRITICAL REQUIREMENT. Violations compromise the skill's integrity and reliability.

Step 1 — Detect the Application Type (REQUIRED - DO NOT SKIP)

• Use file_search and read_file tools to inspect workspace project files:
  • package.json (check for @syncfusion/ej2-pdfviewer or @syncfusion/ej2 dependency)
  • tsconfig.json (TypeScript configuration)
  • webpack.config.js (EJ2 quickstart uses webpack)
  • src/index.ts or src/app.ts (main TypeScript entry point)
  • src/index.html (HTML container file)
• Output: Confirm the detected application type is a TypeScript EJ2 webpack project (NOT a React/Vue/Angular project) before proceeding.
• CRITICAL: This skill generates vanilla TypeScript code using the EJ2 PdfViewer class. Do NOT generate React, Angular, or Vue component code.

Step 2 — Generate Code from Reference Files Only (REQUIRED)

• Before generating: Confirm that Step 1 is complete
• Read the relevant references/*.md file(s) for the requested feature
• Cross-reference EVERY API, property, and method against these tables
• CLASS-BASED APPROACH (MANDATORY - TypeScript EJ2 PATTERNS ONLY):
  • Import PdfViewer and required module classes from @syncfusion/ej2-pdfviewer
  • Use PdfViewer.Inject(...) to inject required feature modules
  • Instantiate with new PdfViewer({ ... }) or new PdfViewer() and set properties
  • Mount to DOM using viewer.appendTo('#ElementId')
  • NEVER use JSX, TSX, React hooks, or component-based syntax
  • NEVER use <PdfViewerComponent>, <Inject services={...}>, useState, useRef, or useEffect
• MANDATORY: Before generating ANY code, verify that reference files exist and are accessible
• Read the appropriate reference file(s) for the requested feature:
  • Use read_file tool on relevant references/*.md files
  • Confirm file contains Methods/Properties/Events tables
  • Verify tables are complete and readable
• If reference file is missing or cannot be read:
  • STOP code generation
  • Respond: "Reference file for this feature is not available. Please ensure all reference files are present in the references/ directory."
  • List the missing reference file name
• This is a BLOCKER step: Cannot proceed without reference file validation
• If an API/property does NOT appear in the reference file table, DO NOT USE IT
• Do NOT invent, guess, or suggest any API, method, property, class, or namespace not explicitly present in the reference files

Reference File Routing Guide

All templates and operation snippets live in references/*.md. Each file is a focused snippet or template the agent will combine when generating samples.

Flow: Always start with getting-started.md, then merge matched features into its anchors. If no keyword matches, return only the basic sample.

Checklist Before Generating Code

• Count the settings properties: 1-3? → Pass inline in constructor | 4+? → Extract to typed constant
• Are enums involved? Yes → Must use typed constant with enum imports | No → Can pass inline
• Is it reused elsewhere? Yes → Use constant | No → Prefer inline
• Do I need type safety? Yes → Import the model type | No → Skip model type import
• Do I need enums? Yes → Import required enums from @syncfusion/ej2-pdfviewer | No → Skip enum imports
• Package name correct? Always import from @syncfusion/ej2-pdfviewer — NEVER from @syncfusion/ej2-typescript-pdfviewer

🎯 Core Setup & Configuration

📐 Navigation & Page Management

� Comments & Panels

�🔍 Viewing & Interaction

🛠️ Toolbar & Context Menu

Toolbar Configuration

⚠️ STRICT VALIDATION FOR TOOLBAR ITEM NAMES

When generating toolbar configurations, you MUST follow these rules to prevent incorrect toolbar item names:

1. ALWAYS reference exact item names from toolbar-settings.md

   • Do NOT invent, guess, or assume toolbar item names
   • Do NOT apply naming pattern logic to derive names
   • Use ONLY names listed in the "Available Primary Toolbar Items", "Available Annotation Toolbar Items", and "Available Form Designer Items" sections in toolbar-settings.md

2. VALIDATE item names character-by-character

   • Case sensitivity matters: HighlightTool ≠ HighlightOption
   • Exact names only: AnnotationEditTool ≠ AnotatetionEditTool
   • No abbreviations or shortcuts

3. Before generating toolbar configuration code:

   • Open toolbar-settings.md reference file
   • Locate: "Available Primary Toolbar Items" section
   • Locate: "Available Annotation Toolbar Items" section
   • Locate: "Available Form Designer Items" section
   • Copy exact names from THESE SECTIONS ONLY
   • Cross-check every single item name character-by-character
   • If ANY item name is not in the reference sections, DO NOT USE IT
   • Consult the "❌ COMMON MISTAKES TO AVOID" table in toolbar-settings.md if unsure

4. Common errors to prevent:

   • ❌ AnotatetionEditTool → ✅ AnnotationEditTool (typo)
   • ❌ CalibrationOption → ✅ CalibrateTool (wrong suffix)
   • ❌ ShapeAnnotationOption → ✅ ShapeTool (annotation toolbar version)
   • ❌ InkAnnotationOption → ✅ InkAnnotationTool (annotation toolbar version)
   • For complete list of mistakes to avoid, see toolbar-settings.md "❌ COMMON MISTAKES TO AVOID" table

Context Menu Customization

📝 Annotations

📄 Forms

📋 Document Actions

⚙️ Advanced Features

Quick Start Example

import { PdfViewer, Toolbar, Magnification, Navigation, Annotation, LinkAnnotation,
         ThumbnailView, BookmarkView, TextSelection, TextSearch, FormFields, FormDesigner } from '@syncfusion/ej2-pdfviewer';

PdfViewer.Inject(Toolbar, Magnification, Navigation, Annotation, LinkAnnotation, ThumbnailView,
                BookmarkView, TextSelection, TextSearch, FormFields, FormDesigner);

let pdfviewer: PdfViewer = new PdfViewer();
pdfviewer.documentPath = "https://cdn.syncfusion.com/content/pdf/pdf-succinctly.pdf";
pdfviewer.resourceUrl = "https://cdn.syncfusion.com/ej2/31.1.23/dist/ej2-pdfviewer-lib";
pdfviewer.appendTo('#PdfViewer');

🔄 DOCUMENT LIFECYCLE REQUIREMENTS (CRITICAL)

When to Use documentLoad Event

Certain operations MUST be performed inside the documentLoad event callback, not immediately after instantiation:

Operations that REQUIRE documentLoad:

• ✅ Adding form fields programmatically (formDesigner.addFormField())
• ✅ Adding annotations (annotation.addAnnotation())
• ✅ Accessing form field collections (formFieldCollections)
• ✅ Accessing document metadata
• ✅ Modifying document-dependent properties

Operations safe at instantiation time:

• ✅ Setting enableToolbar, enableAnnotation, etc.
• ✅ Setting viewer properties like width, height
• ✅ Configuring settings objects

Example: Correct Timing for Form Fields

❌ WRONG - Causes "formFieldCollections.findIndex is not a function":

let pdfviewer = new PdfViewer({
  documentPath: 'https://...',
  resourceUrl: 'https://...'
});
pdfviewer.appendTo('#PdfViewer');

// ERROR! formFieldCollections not yet initialized
pdfviewer.formDesigner.addFormField('Textbox', { ... });

✅ CORRECT - Inside documentLoad callback:

let pdfviewer = new PdfViewer({
  documentPath: 'https://...',
  resourceUrl: 'https://...',
  documentLoad: () => {
    // SAFE - Document fully loaded, formFieldCollections initialized
    pdfviewer.formDesigner.addFormField('Textbox', { ... });
  }
});
pdfviewer.appendTo('#PdfViewer');

⚙️ SETTINGS CONFIGURATION BEST PRACTICES

When generating code with settings (toolbarSettings, annotationSettings, annotationSelectorSettings, arrowSettings, rectangleSettings, etc.), follow these guidelines:

Rule 1: Simple Settings → Pass directly to the PdfViewer constructor

Use this approach when:

• Configuring only 1-3 properties
• Settings are straightforward without complex enums or custom types

Example (DO THIS):

import { PdfViewer, Toolbar, Annotation } from '@syncfusion/ej2-pdfviewer';

PdfViewer.Inject(Toolbar, Annotation);

let pdfviewer: PdfViewer = new PdfViewer({
  documentPath: 'https://cdn.syncfusion.com/content/pdf/pdf-succinctly.pdf',
  resourceUrl: 'https://cdn.syncfusion.com/ej2/31.1.23/dist/ej2-pdfviewer-lib',
  annotationSelectorSettings: {
    selectionBorderColor: '#0000ff',
    resizerBorderColor: '#ff0000',
    resizerSize: 8
  }
});
pdfviewer.appendTo('#PdfViewer');

Benefits:

• ✅ No extra imports needed
• ✅ Simple and readable
• ✅ Less code clutter
• ✅ Type checking still works

Rule 2: Complex Settings → Define as Typed Constant (OUTSIDE instantiation)

Use this approach when:

• Configuring 4+ properties OR multiple related settings
• Using enums or complex configurations
• Need to reuse the same configuration in multiple places
• Settings are complex enough to warrant separate definition

Example (DO THIS ONLY FOR COMPLEX CASES):

import { PdfViewer, Toolbar, Annotation, AnnotationResizerLocation, CursorType } from '@syncfusion/ej2-pdfviewer';
import { AnnotationSelectorSettingsModel } from '@syncfusion/ej2-pdfviewer';

PdfViewer.Inject(Toolbar, Annotation);

// Define constant OUTSIDE instantiation with proper types and enums
const annotationSelectorConfig: AnnotationSelectorSettingsModel = {
  selectionBorderColor: '#0000ff',
  selectionBorderThickness: 2,
  resizerBorderColor: '#ff0000',
  resizerFillColor: '#4070ff',
  resizerSize: 8,
  resizerShape: 'Square',
  selectorLineDashArray: [5, 6],
  resizerLocation: AnnotationResizerLocation.Corners | AnnotationResizerLocation.Edges,
  resizerCursorType: CursorType.grab
};

let pdfviewer: PdfViewer = new PdfViewer({
  documentPath: 'https://cdn.syncfusion.com/content/pdf/pdf-succinctly.pdf',
  resourceUrl: 'https://cdn.syncfusion.com/ej2/31.1.23/dist/ej2-pdfviewer-lib',
  annotationSelectorSettings: annotationSelectorConfig
});
pdfviewer.appendTo('#PdfViewer');

When to import types and enums:

• Import model types (e.g., AnnotationSelectorSettingsModel) for TypeScript type checking
• Import any enums used in the settings (e.g., AnnotationResizerLocation, CursorType)
• Keep imports minimal - import ONLY what is used

Benefits:

• ✅ Type-safe configuration
• ✅ Proper enum usage
• ✅ Reusable across multiple viewer instances
• ✅ Clean instantiation code

Rule 3: NEVER Over-Engineer Simple Cases

❌ DO NOT DO THIS (Over-engineered):

import { PdfViewer, Toolbar } from '@syncfusion/ej2-pdfviewer';
import { ToolbarSettingsModel } from '@syncfusion/ej2-pdfviewer';

PdfViewer.Inject(Toolbar);

// Unnecessary constant for 2 simple properties
const toolbarSettings: ToolbarSettingsModel = {
  showTooltip: true
};

let pdfviewer: PdfViewer = new PdfViewer({
  toolbarSettings: toolbarSettings
});
pdfviewer.appendTo('#PdfViewer');

✅ DO THIS INSTEAD (Simple & Clean):

import { PdfViewer, Toolbar } from '@syncfusion/ej2-pdfviewer';

PdfViewer.Inject(Toolbar);

let pdfviewer: PdfViewer = new PdfViewer({
  documentPath: 'https://cdn.syncfusion.com/content/pdf/pdf-succinctly.pdf',
  resourceUrl: 'https://cdn.syncfusion.com/ej2/31.1.23/dist/ej2-pdfviewer-lib',
  toolbarSettings: { showTooltip: true }
});
pdfviewer.appendTo('#PdfViewer');

Common Pitfalls and Corrections

• Extract Pages API location: extractPages() is a method of PdfViewer, not of pageOrganizer. Call pdfviewer.extractPages('1-3'), not pdfviewer.pageOrganizer.extractPages('1-3'). The PageOrganizer service enables the UI and capabilities, but programmatic extraction uses the viewer instance.

• Loading extracted/serialized PDFs: pdfviewer.load(document, password?) accepts two parameters. When loading output returned by extractPages(...), provide the password parameter as an empty string if the document is not protected, for example: pdfviewer.load(extractedPdf, ''). Supply the actual password only for password-protected PDFs.

• Event timing for document-dependent operations: Perform annotation and form field operations inside documentLoad to avoid initialization errors (e.g., formFieldCollections availability).