sheetnext 0.1.8 → 0.2.0

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2025 SheetNext
+   Copyright 2025-2026 SheetNext
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,76 +1,161 @@
-<div align="center">
-  <div><img src="docs/logo.png" alt="SheetNext Logo" width="100" style="vertical-align: middle;"/></div>
-  <h1>SheetNext</h1>
-  <div>✨ 数行代码可集成一个纯前端高性能 Excel 编辑器。</div>
-  <div>🤖 内置超级AI工作流程，目标用 AI 操纵 Excel 表格完成所有任务。</div>
-  <div>
-    <a href="https://www.sheetnext.com/">🏠 官网</a> |
-    <a href="https://www.sheetnext.com/editor">🎯 在线体验</a> |
-    <a href="https://github.com/wyyazlz/sheetnext/blob/master/DOCS.md">📖 文档</a> |
-    <a href="https://github.com/wyyazlz/sheetnext/blob/master/AGENT.md">🤖 AI中转文档</a>
-  </div>
-</div>
-
----
-
-<div align="center">
-  <img src="docs/demo.png" alt="SheetNext Demo" />
-</div>
-
-## ✨ 特点
-
-- 📊 **电子表格功能** - 支持电子表格核心功能如：单元格编辑、样式、公式引擎、图表、排序、筛选等
-- 🤖 **AI 工作流** - 内置 AI 全自动操作工作流，简单配置可以生成模板、数据分析、公式编写、跨表逻辑操纵等
-- 📁 **导入导出** - 原生支持 Excel (.xlsx) 文件的导入和导出，无需插件前端秒操作
-- 🚀 **开箱即用** - 不用单独配置任何库和插件，安装后简单配置即用所有功能
-- 🔄 **快速迭代** - 版本快速迭代更新，有问题可随时联系或提交 issue
-
-## 🚀 快速开始
-
-### 📦 使用 npm 安装
-
-```bash
-npm install sheetnext
-```
-```html
-<div id="SNContainer" style="width:100vw;height:100vh;padding:0 7px 7px"></div>
-```
-```javascript
-import SheetNext from 'sheetnext';
-import 'sheetnext.css';
-
-// 注意设置容器#SNContainer宽高
-const SN = new SheetNext(document.querySelector('#SNContainer'));
-```
-
-### 🌐 浏览器直接引入
-
-```html
-<!-- 引入样式 -->
-<link rel="stylesheet" href="dist/sheetnext.css">
-
-<!-- 编辑器容器 -->
-<div id="SNContainer" style="width: 100vw; height: 100vh;padding:0 7px 7px"></div>
-
-<!-- 引入脚本 -->
-<script src="dist/sheetnext.umd.js"></script>
-
-<!-- 初始化，注意设置宽高 -->
-<script>
-  const SN = new SheetNext(document.querySelector('#SNContainer'));
-</script>
-```
-
-## ⚙️ 初始化配置
-
-```javascript
-const SN = new SheetNext(document.querySelector('#container'), {
-  AI_URL: "http://localhost:3000/sheetnextAI",  // AI 中转地址（可选）
-  AI_TOKEN: "your-token"                        // 中转 token（可选）
-});
-```
-
-## 🔗 相关链接
-
-- 🏠 [官网](https://www.sheetnext.com)
-- 📦 [npm 包地址](https://www.npmjs.com/package/sheetnext)
+<p align="center">
+  <img src="docs/logo.png" alt="SheetNext Logo" width="80" />
+</p>
+
+<p align="center">
+  A pure front-end spreadsheet component with Excel-like capabilities, built-in native AI workflows, and flexible LLM integration for data operations.
+</p>
+
+<p align="center">
+  English | <a href="./README_CN.md">简体中文</a>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/sheetnext"><img src="https://img.shields.io/npm/v/sheetnext.svg" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/sheetnext"><img src="https://img.shields.io/npm/dm/sheetnext.svg" alt="npm downloads" /></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="license" /></a>
+  <img src="https://img.shields.io/badge/rendering-Canvas-ff8c00.svg" alt="Canvas rendering" />
+  <img src="https://img.shields.io/badge/workflow-AI%20Ready-00A67E.svg" alt="AI ready" />
+  <img src="https://img.shields.io/badge/file%20support-XLSX%20%7C%20CSV%20%7C%20JSON-1f6feb.svg" alt="file support" />
+</p>
+
+<p align="center">
+  <img src="docs/image_en.png" alt="SheetNext Screenshot" width="100%" />
+</p>
+
+- SheetNext is a pure front-end, high-performance spreadsheet engine that provides enterprises with a ready-to-use intelligent spreadsheet foundation.
+- With the AI-driven development approach, a single developer + AI can integrate and deliver complex enterprise spreadsheet solutions.
+- Common scenarios like ledgers, budgets, analytics, data entry, and approvals can produce a first version in minutes.
+
+## ✨ Key Features
+
+- 📊 Full Spreadsheet Capabilities — Formula engine, charts, pivot tables, super tables, slicers, conditional formatting, data validation, sparklines, freeze panes, sorting & filtering, and more
+- 🤖 AI-Powered Workflow — Built-in AI automation for template generation, data analysis, formula writing, and cross-sheet logic
+- 📁 Native File Support — Import/export Excel (.xlsx), CSV, and JSON out of the box, no extra plugins needed
+- 🚀 Zero-Config Setup — All features built in, no additional dependencies required
+- ⚡ High-Performance Rendering — Canvas-based virtual scrolling handles large datasets with ease
+
+## 🚀 Quick Start
+
+SheetNext can be integrated with just a few lines of code and works with any front-end framework (Vue, React, Angular, etc.).
+
+### Option 1: Traditional Integration
+
+#### Install via npm
+
+```bash
+npm install sheetnext
+```
+
+```html
+<!-- Container for the editor -->
+<div id="SNContainer" style="width:100vw;height:100vh;padding:0 7px 7px"></div>
+```
+
+```javascript
+import SheetNext from 'sheetnext';
+import 'sheetnext/dist/sheetnext.css';
+
+const SN = new SheetNext(document.querySelector('#SNContainer'));
+```
+
+#### Browser Direct Import (UMD)
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>SheetNext Demo</title>
+  <link rel="stylesheet" href="dist/sheetnext.css">
+</head>
+<body>
+  <div id="SNContainer" style="width:100vw;height:100vh;padding:0 7px 7px"></div>
+  <script src="dist/sheetnext.umd.js"></script>
+  <script>
+    const SN = new SheetNext(document.querySelector('#SNContainer'));
+  </script>
+</body>
+</html>
+```
+
+#### Internationalization (i18n)
+
+The default language is English (en-US). A built-in Chinese (zh-CN) locale is available.
+
+Import locale via npm:
+
+```javascript
+import SheetNext from 'sheetnext';
+import zhCN from 'sheetnext/locales/zh-CN.js';
+
+SheetNext.registerLocale('zh-CN', zhCN);
+
+const SN = new SheetNext(document.querySelector('#SNContainer'), {
+  locale: 'zh-CN'
+});
+```
+
+Import locale via UMD:
+
+```html
+<script src="dist/sheetnext.umd.js"></script>
+<script src="dist/locales/zh-CN.js"></script>
+<script>
+  const SN = new SheetNext(document.querySelector('#SNContainer'), {
+    locale: 'zh-CN'
+  });
+</script>
+```
+
+### Option 2: AI-Driven Development (Recommended)
+
+#### Step 1: Download the AI Development Reference
+
+- Download `docs-detail.md` from the repository root: [docs-detail.md](https://github.com/wyyazlz/sheetnext/blob/master/docs/docs-detail.md)
+
+#### Step 2: Feed `docs-detail` to Your AI Tool
+
+Use Cursor / Claude / ChatGPT / Copilot or any AI coding assistant. Provide `docs-detail` first, then describe your requirements.
+
+Recommended prompt template:
+
+```text
+You are a senior SheetNext AI development expert. Please read and understand the documentation I provide, then give a directly implementable solution.
+Execution order:
+1) Read: docs-detail
+2) Identify user goals (business goals + technical goals)
+3) Output a minimum viable implementation (get it running first, then optimize)
+4) All APIs and code must strictly follow the documentation
+5) Provide verification steps and risk points
+Constraints:
+- Do not fabricate APIs
+- Do not skip edge cases
+- Prioritize reusing existing capabilities, avoid over-engineering
+```
+
+#### Step 3: Describe Your Business Goal
+
+For example:
+
+- "Build a sales pivot analysis template with charts and slicers"
+- "Build a multi-sheet budget entry system with permissions and printing"
+- "Migrate an existing Excel template to an online editable version"
+
+## 🎯 Use Cases
+
+- Online reporting systems, BI analytics front-ends, business dashboards
+- Spreadsheet engine modules in ERP / CRM / Finance / Supply Chain systems
+- Complex business forms for budgets, settlements, reconciliation, planning, and scheduling
+- AI-powered scenarios: auto-generate tables, analysis, templates, and logic
+
+## Browser Support
+
+| Chrome | Firefox | Safari | Edge |
+|--------|---------|--------|------|
+| 80+ | 75+ | 13+ | 80+ |
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).

package/README_CN.md

@@ -0,0 +1,161 @@
+<p align="center">
+  <img src="docs/logo.png" alt="SheetNext Logo" width="80" />
+</p>
+
+<p align="center">
+  一款纯前端、媲美 Excel 的电子表格控件，内置原生 AI 工作流，可灵活接入大模型进行数据操作。
+</p>
+
+<p align="center">
+  <a href="./README.md">English</a> | 简体中文
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/sheetnext"><img src="https://img.shields.io/npm/v/sheetnext.svg" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/sheetnext"><img src="https://img.shields.io/npm/dm/sheetnext.svg" alt="npm downloads" /></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="license" /></a>
+  <img src="https://img.shields.io/badge/rendering-Canvas-ff8c00.svg" alt="Canvas rendering" />
+  <img src="https://img.shields.io/badge/workflow-AI%20Ready-00A67E.svg" alt="AI ready" />
+  <img src="https://img.shields.io/badge/file%20support-XLSX%20%7C%20CSV%20%7C%20JSON-1f6feb.svg" alt="file support" />
+</p>
+
+<p align="center">
+  <img src="docs/image_en.png" alt="SheetNext Screenshot" width="100%" />
+</p>
+
+- SheetNext 是一款纯前端、高性能的电子表格引擎，为企业提供开箱即用的智能表格能力底座。
+- 提供AI开发方案，一个人 + AI，即可完成企业级复杂表格业务的集成与交付。
+- 台账、预算、分析、填报、审批等常见场景，几分钟产出首版。
+
+## ✨ 核心特点
+
+- 📊 完整的电子表格功能 — 公式引擎、图表、数据透视表、超级表、切片器、条件格式、数据验证、迷你图、冻结窗格、排序筛选等高级能力全覆盖
+- 🤖 AI 智能工作流 — 内置 AI 全自动操作流程，模板生成、数据分析、公式编写、跨表逻辑轻松实现
+- 📁 原生文件支持 — 原生支持 Excel (.xlsx)、CSV、JSON 导入导出，无需额外插件
+- 🚀 开箱即用 — 零配置启动，所有功能内置，无需单独安装依赖库
+- ⚡ 高性能渲染 — 基于 Canvas 虚拟滚动，轻松处理大数据量表格
+
+## 🚀 快速开始
+
+SheetNext 只需数行代码即可引入完整功能，支持 Vue、React、Angular 等任意前端框架。
+
+### 方案一：传统开发集成
+
+#### 使用 npm 安装
+
+```bash
+npm install sheetnext
+```
+
+```html
+<!-- 放置编辑器的容器 -->
+<div id="SNContainer" style="width:100vw;height:100vh;padding:0 7px 7px"></div>
+```
+
+```javascript
+import SheetNext from 'sheetnext';
+import 'sheetnext/dist/sheetnext.css';
+
+const SN = new SheetNext(document.querySelector('#SNContainer'));
+```
+
+#### 浏览器直接引入（UMD）
+
+```html
+<!DOCTYPE html>
+<html lang="zh-CN">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>SheetNext Demo</title>
+  <link rel="stylesheet" href="dist/sheetnext.css">
+</head>
+<body>
+  <div id="SNContainer" style="width:100vw;height:100vh;padding:0 7px 7px"></div>
+  <script src="dist/sheetnext.umd.js"></script>
+  <script>
+    const SN = new SheetNext(document.querySelector('#SNContainer'));
+  </script>
+</body>
+</html>
+```
+
+#### 国际化配置
+
+默认语言为英文（en-US），内置中文（zh-CN）语言包。
+
+npm 方式引入语言包：
+
+```javascript
+import SheetNext from 'sheetnext';
+import zhCN from 'sheetnext/locales/zh-CN.js';
+
+SheetNext.registerLocale('zh-CN', zhCN);
+
+const SN = new SheetNext(document.querySelector('#SNContainer'), {
+  locale: 'zh-CN'
+});
+```
+
+UMD 方式引入语言包：
+
+```html
+<script src="dist/sheetnext.umd.js"></script>
+<script src="dist/locales/zh-CN.js"></script>
+<script>
+  const SN = new SheetNext(document.querySelector('#SNContainer'), {
+    locale: 'zh-CN'
+  });
+</script>
+```
+
+### 方案二：AI 驱动开发（推荐）
+
+#### Step 1：下载 AI 开发资料
+
+- 下载仓库根目录的 `docs-detail.md`：[docs-detail.md](https://github.com/wyyazlz/sheetnext/blob/master/docs/docs-detail.md)
+
+#### Step 2：把 `docs-detail` 交给 AI
+
+可使用 Cursor / Claude / ChatGPT / Copilot 等工具，先喂 `docs-detail` 再提需求。
+
+推荐指令模板：
+
+```text
+你是资深 SheetNext AI 开发专家，请先阅读并理解我提供的文档，再给出可直接落地的方案。
+执行顺序：
+1) 先阅读：docs-detail
+2) 识别用户目标（业务目标 + 技术目标）
+3) 输出最小可行实现（先能跑，再优化）
+4) 所有 API 与代码写法必须严格对齐文档
+5) 给出验证步骤和风险点
+约束：
+- 不编造 API
+- 不跳过边界条件
+- 优先复用已有能力，避免过度设计
+```
+
+#### Step 3：给出你的业务目标
+
+例如：
+
+- "做一个销售数据透视分析模板，包含图表和切片器"
+- "做一个多 sheet 的预算填报系统，带权限和打印"
+- "把现有 Excel 模板迁移成在线可编辑版本"
+
+## 🎯 适用场景
+
+- 在线报表系统、BI 分析前端、经营驾驶舱
+- ERP/CRM/财务/供应链系统中的表格引擎模块
+- 预算、结算、对账、计划、排产等复杂业务表单
+- AI 自动做表、自动分析、自动生成模板与逻辑的场景
+
+## 浏览器支持
+
+| Chrome | Firefox | Safari | Edge |
+|--------|---------|--------|------|
+| 80+ | 75+ | 13+ | 80+ |
+
+## 许可证
+
+Apache-2.0，详见 [LICENSE](./LICENSE)。