sheetnext 0.1.6 → 0.1.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/AGENT.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  ## 文档导航
6
6
 
7
- - [← 返回 README](./README.md) - 快速开始和特点介绍
8
- - [← API 文档](./DOCS.md) - 详细的类、方法和属性说明
7
+ - [← 返回 README](https://github.com/wyyazlz/sheetnext/blob/master/README.md) - 快速开始和特点介绍
8
+ - [← API 文档](https://github.com/wyyazlz/sheetnext/blob/master/DOCS.md) - 详细的类、方法和属性说明
9
9
 
10
10
  ---
11
11
 
@@ -92,12 +92,12 @@ const OpenAI = require('openai');
92
92
  const CONFIG = {
93
93
  model: 'claude-sonnet-4-5-20250929', // 设置模型名称,自动判断使用 claude 还是 openai
94
94
  claude: {
95
- apiKey: 'sk-xWp4TFA81arQCudIbLRmE0h1TtmM0lQWz4Lt7lKryUhk5HhN',
96
- baseURL: 'https://m5.aitoo.fun/'
95
+ apiKey: 'your-apiKey',
96
+ baseURL: 'https://xx.xx.xx/'
97
97
  },
98
98
  openai: {
99
- apiKey: 'sk-UWq0SWmDIEFTI5hswtg5uONjQ95ECUneWtp46Pp9Kdujg9py',
100
- baseURL: 'https://m5.aitoo.fun/v1'
99
+ apiKey: 'your-apiKey',
100
+ baseURL: 'https://xx.xx.xx/v1'
101
101
  }
102
102
  };
103
103
 
package/DOCS.md CHANGED
@@ -12,6 +12,7 @@
12
12
  - [Row Class](#Row) - 行管理:行高、批量行样式、获取行内单元格、显示/隐藏等
13
13
  - [Col Class](#Col) - 列管理:列宽、批量列样式、获取列内单元格、显示/隐藏等
14
14
  - [Drawing Class](#Drawing) - 图形管理:图表、图形、图片的增删改查、设置位置和尺寸、调整图层顺序等
15
+ - [Layout Class](#Layout) - 布局管理:显示/隐藏菜单栏、工具栏、公式栏、AI 聊天面板等界面元素
15
16
  - [Utils Class](#Utils) - 坐标转换:单元格字符串与数字坐标互转、列字母与数字互转、范围格式转换等
16
17
  - [UndoRedo Class](#UndoRedo) - 历史管理:撤销/重做操作
17
18
 
@@ -30,7 +31,7 @@ const SN = new SheetNext(dom: HTMLElement, options?: object)
30
31
 
31
32
  **参数:**
32
33
  - `dom`: 容器 DOM 元素(必需)
33
- - `options`: 可选配置对象(详见 [README 初始化配置](./README.md#初始化配置))
34
+ - `options`: 可选配置对象(详见 [README 初始化配置](https://github.com/wyyazlz/sheetnext/blob/master/README.md#初始化配置))
34
35
 
35
36
  ### 核心属性
36
37
 
@@ -107,13 +108,6 @@ for (let i = 0; i < 100; i++) {
107
108
  SN.r();
108
109
  ```
109
110
 
110
- #### `activateLicense(licenseKey: string)`
111
- 激活 License 授权。
112
-
113
- ```javascript
114
- SN.activateLicense("your-license-key");
115
- ```
116
-
117
111
  #### `getLicenseInfo()`
118
112
  获取 License 信息。
119
113
 
@@ -606,6 +600,142 @@ drawing.updIndex("top"); // 移到最上层
606
600
 
607
601
  ---
608
602
 
603
+ ## Layout
604
+
605
+ Layout 类管理编辑器的界面布局,包括菜单栏、工具栏、公式栏、Sheet 标签栏和 AI 聊天面板等界面元素的显示与隐藏。
606
+
607
+ ### 构造函数
608
+
609
+ Layout 类由 SheetNext 自动创建,通过 `SN.Layout` 访问。
610
+
611
+ ```javascript
612
+ const SN = new SheetNext(dom, {
613
+ menuList: [...], // 自定义菜单配置(可选)
614
+ menuRight: {...} // 自定义右侧菜单(可选)
615
+ });
616
+ ```
617
+
618
+ **注意:** `menuList` 和 `menuRight` 只能在初始化时传入,后续无法修改。
619
+
620
+ ### 属性
621
+
622
+ | 属性 | 类型 | 说明 |
623
+ |------|------|------|
624
+ | `showMenuBar` | `boolean` | 是否显示菜单栏(可读写) |
625
+ | `showToolbar` | `boolean` | 是否显示工具栏(可读写) |
626
+ | `showFormulaBar` | `boolean` | 是否显示公式栏(可读写) |
627
+ | `showSheetTabBar` | `boolean` | 是否显示 Sheet 标签栏(可读写) |
628
+ | `showAIChat` | `boolean` | 是否显示 AI 聊天面板(可读写) |
629
+ | `showAIChatWindow` | `boolean` | 是否显示 AI 聊天小窗口模式(可读写) |
630
+ | `isSmallWindow` | `boolean` | 当前是否为小窗口模式(宽度 < 900px)(只读) |
631
+ | `menuConfig` | `object` | 菜单配置对象(只读) |
632
+
633
+ ### 菜单配置(初始化时)
634
+
635
+ #### menuList 配置
636
+
637
+ `menuList` 用于自定义顶部菜单栏,只能在初始化时传入。
638
+
639
+ **MenuList 结构:**
640
+
641
+ ```typescript
642
+ interface MenuItem {
643
+ label: string; // 菜单项标签
644
+ handler?: () => void; // 点击处理函数
645
+ disabled?: boolean; // 是否禁用
646
+ tip?: string; // 提示信息(右侧显示)
647
+ divider?: boolean; // 是否为分隔线
648
+ }
649
+
650
+ interface Menu {
651
+ label: string; // 菜单标签
652
+ items: MenuItem[]; // 菜单项列表
653
+ }
654
+
655
+ type MenuList = Menu[];
656
+ ```
657
+
658
+ **完整示例:**
659
+
660
+ ```javascript
661
+ const SN = new SheetNext(document.querySelector('#container'), {
662
+ // 配置后覆盖原配置
663
+ menuList: [
664
+ {
665
+ label: '文件',
666
+ items: [
667
+ { label: '导入 XLSX', handler: () => SN.containerDom.querySelector('.sn-upload').click() },
668
+ { divider: true },
669
+ { label: '导出 XLSX', handler: () => SN.export('XLSX') }
670
+ ]
671
+ },
672
+ {
673
+ label: '插入',
674
+ items: [
675
+ { label: '插入行', handler: () => SN.AI.chatInput('在表最后新插入10行') },
676
+ { label: '插入列', handler: () => SN.AI.chatInput('在表最后新插入10列') },
677
+ { label: '超链接', handler: () => SN.AI.chatInput('在A1插入超链接,文本:SN 地址:https://www.sheetnext.com') },
678
+ { label: '图片', disabled: true, tip: '待开放' },
679
+ { label: '图表', handler: () => SN.AI.chatInput('根据表中数据生成柱状图') },
680
+ { label: '图形', disabled: true, tip: '待开放' },
681
+ { label: '数据透视表', disabled: true, tip: '待开放' },
682
+ { label: '公式', handler: () => SN.AI.chatInput('在A1编写公式,求F18:G21的平均值') }
683
+ ]
684
+ },
685
+ {
686
+ label: '视图',
687
+ items: [
688
+ { label: '显示行列标', handler: () => { SN.activeSheet.showRowColHeaders = true; SN.r(); } },
689
+ { label: '隐藏行列标', handler: () => { SN.activeSheet.showRowColHeaders = false; SN.r(); } },
690
+ { label: '显示网格线', handler: () => { SN.activeSheet.showGridLines = true; SN.r(); } },
691
+ { label: '隐藏网格线', handler: () => { SN.activeSheet.showGridLines = false; SN.r(); } },
692
+ { label: '冻结首行', handler: () => { SN.activeSheet.ySplit = 1; SN.r(); } },
693
+ { label: '冻结首列', handler: () => { SN.activeSheet.xSplit = 1; SN.r(); } }
694
+ ]
695
+ },
696
+ {
697
+ label: '更多',
698
+ items: [
699
+ { label: 'SheetNext Pro', handler: () => window.open('https://www.sheetnext.com/pro') },
700
+ { label: '开发文档', handler: () => window.open('https://www.github.com/wyyazlz/sheetnext') },
701
+ ]
702
+ }
703
+ ]
704
+ });
705
+ ```
706
+
707
+ **默认菜单:**
708
+
709
+ 如果不传入 `menuList`,将使用默认菜单配置(包含:文件、插入、视图、更多)。
710
+
711
+ #### menuRight 配置
712
+
713
+ `menuRight` 用于自定义菜单栏右侧区域,只能在初始化时传入。
714
+
715
+ **MenuRight 结构:**
716
+
717
+ ```typescript
718
+ interface MenuRight {
719
+ html: string; // HTML 内容
720
+ handler?: () => void; // 点击处理函数
721
+ }
722
+ ```
723
+
724
+ **示例:**
725
+
726
+ ```javascript
727
+ const SN = new SheetNext(document.querySelector('#container'), {
728
+ menuRight: {
729
+ html: '<span style="color: #666;">我的应用 v1.0</span>',
730
+ handler: () => {
731
+ alert('欢迎使用!');
732
+ }
733
+ }
734
+ });
735
+ ```
736
+
737
+ ---
738
+
609
739
  ## Utils
610
740
 
611
741
  Utils 类提供坐标转换等实用方法。
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2025 SheetNext
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -1,17 +1,22 @@
1
1
  <div align="center">
2
2
  <div><img src="docs/logo.png" alt="SheetNext Logo" width="100" style="vertical-align: middle;"/></div>
3
+ <h1>SheetNext</h1>
3
4
  <div>✨ 数行代码可集成一个纯前端高性能 Excel 编辑器。</div>
4
5
  <div>🤖 内置超级AI工作流程,目标用 AI 操纵 Excel 表格完成所有任务。</div>
5
6
  <div>
6
7
  <a href="https://www.sheetnext.com/">🏠 官网</a> |
7
8
  <a href="https://www.sheetnext.com/editor">🎯 在线体验</a> |
8
- <a href="./AGENT.md">🤖 AI中转文档</a> |
9
- <a href="./DOCS.md">📖 编辑器操作文档</a>
9
+ <a href="https://github.com/wyyazlz/sheetnext/blob/master/DOCS.md">📖 文档</a> |
10
+ <a href="https://github.com/wyyazlz/sheetnext/blob/master/AGENT.md">🤖 AI中转文档</a>
10
11
  </div>
11
12
  </div>
12
13
 
13
14
  ---
14
15
 
16
+ <div align="center">
17
+ <img src="docs/demo.png" alt="SheetNext Demo" />
18
+ </div>
19
+
15
20
  ## ✨ 特点
16
21
 
17
22
  - 📊 **电子表格功能** - 支持电子表格核心功能如:单元格编辑、样式、公式引擎、图表、排序、筛选等