mcpField
S
syncfusion-blazor-spreadsheet-editor

syncfusion-blazor-spreadsheet-editor

github.com/syncfusionDevelopment097 installsUpdated 1w ago
Repository

About syncfusion-blazor-spreadsheet-editor

Generates C# and Razor code for adding Syncfusion Blazor Spreadsheet to Blazor Server or WebAssembly applications. It combines reference snippets to match requested features and asks for consent before writing files.

Key features

  1. 01Combine base sample with feature snippets
  2. 02Support cell editing, formatting, and formulas
  3. 03Cover worksheet and data operations
  4. 04Include charts and Ribbon customization
  5. 05Request consent before writing files

Use cases

  1. 01Add a spreadsheet to a Blazor page
  2. 02Generate integration samples for selected features
  3. 03Show code or write files according to user choice

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/syncfusion/spreadsheet-editor-sdk-skills --skill syncfusion-blazor-spreadsheet-editor

After installing, type/syncfusion-blazor-spreadsheet-editorin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

README.md
references/
basic-sample.md
cell-range.md
chart.md
clipboard.md
common.md
contextmenu.md
custom-data.md
data-validation.md
editing.md
filtering.md
find-and-replace.md
formatting.md
formula.md
hyperlink.md
merge.md
open-save.md
protection.md
ribbon-customization.md
rows-columns.md
selection.md
sorting.md
undo-redo.md
worksheet.md

Details

From the project README

Syncfusion Blazor Spreadsheet Editor

Overview

Generates production-ready C# and Razor code for integrating the Syncfusion Blazor Spreadsheet component into Blazor Server or WebAssembly applications. The skill produces copy-pasteable code snippets with Excel-like functionality including cell editing, formatting, formulas, data operations, and worksheet management.

Key Capabilities

  • Data & Binding: Load from byte[], local JSON file, remote JSON URL, or Google Drive; save via Ribbon
  • Cell & Range Operations: Editing with events, UpdateCell, set formulas, autofill, range actions, merge/unmerge cells, cell formatting, number formats, conditional formatting
  • Rows, Columns & Worksheets: Insert/resize rows and columns; insert, delete, move, and duplicate worksheets
  • Data Operations: filtering, sorting, hyperlink add/edit/remove, cut/copy/paste, cell and range selection
  • UI & Interactivity: Hide/show Formula bar , Hide/show Context Menu, custom data rendered via XlsIO
  • Protection & History: Sheet and workbook protection/unprotection, undo/redo operations
  • Images: Insert, resize, and move images through UI (enabled by default)
  • Chart: Insert and delete charts in the active worksheet programmatically via InsertChartAsync / DeleteChartAsync; configure move, resize, type, theme, legend, data labels, gridlines, and axes through the UI
  • Ribbon Customization: Customize the Spreadsheet Ribbon (add/remove/modify ribbon tabs, groups and items)

Quick Start Examples

Example 1: Display a basic spreadsheet

User: "Add a basic Spreadsheet to my Blazor page" Result: C# + Razor code snippet displayed (no files created)

Example 2: Disable filtering and sorting

User: "Create a spreadsheet with filtering and sorting disabled" Result: Basic sample merged with filtering.md and sorting.md snippets


Generate C# Code for the User's Project (default)

Trigger keywords: "how to", "add spreadsheet", "code sample", "show me", "example", "snippet", "integrate", "component", "create sample", "code", "sample code", "generate code", "implement", "add to project", "configure spreadsheet"

Step 1 - Analyze Request & Select Snippets
  • Parse the user's intent and identify the requested features.
  • Always start with references/basic-sample.md as the base.
  • Map each requested feature to its corresponding references/*.md file.
  • If no feature keywords match, output only the basic sample.
Step 2 - Consent & Destination Gate (MUST ASK FIRST - STOP HERE UNTIL USER RESPONDS)

Before generating or writing any files, ask the user:

I'm ready to generate your Syncfusion Blazor Spreadsheet sample.

Where should I place it?
1) Create a new Razor file in the skill's "output" folder (recommended for quick tryout)
2) Add/modify an existing file in your project (please provide full path; choose append or replace)
Or, say "Just show me the code" to get the snippet here without changing files.
  • Do not proceed until the user explicitly chooses an option or says "Just show me the code."
  • If the user declines file changes, only output the code in chat (no files created/modified).

For Option 2 only: Before generating code, check if the project has the prerequisites from references/basic-sample.md (Prerequisites and Setup Requirements section). If missing, ask user consent and add them.

Step 3 - Generate Code (Dry-Run)

Build the code in-memory by merging:

  • Base: references/basic-sample.md
  • Merge matched feature snippets into its anchors: PROPERTY, EVENTS, BUTTON, API METHOD
  • Do not invent or modify any property, event, or API beyond what the reference files contain
Step 4 - Apply Changes (Only After Consent)

Option A - Create new file in skill's folder:

  • Create a output/ folder at the skill's root and place the file there
  • Default file name: SpreadsheetSample.razor (configurable via user reply)
  • If the file already exists, ask:
    A file named "SpreadsheetSample.razor" already exists. Overwrite, append, or use a different name?
    
    Stop and wait for the user's decision before proceeding.
  • Write the generated Razor/C# content.

Option B - Add to user's project file:

  • Ask the user for the full path of the target file and whether to append or replace
  • If the path does not exist, ask: I can create this file. Proceed with creation?
  • If replacing, make a backup copy (e.g., .bak) before writing (if the environment supports it)
  • Apply the change per the user's instruction.
Step 5 - Report Outcome
Done
- Location: {path}
- Action: {created|overwritten|appended}
- Notes: {any warnings or unsupported features}

If file operations were skipped, confirm that the code was only displayed in chat.


Code References

All templates and feature snippets live in references/*.md. Each file is a focused snippet the agent combines when generating samples.

Flow: Always start with references/basic-sample.md, then merge matched feature snippets into its anchors (PROPERTY, EVENTS, BUTTON, API METHOD). If no feature keywords match, return only the basic sample.

Supported Features: Editing, Filtering, Sorting, Cell merging, Insert row/column, Hyperlink, Clipboard actions, Cell formatting, Conditional formatting, Chart, Ribbon customization, open and save, selection

FilePurpose
basic-sample.mdMinimal Spreadsheet sample with byte[] DataSource and Ribbon
open-save.mdOpen (byte[], local JSON, remote JSON URL, Google Drive) and Save via Ribbon (supported SaveType formats: Xlsx, Xls, Csv, Pdf.)
worksheet.mdWorksheet insert, delete, move, and duplicate
cell-range.mdAutofill & range actions
merge.mdMerge cells, unmerge cells
editing.mdBind editing events, UpdateCell, set formula
formula.mdFormula bar toggle
formatting.mdNumber formats, cell formatting, and conditional formatting
contextmenu.mdToggle context menu
ribbon-customization.mdCustomize the Spreadsheet Ribbon (add/remove/modify ribbon tabs, groups and items)
rows-columns.mdInsert rows/columns, resizing rows/columns
filtering.mdColumn filtering
sorting.mdMulti-column sorting
hyperlink.mdHyperlink add and remove
clipboard.mdCut, Copy, Paste
selection.mdCell and range selection
undo-redo.mdUndo and redo actions
protection.mdSheet and workbook protection and unprotection
custom-data.mdCreate a custom data spreadsheet using XlsIO
common.mdHeight, Width, ID, CssClass, ActiveSheetIndex, Image
chart.mdVisualize cell data with column, bar, line, area, pie, doughnut, and scatter charts
data-validation.mdRestricting what users can enter in cells or ranges
find-and-replace.mdsearching, replacing, and navigating to cells or ranges in the spreadsheet

Rules

  1. Use Only Reference Snippets

    • Generate code exclusively from the Markdown files under references/
    • Do not invent/guess/include any properties, events, API methods, component names, or parameters not present in references/*.md
  2. UI interaction feature

    • The following features support only UI interaction and have no customization options (no methods, events, or properties):
    • Gridlines - Toggle visibility through UI only
    • Images - Image insert, resize and move actions through UI only
    • Do not generate methods, events, or properties for these features
    • Only add these features if they are explicitly mentioned in references/*.md files
    • If a user requests customization for these features, inform them: This feature supports only UI interaction and does not have programmatic customization options in the Blazor Spreadsheet component.
  3. Unsupported Feature Handling

    • If the user requests a feature with no corresponding snippet in references/*.md, respond with: That feature is not currently supported by the Syncfusion Blazor Spreadsheet component.
    • Suggest the closest supported features only if they have snippets
    • Explicitly list unsupported items and do not synthesize code for them
  4. Validation Before Write

    • Re-validate before writing that all code blocks originate from references/*.md files
    • If validation fails, stop and inform the user
  5. Transparency

    • Include a Supported vs. Unsupported summary in the final report when applicable

Comments

Markdown supported