mcpField
S
syncfusion-vue-spreadsheet-editor

syncfusion-vue-spreadsheet-editor

github.com/syncfusion开发086 次安装1 周前更新
代码仓库

关于 syncfusion-vue-spreadsheet-editor

面向开发者的文档型技能,用于生成在 Vue 应用中集成 Syncfusion Spreadsheet Editor 的代码。内容涵盖表格功能 API,并要求生成代码前先确认交付方式,以避免未经许可修改文件。

主要功能

  1. 01Vue 代码生成指引
  2. 02Excel、CSV 和 PDF 导入导出
  3. 03单元格编辑、格式与验证
  4. 04公式、图表和命名范围
  5. 05评论与协作编辑
  6. 06交付方式及项目保护规则

适用场景

  1. 01在 Vue 项目中添加表格组件
  2. 02加载和导出表格文件
  3. 03实现公式、图表或数据验证
  4. 04生成代码时避免意外修改文件

安装

复制下面的命令,在终端中运行。

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

安装后在 Claude Code 中输入/syncfusion-vue-spreadsheet-editor确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

README.md
references/
autofill.md
charts.md
clipboard.md
collaborative-editing.md
comments.md
conditional-formatting.md
context-menu.md
custom-functions.md
data-binding.md
data-validation.md
defined-names.md
edit-cell.md
events.md
find-replace.md
formatting.md
formulas.md
freeze-panes.md
getting-started.md
hyperlink.md
images.md
import-export.md
localization.md
merge-cells.md
misc-operations.md
notes.md
number-formatting.md
print.md
protection.md
ribbon-customization.md

详细介绍

Syncfusion Vue 电子表格编辑器

概述

此技能可帮助开发者生成 Vue 代码,将 Syncfusion 电子表格编辑器集成到应用中。它提供可直接使用的代码片段、API 指南和最佳实践,助力在 Vue 项目中构建类似 Excel 的功能。

主要功能

  • 文件操作: 导入/导出 Excel 文件(xlsx、xls、xlsb)、CSV 文件以及导出 PDF
  • 数据管理: 数据绑定、编辑、排序、筛选和验证
  • 单元格操作: 格式设置(字体、颜色、边框、对齐方式)、合并单元格、自动换行
  • 公式与计算: 内置 Excel 公式、自定义函数、命名范围
  • 协作: 备注、评论和串联讨论
  • 高级功能: 图表、图像、超链接、条件格式、冻结窗格、工作表保护,以及针对大型数据集的虚拟化

快速入门示例

示例 1:生成带格式的电子表格

用户: “创建一个包含数据并应用单元格样式的电子表格”

结果: 系统会生成一段 Vue 代码,将提供的数据加载到电子表格中,并应用基本的单元格格式。

示例 2:生成用于加载文件的代码

用户: “创建一个电子表格,并在初始化时加载 Excel 文件”

结果: 系统会生成一段 Vue 代码,用于初始化电子表格,并在启动时以编程方式打开 Excel 文件。

入门指南 — 最简 Vue 代码

适用于纯 Web 项目的最简 Vue 电子表格设置:

<template>
<div class="control-section">
  <ejs-spreadsheet ref="spreadsheet">
    <e-sheets>
      <e-sheet>
        <e-rows>
          <e-row>
            <e-cells>
              <e-cell value="Hello, Spreadsheet!" />
            </e-cells>
          </e-row>
        </e-rows>
      </e-sheet>
    </e-sheets>
  </ejs-spreadsheet>
</div>
</template>

<script>
import {
SpreadsheetComponent,
SheetsDirective,
SheetDirective,
RowsDirective,
RowDirective,
CellsDirective,
CellDirective
} from "@syncfusion/ej2-vue-spreadsheet";

export default {
components: {
  "ejs-spreadsheet": SpreadsheetComponent,
  "e-sheets": SheetsDirective,
  "e-sheet": SheetDirective,
  "e-rows": RowsDirective,
  "e-row": RowDirective,
  "e-cells": CellsDirective,
  "e-cell": CellDirective
}
};
</script>

为用户的项目生成 Vue 代码

触发关键词:“vue spreadsheet”、“spreadsheet editor”、“syncfusion spreadsheet”、“excel component”、“load excel file”、“open excel file”、“import excel”、“export excel file”、“save excel”、“export to pdf”、“export to csv”、“view excel”、“configure spreadsheet”、“create spreadsheet”、“add spreadsheet”、“spreadsheet data”、“cell formatting”、“apply formulas”、“insert chart”、“data binding”、“spreadsheet validation”、“freeze panes”、“protect sheet”

工作流:

  1. 确定用户请求的 Spreadsheet 功能(数据绑定、公式、图表、导出等)。

  2. 阅读相关的 references/*.md 文件,了解该功能所需的 API 和代码模式。

    • 对于创建、初始化、渲染、包配置、CSS 配置或基本 Spreadsheet 请求,先阅读 references/getting-started.md。
  3. 在生成代码、安装包、创建文件或修改项目文件之前,先停止操作。 检查用户是否已经选择了交付方式。

  4. 如果用户尚未选择交付方式,必须先使用以下简洁的多选问题询问用户:

    “您希望如何接收生成的 Spreadsheet 代码?”

    • **选项 1:**替换指定项目文件中的代码(您需要提供文件路径并确认)
    • **选项 2:**将代码保存到此技能的输出文件夹 {skill-root}/syncfusion-vue-spreadsheet-editor/output/app.vue
    • **选项 3:**直接在聊天窗口中分享代码
  5. 如果用户选择选项 1,请在生成或替换代码之前验证所提供的项目文件/文件夹路径。

    • 如果所提供的路径是现有 Vue 项目且包含 package.json,则继续之前的流程。
    • 如果所提供的路径是空文件夹或不包含 Vue 项目,则不要编辑文件,也不要结束对话。
    • 说明替换项目文件之前必须先有 Vue 项目。
    • 询问用户是否要先使用 references/getting-started.md 设置/安装 Vue。
    • 除非用户明确确认,否则不要自动创建项目文件、安装包或运行设置命令。
  6. **只有在用户选择交付方式且选项 1 的路径验证完成后,**才能使用 references/*.md 中的 API 和代码片段生成 Vue 代码,并根据用户的项目替换具体占位内容。

  7. 除非用户明确选择了选项 1、提供了有效的 Vue 项目文件/文件夹路径并给予许可,否则不得更改工作区项目文件。

  8. 如果未检测到 Vue 项目或 package.json,请说明必须先有 Vue 项目,并根据 references/getting-started.md 提供设置指南。除非用户明确要求创建 Vue 应用并给予许可,否则不要自动创建项目文件、安装包或运行设置命令。

  9. 只有在用户明确提出要求时,才创建新的 Vue 应用/项目,例如:

    • “创建一个 Vue 应用并渲染 Spreadsheet”
    • “创建一个带有 Spreadsheet 的新 Vue 应用”
    • “创建 Vite/Vue 应用并添加 Spreadsheet”

    如果用户只是要求创建、添加、渲染或配置 Spreadsheet 组件,则不要搭建新的 Vue 应用。应将其视为针对现有 Vue 项目的 Spreadsheet 组件/代码生成请求。

  10. 为现有 Vue 项目生成代码时,请提供 references/getting-started.md 中要求的包和 CSS 配置指南。

  11. 提供完整的 Vue 代码片段,并在交付代码后给出简洁的集成步骤。

请参阅 ## Rules 部分,了解操作限制(输出目录、临时文件、允许使用的库等)

代码参考

所有代码片段和示例都在 references/ 文件夹中。每个文件包含:

  • 最简 Vue 代码 — 可运行、可直接使用的代码片段
  • 占位符 — 用户必须自定义的值
  • 说明 — Vue 最佳实践和限制
文件主题
getting-started.md项目设置、软件包安装、CSS 引用、基本渲染和初始数据绑定
data-binding.md本地数组、JSON、远程(DataManager)
formulas.md公式、汇总、命名区域
formatting.md单元格格式、边框、自动换行
rich-text-formatting.md单元格内的富文本格式、字体样式、颜色、上标/下标
number-formatting.md数字格式、小数、货币、日期
conditional-formatting.md规则、基于条件的高亮显示、基于公式的规则
data-validation.md验证规则、无效项高亮显示
sorting-filtering.md排序、筛选
find-replace.md查找、替换
import-export.md保存(XLSX/CSV/PDF)、打开、openFromJson
charts.md插入、编辑、删除图表
images.md插入、修改图片
hyperlink.md添加、移除超链接
comments.md线程式批注、回复、解决讨论串
notes.md简单单元格备注、粘滞显示、添加/编辑/删除
protection.md工作表保护、单元格锁定、权限
edit-cell.mdstartEdit、endEdit、updateCell、编辑模式
freeze-panes.md冻结行/列、拆分窗格
row-column.md插入、删除、调整行/列大小、隐藏
merge-cells.md合并、取消合并单元格、跨单元格显示
print.md页面设置、页眉/页脚、缩放、页边距
misc-operations.md自动填充、清除、工作表管理、goTo
clipboard.md使用不同粘贴类型复制、剪切、粘贴
selection.md选择单元格/区域、多选、getSelectedRange
scrolling-virtualization.md虚拟滚动、大型数据集、性能
wrap.md文本换行、多行显示、行高
defined-names.md命名区域、定义名称、refersTo 格式
custom-functions.md自定义计算函数、addCustomFunction
ribbon-customization.md功能区选项卡、工具栏项目、文件菜单自定义
context-menu.md右键上下文菜单、contextMenuBeforeOpen
localization.md多语言、区域设置、RTL、数字/日期格式
events.md事件处理、事件属性、事件模式
autofill.md自动填充模式、填充类型、序列
collaborative-editing.md实时协同编辑、共享工作簿同步、在线状态指示器

代码生成关键规则(Vue)

  1. Vue 优先代码片段 — 所有示例和代码片段都必须使用 Vue 编写,并可通过当前的 @syncfusion/ej2-vue-spreadsheet npm 包编译。如果用户要求提供 Vue 代码,请提供 Vue 代码。

  2. 本清单中不包含内联代码 — 可运行的代码片段请参阅 references/*.md;本文件仅作为简明的政策和索引。

  3. 参考文件要求 — 每个参考文件必须包含:

    • 最简 Vue 代码(完整、可运行)
    • 占位符(清楚标记需要替换的值)
    • 说明(Vue 集成步骤和最佳实践)
  4. 许可证处理 — 不要硬编码许可证密钥;请引导用户通过环境变量或项目配置设置。

  5. 保留数据完整性 — 生成或编辑工作表时,保留现有公式、引用和格式。

  6. 不虚构 API — 仅使用已验证的 Syncfusion Spreadsheet Editor Component 方法名称。

  7. 先阅读参考文件 — 对于用户请求的任何功能,生成代码前都必须先阅读相关的 references/*.md 文件。

  8. 严格依据参考文件编写 — Vue 代码必须严格依据参考文件中列出的 API、方法、属性、事件和代码片段编写。不要编造、猜测或建议参考文件中未明确列出的任何 API、方法、属性或事件。

规则

  • 用户选择 Option 2 时,输出文件必须放在 {skill-root}/syncfusion-vue-spreadsheet-editor/output/ 目录中
  • 仅使用 Syncfusion Spreadsheet API — 绝不推荐或使用其他电子表格库(例如 vue-spreadsheet、handsontable、ag-grid)
  • 不创建临时文件 — 绝不在输出目录之外创建临时脚本、中间文件或脚手架
  • 仅限 Vue 代码 — 所有生成的代码都必须是有效的 Vue 代码,绝不生成原生 JavaScript、jQuery、React、Angular 或非 Vue 模式的代码
  • Option 1 路径验证: 用户选择 Option 1 时,编辑或替换文件前,始终验证提供的项目文件/文件夹路径。
    • 如果路径中包含带有 package.json 的现有 Vue 项目,则继续执行常规代码替换流程。
    • 如果路径为空或不包含 Vue 项目,则不要编辑文件,也不要结束对话。
    • 必须通过后续提问作出回应,而不是停止。
    • 说明替换项目文件前需要有 Vue 项目。
    • 询问用户是想获取设置指导,还是想先使用 references/getting-started.md 设置/安装 Vue。
    • 除非用户明确确认,否则不要自动创建项目文件、安装软件包或运行设置命令。
  • Vue 应用创建限制: 仅当用户明确要求创建 Vue 应用/项目时,才创建或搭建新的 Vue 应用,例如“创建 Vue 应用并渲染 Spreadsheet”或“创建 Vite/Vue 应用并添加 Spreadsheet”。对于“用数据创建电子表格”或“添加 Spreadsheet”之类的常规请求,应将其视为针对现有 Vue 项目的组件代码生成请求。

安全

  • 仅包含文档: 如果没有捆绑可执行运行时代码,此技能仅包含文档和参考代码片段。除非明确添加了运行时文件,否则应将此仓库视作文档。
  • 清理指南: 始终验证、规范化并清理从远程文件或用户上传内容中提取的输入。拒绝或隔离宏/JavaScript 内容,并在处理前剥离活动内容。示例中优先使用模拟/本地端点,绝不要向演示端点发送个人身份信息或机密信息。
  • 外部资源: 演示代码可以引用官方 Syncfusion 端点(syncfusion.com、ej2.syncfusion.com、document.syncfusion.com)。在生产环境中,优先使用固定版本的软件包(npm/NuGet);使用 CDN 资源时,应添加子资源完整性(SRI)。

评论

支持 Markdown