Skip to content

Commit bad60e9

Browse files
Merge pull request #2508 from syncfusion-content/ES-1017597-IssueCorrectHotfix
1017597: Updated the same has the library component contents.
2 parents d35c7a6 + 1a828e4 commit bad60e9

1 file changed

Lines changed: 163 additions & 40 deletions

File tree

Document-Processing/Skills/pdf-viewer-sdk.md

Lines changed: 163 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ Syncfusion<sup style="font-size:70%">&reg;</sup> PDF Viewer SDK Agent Skills pro
1919

2020
| Framework | Skills |
2121
|---|---|
22-
| [Blazor](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/blazor/overview) | syncfusion-blazor-pdf-viewer |
23-
| [ASP.NET Core](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/asp-net-core/overview) | syncfusion-aspnetcore-pdf-viewer |
24-
| [Angular](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/angular/overview) | syncfusion-angular-pdfviewer |
25-
| [React](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/react/getting-started-overview) | syncfusion-react-pdf-viewer |
26-
| [Flutter](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/flutter/overview) | syncfusion-flutter-pdf-viewer |
27-
| [.NET MAUI](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/maui/overview) | syncfusion-maui-pdf-viewer |
28-
| [UWP](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/uwp/overview) | syncfusion-uwp-pdf-viewer |
29-
| [WinForms](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/winforms/overview) | syncfusion-winforms-pdf-viewer |
30-
| [WPF](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/wpf/overview) | syncfusion-wpf-pdf-viewer |
22+
| [Blazor](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/blazor/overview) | [syncfusion-blazor-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/master/skills/syncfusion-blazor-pdf-viewer) |
23+
| [ASP.NET Core](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/asp-net-core/overview) | [syncfusion-aspnetcore-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/master/skills/syncfusion-aspnetcore-pdf-viewer) |
24+
| [Angular](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/angular/overview) | [syncfusion-angular-pdfviewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/master/skills/syncfusion-angular-pdfviewer) |
25+
| [React](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/react/overview) | [syncfusion-react-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/master/skills/syncfusion-react-pdf-viewer) |
26+
| [.NET MAUI](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/maui/overview) | [syncfusion-maui-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/master/skills/syncfusion-maui-pdf-viewer) |
27+
| [UWP](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/uwp/overview) | [syncfusion-uwp-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/master/skills/syncfusion-uwp-pdf-viewer) |
28+
| [WinForms](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/winforms/overview) | [syncfusion-winforms-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/master/skills/syncfusion-winforms-pdf-viewer) |
29+
| [WPF](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/wpf/overview) | [syncfusion-wpf-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/master/skills/syncfusion-wpf-pdf-viewer) |
30+
| [Flutter](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/flutter/overview) | [syncfusion-flutter-pdf-viewer](https://github.com/syncfusion/pdf-viewer-sdk-skills/tree/master/skills/syncfusion-flutter-pdf-viewer) |
3131

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

@@ -36,52 +36,111 @@ Each platform’s skill file includes component initialization, property configu
3636
Before installing Syncfusion<sup style="font-size:70%">&reg;</sup> PDF Viewer SDK Skills, ensure the following:
3737

3838
- **[Node.js]("https://nodejs.org/")** (v18 or later) — Required to run `npx` commands for installing skills.
39+
- A supported AI agent or IDE that integrates with the Skills CLI (VS Code, Syncfusion<sup style="font-size:70%">&reg;</sup> Code Studio, Cursor, etc.)
3940

4041
## Installation
4142

42-
Choose one of the following commands to install the Syncfusion PDF Viewer SDK Agent Skills.
43+
Choose one of the following commands to install the [Syncfusion<sup style="font-size:70%">&reg;</sup> PDF Viewer SDK Skills](https://github.com/syncfusion/pdf-viewer-sdk-skills).
44+
45+
{% tabs %}
46+
{% highlight bash tabtitle="npm" %}
4347

44-
```bash
4548
npx skills add syncfusion/pdf-viewer-sdk-skills --all -y
46-
```
49+
50+
{% endhighlight %}
51+
{% endtabs %}
4752

4853
To install a specific skill, use the following command (for example, to install React PDF Viewer skills):
4954

50-
```bash
55+
{% tabs %}
56+
{% highlight bash tabtitle="npm" %}
57+
5158
npx skills add syncfusion/pdf-viewer-sdk-skills --skill syncfusion-react-pdf-viewer
52-
```
53-
54-
## What's Included
55-
56-
1. **PDF Viewer API Knowledge** - Curated, platform-specific guidance for working with Syncfusion<sup style="font-size:70%">&reg;</sup> PDF Viewer components, including:
57-
- Loading PDF documents from local files, URLs, and byte streams
58-
- Configuring toolbar items and viewer options
59-
- Zooming, scrolling, and navigation
60-
- Text selection and search
61-
- Annotations (shape, text markup, stamps, etc.)
62-
- Form field interaction
63-
- Event handling (document load, page change, annotation events)
64-
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.
65-
3. **Best Practices & Configuration Patterns** - The skills enforce Syncfusion<sup style="font-size:70%">&reg;</sup> recommended practices, including:
66-
- Correct package / NuGet / npm selection per platform
67-
- Proper component initialization and life cycle usage
68-
- Platform-appropriate configuration for performance and UX
69-
- Syncfusion license setup using:
70-
- `SyncfusionLicense.txt`, or
71-
- `SYNCFUSION_LICENSE_KEY` environment variable
72-
Only APIs and patterns explicitly defined in the skill reference files are used.
59+
60+
{% endhighlight %}
61+
{% endtabs %}
62+
63+
Choose and install skills interactively from the terminal:
64+
65+
{% tabs %}
66+
{% highlight bash tabtitle="npm" %}
67+
68+
npx skills add syncfusion/pdf-viewer-sdk-skills
69+
70+
{% endhighlight %}
71+
{% endtabs %}
72+
73+
The terminal will show a list of available skills. Use the arrow keys to navigate, space bar to select the skills you want, and Enter to confirm.
74+
75+
{% tabs %}
76+
{% highlight bash tabtitle="npm" %}
77+
78+
Select skills to install (space to toggle)
79+
│ ◻ syncfusion-blazor-pdf-viewer
80+
│ ◻ syncfusion-aspnetcore-pdf-viewer
81+
│ ◻ syncfusion-angular-pdfviewer
82+
│ ◻ syncfusion-react-pdf-viewer
83+
│ ◻ syncfusion-maui-pdf-viewer
84+
│ ◻ syncfusion-uwp-pdf-viewer
85+
│ ◻ syncfusion-winforms-pdf-viewer
86+
│ ◻ syncfusion-wpf-pdf-viewer
87+
│ ◻ syncfusion-flutter-pdf-viewer
88+
│ .....
89+
90+
{% endhighlight %}
91+
{% endtabs %}
92+
93+
Next, select which AI agent you're using and where to store the skills.
94+
{% tabs %}
95+
{% highlight bash tabtitle="npm" %}
96+
97+
│ ── Additional agents ─────────────────────────────
98+
│ Search:
99+
│ ↑↓ move, space select, enter confirm
100+
101+
│ ❯ ○ Augment (.augment/skills)
102+
│ ○ Claude Code (.claude/skills)
103+
│ ○ OpenClaw (skills)
104+
│ ○ CodeBuddy (.codebuddy/skills)
105+
│ ○ Command Code (.commandcode/skills)
106+
│ ○ Continue (.continue/skills)
107+
│ ○ Cortex Code (.cortex/skills)
108+
│ ○ Crush (.crush/skills)
109+
| ....
110+
111+
{% endhighlight %}
112+
{% endtabs %}
113+
114+
Choose your installation scope (project-level or global), then confirm to complete the installation.
115+
116+
{% tabs %}
117+
{% highlight bash tabtitle="npm" %}
118+
119+
◆ Installation scope
120+
│ ● Project (Install in current directory (committed with your project))
121+
│ ○ Global
122+
123+
◆ Proceed with installation?
124+
│ ● Yes / ○ No
125+
126+
{% endhighlight %}
127+
{% endtabs %}
73128

74129
## How Syncfusion<sup style="font-size:70%">&reg;</sup> PDF Viewer SDK Agent Skills Work
75130

76-
1. **Reads the relevant platform-specific skill files** - Based on the users query (for example, React vs WPF), the assistant loads the appropriate PDF Viewer skill reference.
131+
1. **Read the relevant skill files and choose modes based on the user's query** The assistant retrieves library APIs, and code patterns from the installed Syncfusion<sup style="font-size:70%">&reg;</sup> Skills. It automatically chooses the appropriate operating mode based on the provided prompt.
77132

78-
2. **Generates accurate, platform-specific code** - The assistant:
79-
- Uses the correct component names and APIs
80-
- Applies valid configuration options
133+
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.
134+
135+
3. **Register licensing key** Configuring the Syncfusion<sup style="font-size:70%">&reg;</sup> license key from `SyncfusionLicense.txt` or the `SYNCFUSION_LICENSE_KEY` environment variable.
136+
137+
### Using the AI Assistant
81138

82-
## Using the AI Assistant with PDF Viewer Skills
139+
Once skills are installed, the assistant can generate Syncfusion<sup style="font-size:70%">&reg;</sup> pdf viewer code. Below are example prompts for each mode.
83140

84-
Once installed, the assistant can help generate PDF Viewer integration code. Below are example prompts.
141+
## Skills CLI Commands
142+
143+
After installation, manage Syncfusion<sup style="font-size:70%">&reg;</sup> Agent Skills using the following commands:
85144

86145
## Example Prompts
87146

@@ -92,6 +151,70 @@ Once installed, the assistant can help generate PDF Viewer integration code. Bel
92151
- “Show how to load a PDF from a URL in Flutter PDF Viewer.”
93152
- “How to navigate to a specific page in Winforms PdfViewer?”
94153

154+
### List Skills
155+
156+
View all installed skills in your current project or global environment:
157+
158+
{% tabs %}
159+
{% highlight bash tabtitle="NPM" %}
160+
161+
npx skills list
162+
163+
{% endhighlight %}
164+
{% endtabs %}
165+
166+
### Remove a Skill
167+
168+
Uninstall a specific skill from your environment:
169+
170+
{% tabs %}
171+
{% highlight bash tabtitle="NPM" %}
172+
173+
npx skills remove <skill-name>
174+
175+
{% endhighlight %}
176+
{% endtabs %}
177+
178+
Replace `<skill-name>` with the name of the skill you want to remove (for example, `syncfusion-react-pdf-viewer`).
179+
180+
### Check for Updates
181+
182+
Check if updates are available for your installed skills:
183+
184+
{% tabs %}
185+
{% highlight bash tabtitle="NPM" %}
186+
187+
npx skills check
188+
189+
{% endhighlight %}
190+
{% endtabs %}
191+
192+
### Update All Skills
193+
194+
Update all installed skills to their latest versions:
195+
196+
{% tabs %}
197+
{% highlight bash tabtitle="NPM" %}
198+
199+
npx skills update
200+
201+
{% endhighlight %}
202+
{% endtabs %}
203+
204+
## FAQ
205+
206+
**Which agents and IDEs are supported?**
207+
208+
Any Skills compatible agent or IDE that loads local skill files (Visual Studio Code, Cursor, CodeStudio, etc.).
209+
210+
**Are skills loaded automatically?**
211+
212+
Yes. Once installed, supported agents automatically detect and load relevant skills for Syncfusion‑related queries without requiring additional configuration.
213+
214+
**Skills are not being loaded**
215+
216+
Verify that skills are installed in the correct agent directory, restart the IDE, and confirm that the agent supports external skill files.
217+
95218
## See Also
96219

97220
- [Syncfusion PDF Viewer Documentation](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/overview)

0 commit comments

Comments
 (0)