Syncfusion JavaScript Spreadsheet Editor

Overview

Key Capabilities

• File Operations: Import/export Excel files (

  xlsx

  ,

  xls

  ,

  xlsb

  ), CSV files, and PDF export
• Data Management: Data binding, editing, sorting, filtering, and validation
• Cell Operations: Formatting (fonts, colors, borders, alignment), merge cells, wrap text
• Formulas & Calculations: Built-in Excel formulas, custom functions, named ranges
• Collaboration: Notes, comments, and threaded discussions
• Advanced Features: Charts, images, hyperlinks, conditional formatting, freeze panes, sheet protection, virtualization for large datasets

Quick Start Examples

Example 1: Generate Spreadsheet with Formatting

Example 2: Generate Code for Loading a File

Getting Started — Minimal JavaScript (ES6) Code

import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';

const spreadsheet = new Spreadsheet({
  sheets: [{ rows: [{ cells: [{ value: 'Hello, Spreadsheet!' }] }] }],
  created: () => {
    // All post-initialization code goes here
  }
});
spreadsheet.appendTo('#spreadsheet');

• #spreadsheet

  — HTML element ID where the component renders

• sheets

  — array of sheet objects with data

Generate TypeScript Code for the User's Project

1. Identify the requested Spreadsheet feature (data binding, formulas, charts, export, etc.).
2. Read the relevant

   references/*.md

   file(s) to understand the APIs and code patterns for the requested feature.
3. STOP before generating code. Check if the user has already chosen a delivery mode.
4. If no delivery mode is chosen yet, you MUST ask the user first using this concise multiple-choice question:
   "How would you like to receive the generated Spreadsheet code?"
   • Option 1: Replace the code in a specific project file (you'll need to provide the file path and confirm)
   • Option 2: Save the code in this skill's output folder at

     {skill-root}/syncfusion-javascript-spreadsheet-editor/output/app.ts

   • Option 3: Share the code directly in the chat window
5. Only after the user selects a delivery mode, proceed to generate TypeScript code using the APIs and snippets from

   references/*.md

   , substituting concrete placeholders from the user's project.
6. Scope implementations within the

   created

   event handler — All code implementations should be placed within the Spreadsheet's

   created

   event unless the user explicitly requests a different event handler (e.g.,

   beforeSave

   ,

   cellSaving

   , etc.).
7. Do NOT make changes to workspace project files unless the user explicitly chose Option 1 and provided the file path with permission.
8. Provide complete TypeScript snippets and concise integration steps after delivering the code.

## Rules

Code References

references/

• Minimal TypeScript Code — a working, ready-to-use snippet
• Placeholders — values the user must customize
• Notes — TypeScript best practices and constraints

Key Rules for Code Generation (TypeScript-first)

1. TypeScript-first snippets — All examples and snippets must be written in TypeScript and compile with the current

   @syncfusion/ej2-spreadsheet

   npm package.
2. No inline code in this manifest — Refer to

   references/*.md

   for runnable snippets; keep this file as the concise policy and index.
3. Default event scoping — All implementations must be placed within the Spreadsheet's

   created

   event handler unless the user explicitly requests implementation in another event (e.g.,

   beforeSave

   ,

   cellSaving

   , etc.). This ensures all operations occur after the Spreadsheet component is fully initialized.
4. Reference file requirements — Each reference must include:
   • Minimal TypeScript Code (complete, runnable)
   • Placeholders (clearly marked values to replace)
   • Notes (TypeScript integration steps and best practices)
5. License handling — Do not hardcode license keys; refer users to env variables or project config.
6. Preserve data integrity — Preserve existing formulas, references, and formatting when generating or editing sheets.
7. No hallucinated APIs — Use verified Syncfusion Spreadsheet Editor method names only.
8. Read references first — For any requested feature, always read the relevant

   references/*.md

   file(s) first before generating code.
9. Build strictly from references — Build TypeScript code strictly from the APIs, methods, properties, events, and snippets found in the reference files. Do NOT invent, guess, or suggest any API, method, property, or event not explicitly present in the reference files.

Rules

• Output files must go in

  {skill-root}/syncfusion-javascript-spreadsheet-editor/output/

  directory when user selects Option 2
• Only use Syncfusion Spreadsheet APIs — never recommend or use alternative spreadsheet libraries (e.g., handsontable, ag-grid, luckysheet)
• No temporary files — never create temporary scripts, intermediate files, or scaffolding outside the output directory
• TypeScript-only code — all generated code must be valid TypeScript, never generate vanilla JavaScript, jQuery, or framework-specific patterns