Skip to content

pdf-viewer-sdk.md

Latest commit

 

History

History
108 lines (76 loc) · 5.79 KB

pdf-viewer-sdk.md

File metadata and controls

108 lines (76 loc) · 5.79 KB
title Syncfusion PDF Viewer SDK Agent Skills for AI Assistants | Syncfusion
description Learn how to install and use Syncfusion PDF Viewer SDK Agent Skills to enable AI assistants to generate accurate pdf viewer code using Syncfusion PDF Viewer SDK libraries.
platform document-processing
control PDF Viewer SDK
documentation ug
keywords Skills, AI Assistants, PdfViewer SDK, Agent Skills

Syncfusion PDF Viewer SDK Agent Skills for AI Assistants

This guide introduces Syncfusion PDF Viewer SDK Skills, a curated skill package that enables AI assistants (GitHub Copilot, Code Studio, Cursor, Claude, etc.) to generate accurate, productionready PDF Viewer integration code using the Syncfusion® PDF Viewer components across supported platforms.

Unlike generic AI suggestions, these skills ground the assistant in official Syncfusion® PDF Viewer APIs, configuration patterns, and platformspecific setup details—ensuring correct usage, faster onboarding, and fewer integration issues.

Supported Platforms

Syncfusion® PDF Viewer SDK Agent Skills provide guidance for the following platforms:

Each platform’s skill file includes component initialization, property configuration, event handling, and common usage patterns specific to that framework.

Prerequisites

Before installing Syncfusion® PDF Viewer SDK Skills, ensure the following:

Node.js (v16 or later) - Required to run npx commands for installing skills.

Installation

Choose one of the following commands to install the Syncfusion PDF Viewer SDK Agent Skills.

# Install all PDF Viewer SDK skills at once 
npx skills add syncfusion/pdf-viewer-sdk-skills -y 

# Choose and install skills interactively from the terminal 
npx skills add syncfusion/pdf-viewer-sdk-skills

Once installed, the skills are automatically registered and available to supported IDEs and AI assistants such as:

To learn more about managing skills, see the Skills CLI documentation.

What's Included

  1. PDF Viewer API Knowledge - Curated, platform-specific guidance for working with Syncfusion® PDF Viewer components, including:
    • Loading PDF documents from local files, URLs, and byte streams
    • Configuring toolbar items and viewer options
    • Zooming, scrolling, and navigation
    • Text selection and search
    • Annotations (shape, text markup, stamps, etc.)
    • Form field interaction
    • Event handling (document load, page change, annotation events)
  2. Platform-Specific Code Generation — Generates production-ready code tailored to your platform without executing scripts or modifying your project structure. No files are generated on disk.
  3. Best Practices & Configuration Patterns - The skills enforce Syncfusion® recommended practices, including:
    • Correct package / NuGet / npm selection per platform
    • Proper component initialization and lifecycle usage
    • Platform-appropriate configuration for performance and UX
    • Syncfusion license setup using:
      • SyncfusionLicense.txt, or
      • SYNCFUSION_LICENSE_KEY environment variable Only APIs and patterns explicitly defined in the skill reference files are used.

How Syncfusion® PDF Viewer SDK Agent Skills Work

  1. Reads the relevant platform-specific skill files - Based on the user’s query (for example, React vs WPF), the assistant loads the appropriate PDF Viewer skill reference.

  2. Generates accurate, platform-specific code - The assistant:

    • Uses the correct component names and APIs
    • Applies valid configuration options

Using the AI Assistant with PDF Viewer Skills

Once installed, the assistant can help generate PDF Viewer integration code. Below are example prompts.

Example Prompts

  • “Show me how to load a PDF file in Syncfusion PDF Viewer for React.”
  • “Give an example of enabling text search in Blazor PDF Viewer.”
  • “How do I add annotation support in WPF Syncfusion PDF Viewer?”
  • “Provide sample code to customize the toolbar in MAUI PDF Viewer.”
  • “Show how to load a PDF from a URL in Flutter PDF Viewer.”
  • “Example of handling page change events in WinForms PDF Viewer.”

Documentation Reference

For detailed API documentation and feature explanations, refer to the official Syncfusion PDF Viewer documentation:

(Equivalent documentation is available for Blazor, Flutter, MAUI, WinForms, and WPF.)

See Also