@sheetpane/grid 0.0.0-stage → 0.1.0
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/LICENSE +21 -0
- package/README.md +429 -2
- package/custom-elements.json +1246 -0
- package/dist/errors/element.d.ts +108 -0
- package/dist/errors/element.d.ts.map +1 -0
- package/dist/errors/element.js +456 -0
- package/dist/errors/element.js.map +1 -0
- package/dist/errors/index.d.ts +2 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/errors/index.js +3 -0
- package/dist/errors/index.js.map +1 -0
- package/dist/excel/element.d.ts +434 -0
- package/dist/excel/element.d.ts.map +1 -0
- package/dist/excel/element.js +3382 -0
- package/dist/excel/element.js.map +1 -0
- package/dist/excel/geometry.d.ts +81 -0
- package/dist/excel/geometry.d.ts.map +1 -0
- package/dist/excel/geometry.js +137 -0
- package/dist/excel/geometry.js.map +1 -0
- package/dist/excel/index.d.ts +2 -0
- package/dist/excel/index.d.ts.map +1 -0
- package/dist/excel/index.js +3 -0
- package/dist/excel/index.js.map +1 -0
- package/dist/excel/selection.d.ts +103 -0
- package/dist/excel/selection.d.ts.map +1 -0
- package/dist/excel/selection.js +189 -0
- package/dist/excel/selection.js.map +1 -0
- package/dist/excel/styles.d.ts +3 -0
- package/dist/excel/styles.d.ts.map +1 -0
- package/dist/excel/styles.js +206 -0
- package/dist/excel/styles.js.map +1 -0
- package/dist/frameworks/elements.d.ts +136 -0
- package/dist/frameworks/jsx.d.ts +64 -0
- package/dist/frameworks/jsx.js +2 -0
- package/dist/frameworks/solid.d.ts +133 -0
- package/dist/frameworks/solid.js +2 -0
- package/dist/frameworks/svelte.d.ts +102 -0
- package/dist/frameworks/svelte.js +2 -0
- package/dist/frameworks/vue.d.ts +69 -0
- package/dist/frameworks/vue.js +2 -0
- package/dist/index.d.ts +23 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +25 -0
- package/dist/index.js.map +1 -0
- package/dist/llms-full.txt +8028 -0
- package/dist/llms.txt +111 -0
- package/dist/pane/index.d.ts +2 -0
- package/dist/pane/index.d.ts.map +1 -0
- package/dist/pane/index.js +3 -0
- package/dist/pane/index.js.map +1 -0
- package/dist/pane/registry.d.ts +33 -0
- package/dist/pane/registry.d.ts.map +1 -0
- package/dist/pane/registry.js +73 -0
- package/dist/pane/registry.js.map +1 -0
- package/dist/pane/rules.d.ts +231 -0
- package/dist/pane/rules.d.ts.map +1 -0
- package/dist/pane/rules.js +792 -0
- package/dist/pane/rules.js.map +1 -0
- package/dist/pane/store.d.ts +385 -0
- package/dist/pane/store.d.ts.map +1 -0
- package/dist/pane/store.js +1028 -0
- package/dist/pane/store.js.map +1 -0
- package/dist/pane/types.d.ts +130 -0
- package/dist/pane/types.d.ts.map +1 -0
- package/dist/pane/types.js +22 -0
- package/dist/pane/types.js.map +1 -0
- package/dist/plugins/host.d.ts +56 -0
- package/dist/plugins/host.d.ts.map +1 -0
- package/dist/plugins/host.js +124 -0
- package/dist/plugins/host.js.map +1 -0
- package/dist/plugins/types.d.ts +159 -0
- package/dist/plugins/types.d.ts.map +1 -0
- package/dist/plugins/types.js +12 -0
- package/dist/plugins/types.js.map +1 -0
- package/dist/rules.schema.json +52 -0
- package/dist/shared/dom.d.ts +23 -0
- package/dist/shared/dom.d.ts.map +1 -0
- package/dist/shared/dom.js +32 -0
- package/dist/shared/dom.js.map +1 -0
- package/dist/skills-bin.d.ts +3 -0
- package/dist/skills-bin.d.ts.map +1 -0
- package/dist/skills-bin.js +9 -0
- package/dist/skills-bin.js.map +1 -0
- package/dist/style.css +3 -0
- package/dist/tokens.d.ts +49 -0
- package/dist/tokens.d.ts.map +1 -0
- package/dist/tokens.js +43 -0
- package/dist/tokens.js.map +1 -0
- package/dist/vscode.css-custom-data.json +365 -0
- package/dist/vscode.html-custom-data.json +218 -0
- package/dist/web-types.json +914 -0
- package/package.json +72 -3
|
@@ -0,0 +1,1246 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "2.1.0",
|
|
3
|
+
"readme": "README.md",
|
|
4
|
+
"modules": [
|
|
5
|
+
{
|
|
6
|
+
"kind": "javascript-module",
|
|
7
|
+
"path": "dist/excel/element.js",
|
|
8
|
+
"declarations": [
|
|
9
|
+
{
|
|
10
|
+
"kind": "class",
|
|
11
|
+
"name": "SheetpaneExcel",
|
|
12
|
+
"customElement": true,
|
|
13
|
+
"tagName": "sheetpane-excel",
|
|
14
|
+
"summary": "`<sheetpane-excel>` — the sheet: views and edits a `.xlsx` or `.csv` file held in the pane's in-memory workbook (SR-GRID decisions 9–22e).",
|
|
15
|
+
"description": "`<sheetpane-excel>` — the sheet: views and edits a `.xlsx` or `.csv` file held in the pane's in-memory workbook (SR-GRID decisions 9–22e). Every change stays in memory and `export()` writes a copy of the upload with it (SR-LAW-6); a `<sheetpane-errors>` on the same `pane` reads the same store, so the two are always in step (SR-LAW-7). It registers on import.\n\nSee SR-GRID: https://github.com/arpitarya/sheetpane/blob/main/records/0105_GRID.md",
|
|
16
|
+
"superclass": {
|
|
17
|
+
"name": "HTMLElement"
|
|
18
|
+
},
|
|
19
|
+
"attributes": [
|
|
20
|
+
{
|
|
21
|
+
"name": "pane",
|
|
22
|
+
"description": "The pane id shared with other elements; none gives the element its own store.",
|
|
23
|
+
"type": {
|
|
24
|
+
"text": "string"
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "src",
|
|
29
|
+
"description": "A URL (read with a GET; nothing is sent), a data URL or base64.",
|
|
30
|
+
"type": {
|
|
31
|
+
"text": "string"
|
|
32
|
+
},
|
|
33
|
+
"fieldName": "src"
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"name": "mode",
|
|
37
|
+
"description": "`view` (the default) or `edit`.",
|
|
38
|
+
"type": {
|
|
39
|
+
"text": "'view' | 'edit'"
|
|
40
|
+
},
|
|
41
|
+
"default": "'view'",
|
|
42
|
+
"fieldName": "mode"
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "display",
|
|
46
|
+
"description": "`tab` (the default) or `popup` (a modal dialog, shown by `open`).",
|
|
47
|
+
"type": {
|
|
48
|
+
"text": "'tab' | 'popup'"
|
|
49
|
+
},
|
|
50
|
+
"default": "'tab'"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "open",
|
|
54
|
+
"description": "Shows the pop-up.",
|
|
55
|
+
"type": {
|
|
56
|
+
"text": "boolean"
|
|
57
|
+
},
|
|
58
|
+
"fieldName": "open"
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
"name": "author",
|
|
62
|
+
"description": "Written into the errors this element's user flags.",
|
|
63
|
+
"type": {
|
|
64
|
+
"text": "string"
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"name": "plugins",
|
|
69
|
+
"description": "Space-separated registered plugin ids; fixed per pane.",
|
|
70
|
+
"type": {
|
|
71
|
+
"text": "string"
|
|
72
|
+
}
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"name": "theme",
|
|
76
|
+
"description": "`light` (the default), `dark` or `auto`.",
|
|
77
|
+
"type": {
|
|
78
|
+
"text": "'light' | 'dark' | 'auto'"
|
|
79
|
+
},
|
|
80
|
+
"default": "'light'",
|
|
81
|
+
"fieldName": "theme"
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"name": "header-row",
|
|
85
|
+
"description": "The 1-based row holding column titles (default 1).",
|
|
86
|
+
"type": {
|
|
87
|
+
"text": "number"
|
|
88
|
+
},
|
|
89
|
+
"default": "1"
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"name": "on-invalid",
|
|
93
|
+
"description": "`flag` (the default) or `block`: what a failing column rule does.",
|
|
94
|
+
"type": {
|
|
95
|
+
"text": "'flag' | 'block'"
|
|
96
|
+
},
|
|
97
|
+
"default": "'flag'",
|
|
98
|
+
"fieldName": "onInvalid"
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"name": "rules-src",
|
|
102
|
+
"description": "A URL to a rules file (read with a GET).",
|
|
103
|
+
"type": {
|
|
104
|
+
"text": "string"
|
|
105
|
+
}
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"name": "flagging",
|
|
109
|
+
"description": "`on` (the default) or `off`: no Flag issue anywhere.",
|
|
110
|
+
"type": {
|
|
111
|
+
"text": "'on' | 'off'"
|
|
112
|
+
},
|
|
113
|
+
"default": "'on'",
|
|
114
|
+
"fieldName": "flagging"
|
|
115
|
+
}
|
|
116
|
+
],
|
|
117
|
+
"members": [
|
|
118
|
+
{
|
|
119
|
+
"kind": "field",
|
|
120
|
+
"name": "workbook",
|
|
121
|
+
"privacy": "public",
|
|
122
|
+
"type": {
|
|
123
|
+
"text": "WorkbookStore | undefined"
|
|
124
|
+
},
|
|
125
|
+
"description": "The pane's store; assigning one replaces the `pane` lookup and applies this element's `mode` to it."
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
"kind": "field",
|
|
129
|
+
"name": "errors",
|
|
130
|
+
"privacy": "public",
|
|
131
|
+
"type": {
|
|
132
|
+
"text": "SheetpaneError[]"
|
|
133
|
+
},
|
|
134
|
+
"description": "A copy of the pane's errors; assigning restores a saved review, like `setErrors()`."
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
"kind": "field",
|
|
138
|
+
"name": "errorTypes",
|
|
139
|
+
"privacy": "public",
|
|
140
|
+
"type": {
|
|
141
|
+
"text": "readonly ErrorType[]"
|
|
142
|
+
},
|
|
143
|
+
"description": "The types offered in the Flag issue form; an empty list falls back to `DEFAULT_ERROR_TYPES`."
|
|
144
|
+
},
|
|
145
|
+
{
|
|
146
|
+
"kind": "field",
|
|
147
|
+
"name": "file",
|
|
148
|
+
"privacy": "public",
|
|
149
|
+
"type": {
|
|
150
|
+
"text": "File | Blob | ArrayBuffer | Uint8Array | null"
|
|
151
|
+
},
|
|
152
|
+
"description": "Loads a file, like `load()`; `null` does nothing."
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"kind": "field",
|
|
156
|
+
"name": "mode",
|
|
157
|
+
"privacy": "public",
|
|
158
|
+
"type": {
|
|
159
|
+
"text": "Mode"
|
|
160
|
+
},
|
|
161
|
+
"description": "The pane's mode, `view` or `edit`; setting it sets the `mode` attribute.",
|
|
162
|
+
"attribute": "mode",
|
|
163
|
+
"reflects": true
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"kind": "field",
|
|
167
|
+
"name": "theme",
|
|
168
|
+
"privacy": "public",
|
|
169
|
+
"type": {
|
|
170
|
+
"text": "Theme"
|
|
171
|
+
},
|
|
172
|
+
"description": "`light` (the default), `dark`, or `auto` (follows `prefers-color-scheme`) — colour only; the file's own colours never change (W-29).",
|
|
173
|
+
"attribute": "theme",
|
|
174
|
+
"reflects": true
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"kind": "field",
|
|
178
|
+
"name": "rules",
|
|
179
|
+
"privacy": "public",
|
|
180
|
+
"type": {
|
|
181
|
+
"text": "unknown"
|
|
182
|
+
},
|
|
183
|
+
"description": "A rules file (W-33) as an object: `{ version: 1, sheets: { \"*\": …, \"Accounts\": { headerRow, columns, cells } } }`. Also `rules-src`."
|
|
184
|
+
},
|
|
185
|
+
{
|
|
186
|
+
"kind": "field",
|
|
187
|
+
"name": "flagging",
|
|
188
|
+
"privacy": "public",
|
|
189
|
+
"type": {
|
|
190
|
+
"text": "'on' | 'off'"
|
|
191
|
+
},
|
|
192
|
+
"description": "`flagging=\"off\"`: no Flag issue anywhere, no composer, no callout card — the errors panel is the one place errors are read.",
|
|
193
|
+
"attribute": "flagging",
|
|
194
|
+
"reflects": true
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"kind": "field",
|
|
198
|
+
"name": "columns",
|
|
199
|
+
"privacy": "public",
|
|
200
|
+
"type": {
|
|
201
|
+
"text": "ColumnRules | undefined"
|
|
202
|
+
},
|
|
203
|
+
"description": "Rules by column title, as plain JSON (`required`, `type`, `min`, `max`, `minLength`, `maxLength`, `pattern`, `oneOf`, `unique`, `message`, `severity`, `onInvalid`)."
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"kind": "field",
|
|
207
|
+
"name": "validate",
|
|
208
|
+
"privacy": "public",
|
|
209
|
+
"type": {
|
|
210
|
+
"text": "ValidateFn | undefined"
|
|
211
|
+
},
|
|
212
|
+
"description": "`validate(ctx, signal)`, sync or async: `null`, or `{ severity, message, expected? }`."
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
"kind": "field",
|
|
216
|
+
"name": "onInvalid",
|
|
217
|
+
"privacy": "public",
|
|
218
|
+
"type": {
|
|
219
|
+
"text": "OnInvalid"
|
|
220
|
+
},
|
|
221
|
+
"description": "The default for every rule: `flag` (store and add an error) or `block` (refuse the value). Also the `on-invalid` attribute.",
|
|
222
|
+
"attribute": "on-invalid",
|
|
223
|
+
"reflects": true
|
|
224
|
+
},
|
|
225
|
+
{
|
|
226
|
+
"kind": "field",
|
|
227
|
+
"name": "open",
|
|
228
|
+
"privacy": "public",
|
|
229
|
+
"type": {
|
|
230
|
+
"text": "boolean"
|
|
231
|
+
},
|
|
232
|
+
"description": "Whether the pop-up is shown (the `open` attribute).",
|
|
233
|
+
"attribute": "open",
|
|
234
|
+
"reflects": true
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
"kind": "field",
|
|
238
|
+
"name": "sizes",
|
|
239
|
+
"privacy": "public",
|
|
240
|
+
"type": {
|
|
241
|
+
"text": "Record<string, { cols: Record<string, number>; rows: Record<string, number> }>"
|
|
242
|
+
},
|
|
243
|
+
"description": "The column widths and row heights a user set, px at 100 % zoom: `{ [sheet]: { cols: { B: 120 }, rows: { 4: 40 } } }`\n(columns by letter, rows by number). A view setting like zoom — not a change, not undone, not in the\ndownload; a new file clears it. Set it to restore what a host saved from `sheetpane-resize` (W-47)."
|
|
244
|
+
},
|
|
245
|
+
{
|
|
246
|
+
"kind": "field",
|
|
247
|
+
"name": "src",
|
|
248
|
+
"privacy": "public",
|
|
249
|
+
"type": {
|
|
250
|
+
"text": "string | null"
|
|
251
|
+
},
|
|
252
|
+
"description": "The `src` attribute; `null`, `undefined` or `''` removes it.",
|
|
253
|
+
"attribute": "src",
|
|
254
|
+
"reflects": true
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"kind": "method",
|
|
258
|
+
"name": "load",
|
|
259
|
+
"privacy": "public",
|
|
260
|
+
"description": "Reads a file into the pane: a File, Blob, bytes, a URL, or base64.",
|
|
261
|
+
"parameters": [
|
|
262
|
+
{
|
|
263
|
+
"name": "src",
|
|
264
|
+
"type": {
|
|
265
|
+
"text": "string | File | Blob | ArrayBuffer | Uint8Array"
|
|
266
|
+
}
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"name": "name",
|
|
270
|
+
"optional": true,
|
|
271
|
+
"type": {
|
|
272
|
+
"text": "string"
|
|
273
|
+
}
|
|
274
|
+
}
|
|
275
|
+
],
|
|
276
|
+
"return": {
|
|
277
|
+
"type": {
|
|
278
|
+
"text": "Promise<void>"
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
},
|
|
282
|
+
{
|
|
283
|
+
"kind": "method",
|
|
284
|
+
"name": "export",
|
|
285
|
+
"privacy": "public",
|
|
286
|
+
"description": "Every change applied; the upload untouched. Also dispatches `sheetpane-export`.",
|
|
287
|
+
"parameters": [
|
|
288
|
+
{
|
|
289
|
+
"name": "options",
|
|
290
|
+
"optional": true,
|
|
291
|
+
"type": {
|
|
292
|
+
"text": "Readonly<Record<string, unknown>>"
|
|
293
|
+
}
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
"name": "o",
|
|
297
|
+
"optional": true,
|
|
298
|
+
"type": {
|
|
299
|
+
"text": "{ format?: 'xlsx' | 'csv'; sheet?: string }"
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
],
|
|
303
|
+
"return": {
|
|
304
|
+
"type": {
|
|
305
|
+
"text": "Promise<Blob>"
|
|
306
|
+
}
|
|
307
|
+
}
|
|
308
|
+
},
|
|
309
|
+
{
|
|
310
|
+
"kind": "method",
|
|
311
|
+
"name": "select",
|
|
312
|
+
"privacy": "public",
|
|
313
|
+
"description": "Selects a cell and scrolls to it.",
|
|
314
|
+
"parameters": [
|
|
315
|
+
{
|
|
316
|
+
"name": "sheet",
|
|
317
|
+
"type": {
|
|
318
|
+
"text": "string"
|
|
319
|
+
}
|
|
320
|
+
},
|
|
321
|
+
{
|
|
322
|
+
"name": "ref",
|
|
323
|
+
"type": {
|
|
324
|
+
"text": "string"
|
|
325
|
+
}
|
|
326
|
+
}
|
|
327
|
+
],
|
|
328
|
+
"return": {
|
|
329
|
+
"type": {
|
|
330
|
+
"text": "void"
|
|
331
|
+
}
|
|
332
|
+
}
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
"kind": "method",
|
|
336
|
+
"name": "getErrors",
|
|
337
|
+
"privacy": "public",
|
|
338
|
+
"description": "A copy of the pane's errors, to save a review.",
|
|
339
|
+
"return": {
|
|
340
|
+
"type": {
|
|
341
|
+
"text": "SheetpaneError[]"
|
|
342
|
+
}
|
|
343
|
+
}
|
|
344
|
+
},
|
|
345
|
+
{
|
|
346
|
+
"kind": "method",
|
|
347
|
+
"name": "setErrors",
|
|
348
|
+
"privacy": "public",
|
|
349
|
+
"description": "Restores a saved review; not a user action, so the undo stack is cleared.",
|
|
350
|
+
"parameters": [
|
|
351
|
+
{
|
|
352
|
+
"name": "list",
|
|
353
|
+
"type": {
|
|
354
|
+
"text": "SheetpaneError[]"
|
|
355
|
+
}
|
|
356
|
+
}
|
|
357
|
+
],
|
|
358
|
+
"return": {
|
|
359
|
+
"type": {
|
|
360
|
+
"text": "void"
|
|
361
|
+
}
|
|
362
|
+
}
|
|
363
|
+
},
|
|
364
|
+
{
|
|
365
|
+
"kind": "method",
|
|
366
|
+
"name": "undo",
|
|
367
|
+
"privacy": "public",
|
|
368
|
+
"description": "Undoes the pane's last step.",
|
|
369
|
+
"return": {
|
|
370
|
+
"type": {
|
|
371
|
+
"text": "void"
|
|
372
|
+
}
|
|
373
|
+
}
|
|
374
|
+
},
|
|
375
|
+
{
|
|
376
|
+
"kind": "method",
|
|
377
|
+
"name": "redo",
|
|
378
|
+
"privacy": "public",
|
|
379
|
+
"description": "Redoes the last undone step.",
|
|
380
|
+
"return": {
|
|
381
|
+
"type": {
|
|
382
|
+
"text": "void"
|
|
383
|
+
}
|
|
384
|
+
}
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
"kind": "method",
|
|
388
|
+
"name": "column",
|
|
389
|
+
"privacy": "public",
|
|
390
|
+
"description": "The column a payload names: index, letter and the title from the header row (`header-row`, default 1).",
|
|
391
|
+
"parameters": [
|
|
392
|
+
{
|
|
393
|
+
"name": "sheet",
|
|
394
|
+
"type": {
|
|
395
|
+
"text": "string"
|
|
396
|
+
}
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
"name": "ref",
|
|
400
|
+
"type": {
|
|
401
|
+
"text": "string"
|
|
402
|
+
}
|
|
403
|
+
}
|
|
404
|
+
],
|
|
405
|
+
"return": {
|
|
406
|
+
"type": {
|
|
407
|
+
"text": "{ index: number; letter: string; header: string }"
|
|
408
|
+
}
|
|
409
|
+
}
|
|
410
|
+
},
|
|
411
|
+
{
|
|
412
|
+
"kind": "method",
|
|
413
|
+
"name": "shortcuts",
|
|
414
|
+
"privacy": "public",
|
|
415
|
+
"description": "The grid's keys, then every plugin control's shortcut (W-14 DoD 8).",
|
|
416
|
+
"return": {
|
|
417
|
+
"type": {
|
|
418
|
+
"text": "{ keys: string; what: string }[]"
|
|
419
|
+
}
|
|
420
|
+
}
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
"kind": "method",
|
|
424
|
+
"name": "reveal",
|
|
425
|
+
"privacy": "public",
|
|
426
|
+
"description": "Shows hidden rows or columns for viewing, in this element only — never a change (W-49).\n@param sheet - The sheet's name.\n@param axis - `rows` or `cols`.\n@param indexes - The 0-based rows or columns.",
|
|
427
|
+
"parameters": [
|
|
428
|
+
{
|
|
429
|
+
"name": "sheet",
|
|
430
|
+
"type": {
|
|
431
|
+
"text": "string"
|
|
432
|
+
}
|
|
433
|
+
},
|
|
434
|
+
{
|
|
435
|
+
"name": "axis",
|
|
436
|
+
"type": {
|
|
437
|
+
"text": "'rows' | 'cols'"
|
|
438
|
+
}
|
|
439
|
+
},
|
|
440
|
+
{
|
|
441
|
+
"name": "indexes",
|
|
442
|
+
"type": {
|
|
443
|
+
"text": "readonly number[]"
|
|
444
|
+
}
|
|
445
|
+
}
|
|
446
|
+
],
|
|
447
|
+
"return": {
|
|
448
|
+
"type": {
|
|
449
|
+
"text": "void"
|
|
450
|
+
}
|
|
451
|
+
}
|
|
452
|
+
},
|
|
453
|
+
{
|
|
454
|
+
"kind": "method",
|
|
455
|
+
"name": "unreveal",
|
|
456
|
+
"privacy": "public",
|
|
457
|
+
"description": "Hides again what this element revealed for viewing on a sheet (W-49).\n@param sheet - The sheet's name.",
|
|
458
|
+
"parameters": [
|
|
459
|
+
{
|
|
460
|
+
"name": "sheet",
|
|
461
|
+
"type": {
|
|
462
|
+
"text": "string"
|
|
463
|
+
}
|
|
464
|
+
}
|
|
465
|
+
],
|
|
466
|
+
"return": {
|
|
467
|
+
"type": {
|
|
468
|
+
"text": "void"
|
|
469
|
+
}
|
|
470
|
+
}
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
"kind": "method",
|
|
474
|
+
"name": "renderNow",
|
|
475
|
+
"privacy": "public",
|
|
476
|
+
"description": "Renders now (tests and the first frame).",
|
|
477
|
+
"return": {
|
|
478
|
+
"type": {
|
|
479
|
+
"text": "void"
|
|
480
|
+
}
|
|
481
|
+
}
|
|
482
|
+
},
|
|
483
|
+
{
|
|
484
|
+
"kind": "method",
|
|
485
|
+
"name": "geometryFor",
|
|
486
|
+
"privacy": "public",
|
|
487
|
+
"description": "Geometry as plugins see it: pixels at 100 % zoom from A1's top-left.",
|
|
488
|
+
"parameters": [
|
|
489
|
+
{
|
|
490
|
+
"name": "sheet",
|
|
491
|
+
"type": {
|
|
492
|
+
"text": "string"
|
|
493
|
+
}
|
|
494
|
+
}
|
|
495
|
+
],
|
|
496
|
+
"return": {
|
|
497
|
+
"type": {
|
|
498
|
+
"text": "Geometry | undefined"
|
|
499
|
+
}
|
|
500
|
+
}
|
|
501
|
+
}
|
|
502
|
+
],
|
|
503
|
+
"events": [
|
|
504
|
+
{
|
|
505
|
+
"name": "sheetpane-load",
|
|
506
|
+
"type": {
|
|
507
|
+
"text": "CustomEvent<{ status: 'ready'; name: string; kind: 'xlsx' | 'csv'; sheets: string[]; readMs: number } | { status: 'error'; code: string; spCode: SpCode; message: string; name: string; detail?: string }>"
|
|
508
|
+
},
|
|
509
|
+
"description": "`{ status: 'ready', name, kind, sheets, readMs }` when a file is read, or the refusal `{ status: 'error', code, spCode, message, name, detail? }`."
|
|
510
|
+
},
|
|
511
|
+
{
|
|
512
|
+
"name": "sheetpane-change",
|
|
513
|
+
"type": {
|
|
514
|
+
"text": "CustomEvent<{ sheet: string; ref: string; kind: ChangeKind; was: unknown; now: unknown }>"
|
|
515
|
+
},
|
|
516
|
+
"description": "`{ sheet, ref, kind, was, now }` for each change, undo and redo included."
|
|
517
|
+
},
|
|
518
|
+
{
|
|
519
|
+
"name": "sheetpane-errors",
|
|
520
|
+
"type": {
|
|
521
|
+
"text": "CustomEvent<{ errors: SheetpaneError[]; plugins: string[] }>"
|
|
522
|
+
},
|
|
523
|
+
"description": "`{ errors, plugins }` when the pane's errors change."
|
|
524
|
+
},
|
|
525
|
+
{
|
|
526
|
+
"name": "sheetpane-select",
|
|
527
|
+
"type": {
|
|
528
|
+
"text": "CustomEvent<{ sheet: string; ref: string; range: string | undefined; column: { index: number; letter: string; header: string }; value: unknown }>"
|
|
529
|
+
},
|
|
530
|
+
"description": "`{ sheet, ref, range, column, value }` when the selection settles — `range` (`B3:D8`) when more than one cell is selected; a drag fires once, on release."
|
|
531
|
+
},
|
|
532
|
+
{
|
|
533
|
+
"name": "sheetpane-visibility",
|
|
534
|
+
"type": {
|
|
535
|
+
"text": "CustomEvent<{ sheet: string; axis: 'row' | 'col' | 'sheet'; indexes: number[]; hidden: boolean; via: 'menu' | 'key' | 'marker' | 'reveal' }>"
|
|
536
|
+
},
|
|
537
|
+
"description": "`{ sheet, axis, indexes, hidden, via }` when rows, columns or a sheet are hidden, unhidden or shown for viewing (`via: 'reveal'`) (W-49)."
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
"name": "sheetpane-resize",
|
|
541
|
+
"type": {
|
|
542
|
+
"text": "CustomEvent<{ sheet: string; axis: 'col' | 'row'; indexes: number[]; px: number | number[]; via: 'drag' | 'fit' | 'menu' | 'reset' }>"
|
|
543
|
+
},
|
|
544
|
+
"description": "`{ sheet, axis, indexes, px, via }` when a column width or row height is set by a drag, a fit, the header menu or a reset — on release, never during a drag (W-47)."
|
|
545
|
+
},
|
|
546
|
+
{
|
|
547
|
+
"name": "sheetpane-sheet",
|
|
548
|
+
"type": {
|
|
549
|
+
"text": "CustomEvent<{ sheet: string }>"
|
|
550
|
+
},
|
|
551
|
+
"description": "`{ sheet }` when the selection moves to another sheet."
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
"name": "sheetpane-mode",
|
|
555
|
+
"type": {
|
|
556
|
+
"text": "CustomEvent<{ mode: Mode }>"
|
|
557
|
+
},
|
|
558
|
+
"description": "`{ mode }` when the pane switches between View and Edit."
|
|
559
|
+
},
|
|
560
|
+
{
|
|
561
|
+
"name": "sheetpane-history",
|
|
562
|
+
"type": {
|
|
563
|
+
"text": "CustomEvent<{ reason: 'undo' | 'redo' | 'cleared'; canUndo: boolean; canRedo: boolean }>"
|
|
564
|
+
},
|
|
565
|
+
"description": "`{ reason, canUndo, canRedo }` on undo, redo, or the stack cleared by `setErrors()`."
|
|
566
|
+
},
|
|
567
|
+
{
|
|
568
|
+
"name": "sheetpane-editstart",
|
|
569
|
+
"type": {
|
|
570
|
+
"text": "CustomEvent<{ sheet: string; ref: string; column: { index: number; letter: string; header: string }; value: unknown }>"
|
|
571
|
+
},
|
|
572
|
+
"description": "`{ sheet, ref, column, value }` before a cell edit starts; cancellable — the cell stays read-only."
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
"name": "sheetpane-input",
|
|
576
|
+
"type": {
|
|
577
|
+
"text": "CustomEvent<{ sheet: string; ref: string; column: { index: number; letter: string; header: string }; draft: string; was: unknown }>"
|
|
578
|
+
},
|
|
579
|
+
"description": "`{ sheet, ref, column, draft, was }` as the cell-bar draft is typed."
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
"name": "sheetpane-beforechange",
|
|
583
|
+
"type": {
|
|
584
|
+
"text": "CustomEvent<{ sheet: string; ref: string; column: { index: number; letter: string; header: string }; was: unknown; now: unknown }>"
|
|
585
|
+
},
|
|
586
|
+
"description": "`{ sheet, ref, column, was, now }` before a value is stored; cancellable — the value is refused."
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
"name": "sheetpane-editcancel",
|
|
590
|
+
"type": {
|
|
591
|
+
"text": "CustomEvent<{ sheet: string; ref: string } | { sheet: string; ref: string; reason: 'blocked'; code: 'SP-6003'; message: string }>"
|
|
592
|
+
},
|
|
593
|
+
"description": "`{ sheet, ref }` when Esc restores a draft, or `{ sheet, ref, reason: 'blocked', code: 'SP-6003', message }` when a `block` rule refuses it."
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
"name": "sheetpane-export",
|
|
597
|
+
"type": {
|
|
598
|
+
"text": "CustomEvent<{ blob: Blob; kind: 'xlsx' | 'csv'; name: string; guarded: string[] | false; format: 'xlsx' | 'csv'; converted: boolean; original?: boolean }>"
|
|
599
|
+
},
|
|
600
|
+
"description": "`{ blob, kind, name, guarded, format, converted, original? }` on `export()` and Download; cancellable — the Download control then saves nothing."
|
|
601
|
+
},
|
|
602
|
+
{
|
|
603
|
+
"name": "sheetpane-close",
|
|
604
|
+
"type": {
|
|
605
|
+
"text": "CustomEvent<Record<string, never>>"
|
|
606
|
+
},
|
|
607
|
+
"description": "`{}` when the pop-up closes."
|
|
608
|
+
}
|
|
609
|
+
],
|
|
610
|
+
"slots": [
|
|
611
|
+
{
|
|
612
|
+
"name": "format-row",
|
|
613
|
+
"description": "Host controls for the format row (Edit only); the row shows when a plugin or this slot puts something in it."
|
|
614
|
+
}
|
|
615
|
+
],
|
|
616
|
+
"cssParts": [
|
|
617
|
+
{
|
|
618
|
+
"name": "root",
|
|
619
|
+
"description": "The sheet's frame: toolbar, cell bar, format row, grid, sheet tabs and status line."
|
|
620
|
+
},
|
|
621
|
+
{
|
|
622
|
+
"name": "toolbar",
|
|
623
|
+
"description": "The top bar: file, View/Edit, counts, find, zoom, undo, redo, freeze, Download."
|
|
624
|
+
},
|
|
625
|
+
{
|
|
626
|
+
"name": "cellbar",
|
|
627
|
+
"description": "The cell bar: the reference, the value being edited and the docked selection actions."
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
"name": "format-row",
|
|
631
|
+
"description": "The format row (Edit): plugin controls and the `format-row` slot."
|
|
632
|
+
},
|
|
633
|
+
{
|
|
634
|
+
"name": "status",
|
|
635
|
+
"description": "The status line under the sheet tabs."
|
|
636
|
+
},
|
|
637
|
+
{
|
|
638
|
+
"name": "dialog",
|
|
639
|
+
"description": "The modal `<dialog>` the root moves into when `display=\"popup\"`."
|
|
640
|
+
}
|
|
641
|
+
],
|
|
642
|
+
"cssProperties": [
|
|
643
|
+
{
|
|
644
|
+
"name": "--sp-ground",
|
|
645
|
+
"description": "The ground behind panels: toolbar, cell bar, status line. Dark theme: `#16171A`.",
|
|
646
|
+
"default": "#F6F6F4"
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
"name": "--sp-surface",
|
|
650
|
+
"description": "Panels, buttons and inputs. Dark theme: `#262729`.",
|
|
651
|
+
"default": "#FFFFFF"
|
|
652
|
+
},
|
|
653
|
+
{
|
|
654
|
+
"name": "--sp-sunken",
|
|
655
|
+
"description": "Sunken fills: segmented controls, chips, tracks. Dark theme: `#3A3B3D`.",
|
|
656
|
+
"default": "#EFEFEB"
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
"name": "--sp-line",
|
|
660
|
+
"description": "Hairline borders. Dark theme: `#47484A`.",
|
|
661
|
+
"default": "#E2E2DD"
|
|
662
|
+
},
|
|
663
|
+
{
|
|
664
|
+
"name": "--sp-line-strong",
|
|
665
|
+
"description": "Borders of controls. Dark theme: `#6B6C6D`.",
|
|
666
|
+
"default": "#CBCBC5"
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"name": "--sp-cell",
|
|
670
|
+
"description": "The cell background. Dark theme: `#262729`.",
|
|
671
|
+
"default": "#FFFFFF"
|
|
672
|
+
},
|
|
673
|
+
{
|
|
674
|
+
"name": "--sp-head",
|
|
675
|
+
"description": "Row and column headers. Dark theme: `#313234`.",
|
|
676
|
+
"default": "#F3F3F0"
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
"name": "--sp-grid",
|
|
680
|
+
"description": "Cell gridlines. Dark theme: `#3E3F41`.",
|
|
681
|
+
"default": "#E6E6E1"
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
"name": "--sp-ink",
|
|
685
|
+
"description": "Body text. Dark theme: `#F6F6F4`.",
|
|
686
|
+
"default": "#16171A"
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
"name": "--sp-ink-2",
|
|
690
|
+
"description": "Secondary text. Dark theme: `#C9C9C8`.",
|
|
691
|
+
"default": "#45484F"
|
|
692
|
+
},
|
|
693
|
+
{
|
|
694
|
+
"name": "--sp-ink-3",
|
|
695
|
+
"description": "Muted text and icons. Dark theme: `#A1A1A1`.",
|
|
696
|
+
"default": "#63666E"
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
"name": "--sp-accent",
|
|
700
|
+
"description": "Selection, focus ring and primary buttons. Dark theme: `#8C9EDE`.",
|
|
701
|
+
"default": "#2346C8"
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
"name": "--sp-accent-ink",
|
|
705
|
+
"description": "Accent text and pressed primary buttons. Dark theme: `#B7C1E7`.",
|
|
706
|
+
"default": "#1A36A0"
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
"name": "--sp-accent-soft",
|
|
710
|
+
"description": "The selected range and active rows. Dark theme: `#1A254E`.",
|
|
711
|
+
"default": "#EBEEFB"
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
"name": "--sp-pass",
|
|
715
|
+
"description": "Resolved, passing. Dark theme: `#86B399`.",
|
|
716
|
+
"default": "#16703E"
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
"name": "--sp-pass-soft",
|
|
720
|
+
"description": "Resolved, passing — the tint. Dark theme: `#163225`.",
|
|
721
|
+
"default": "#E6F2EA"
|
|
722
|
+
},
|
|
723
|
+
{
|
|
724
|
+
"name": "--sp-fail",
|
|
725
|
+
"description": "Errors. Dark theme: `#D2827B`.",
|
|
726
|
+
"default": "#B42318"
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
"name": "--sp-fail-soft",
|
|
730
|
+
"description": "Errors — the tint. Dark theme: `#451B19`.",
|
|
731
|
+
"default": "#FBE9E7"
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
"name": "--sp-warn",
|
|
735
|
+
"description": "Warnings. Dark theme: `#CAB692`.",
|
|
736
|
+
"default": "#875600"
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
"name": "--sp-warn-soft",
|
|
740
|
+
"description": "Warnings — the tint. Dark theme: `#412F10`.",
|
|
741
|
+
"default": "#FBF0D9"
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
"name": "--sp-changed",
|
|
745
|
+
"description": "The changed-cell mark. Dark theme: `#D39449`.",
|
|
746
|
+
"default": "#C46A00"
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
"name": "--sp-changed-soft",
|
|
750
|
+
"description": "The changed-cell mark — the tint. Dark theme: `#4A3012`.",
|
|
751
|
+
"default": "#FDF1E3"
|
|
752
|
+
},
|
|
753
|
+
{
|
|
754
|
+
"name": "--sp-note",
|
|
755
|
+
"description": "Notes. Dark theme: `#AA9DDE`.",
|
|
756
|
+
"default": "#6B55CC"
|
|
757
|
+
},
|
|
758
|
+
{
|
|
759
|
+
"name": "--sp-ref-1",
|
|
760
|
+
"description": "The first reference colour (formula ranges, plugins). Dark theme: `#8C9EDE`.",
|
|
761
|
+
"default": "#2346C8"
|
|
762
|
+
},
|
|
763
|
+
{
|
|
764
|
+
"name": "--sp-ref-2",
|
|
765
|
+
"description": "The second reference colour. Dark theme: `#AA9DDE`.",
|
|
766
|
+
"default": "#6B55CC"
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
"name": "--sp-ref-3",
|
|
770
|
+
"description": "The third reference colour. Dark theme: `#D8A262`.",
|
|
771
|
+
"default": "#C46A00"
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"name": "--sp-on-solid",
|
|
775
|
+
"description": "Text on solid fills: pins, badges, primary buttons. Dark theme: `#16171A`.",
|
|
776
|
+
"default": "#FFFFFF"
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"name": "--sp-hit",
|
|
780
|
+
"description": "Find hits. Dark theme: `#4A3D12`.",
|
|
781
|
+
"default": "#FFF4C2"
|
|
782
|
+
},
|
|
783
|
+
{
|
|
784
|
+
"name": "--sp-hit-current",
|
|
785
|
+
"description": "The current find hit. Dark theme: `#7A5F12`.",
|
|
786
|
+
"default": "#FFE07A"
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"name": "--sp-r-sm",
|
|
790
|
+
"description": "Small radius.",
|
|
791
|
+
"default": "4px"
|
|
792
|
+
},
|
|
793
|
+
{
|
|
794
|
+
"name": "--sp-r",
|
|
795
|
+
"description": "Radius.",
|
|
796
|
+
"default": "6px"
|
|
797
|
+
},
|
|
798
|
+
{
|
|
799
|
+
"name": "--sp-r-lg",
|
|
800
|
+
"description": "Large radius (panels).",
|
|
801
|
+
"default": "10px"
|
|
802
|
+
},
|
|
803
|
+
{
|
|
804
|
+
"name": "--sp-r-xl",
|
|
805
|
+
"description": "Extra-large radius (the pop-up).",
|
|
806
|
+
"default": "14px"
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"name": "--sp-shadow",
|
|
810
|
+
"description": "Menus, callouts and pop-overs. Dark theme: `0 1px 2px rgba(0,0,0,.4),0 6px 20px rgba(0,0,0,.45)`.",
|
|
811
|
+
"default": "0 1px 2px rgba(22,23,26,.06),0 6px 20px rgba(22,23,26,.08)"
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
"name": "--sp-shadow-lg",
|
|
815
|
+
"description": "The pop-up dialog. Dark theme: `0 24px 64px rgba(0,0,0,.6)`.",
|
|
816
|
+
"default": "0 24px 64px rgba(22,23,26,.22)"
|
|
817
|
+
},
|
|
818
|
+
{
|
|
819
|
+
"name": "--sp-cell-font-size",
|
|
820
|
+
"description": "The cell text size (SR-GRID decision 15).",
|
|
821
|
+
"default": ".93em"
|
|
822
|
+
}
|
|
823
|
+
]
|
|
824
|
+
}
|
|
825
|
+
],
|
|
826
|
+
"exports": [
|
|
827
|
+
{
|
|
828
|
+
"kind": "js",
|
|
829
|
+
"name": "SheetpaneExcel",
|
|
830
|
+
"declaration": {
|
|
831
|
+
"name": "SheetpaneExcel",
|
|
832
|
+
"module": "dist/excel/element.js"
|
|
833
|
+
}
|
|
834
|
+
},
|
|
835
|
+
{
|
|
836
|
+
"kind": "custom-element-definition",
|
|
837
|
+
"name": "sheetpane-excel",
|
|
838
|
+
"declaration": {
|
|
839
|
+
"name": "SheetpaneExcel",
|
|
840
|
+
"module": "dist/excel/element.js"
|
|
841
|
+
}
|
|
842
|
+
}
|
|
843
|
+
]
|
|
844
|
+
},
|
|
845
|
+
{
|
|
846
|
+
"kind": "javascript-module",
|
|
847
|
+
"path": "dist/errors/element.js",
|
|
848
|
+
"declarations": [
|
|
849
|
+
{
|
|
850
|
+
"kind": "class",
|
|
851
|
+
"name": "SheetpaneErrors",
|
|
852
|
+
"customElement": true,
|
|
853
|
+
"tagName": "sheetpane-errors",
|
|
854
|
+
"summary": "`<sheetpane-errors>` — the error list and the Flag issue form, on the same in-memory workbook as `<sheetpane-excel>` (SR-ERRORS).",
|
|
855
|
+
"description": "`<sheetpane-errors>` — the error list and the Flag issue form, on the same in-memory workbook as `<sheetpane-excel>` (SR-ERRORS). It keeps no private copy: every render reads the pane's store, so the two are always in step (SR-LAW-7). It registers on import.\n\nSee SR-ERRORS: https://github.com/arpitarya/sheetpane/blob/main/records/0106_ERRORS.md",
|
|
856
|
+
"superclass": {
|
|
857
|
+
"name": "HTMLElement"
|
|
858
|
+
},
|
|
859
|
+
"attributes": [
|
|
860
|
+
{
|
|
861
|
+
"name": "pane",
|
|
862
|
+
"description": "The pane id shared with the sheet; none gives the element its own store.",
|
|
863
|
+
"type": {
|
|
864
|
+
"text": "string"
|
|
865
|
+
}
|
|
866
|
+
},
|
|
867
|
+
{
|
|
868
|
+
"name": "readonly",
|
|
869
|
+
"description": "Hides the form, Resolve, Delete, Undo and Redo (a sign-off screen).",
|
|
870
|
+
"type": {
|
|
871
|
+
"text": "boolean"
|
|
872
|
+
},
|
|
873
|
+
"fieldName": "readOnly"
|
|
874
|
+
},
|
|
875
|
+
{
|
|
876
|
+
"name": "author",
|
|
877
|
+
"description": "Written into the errors this element's user adds.",
|
|
878
|
+
"type": {
|
|
879
|
+
"text": "string"
|
|
880
|
+
}
|
|
881
|
+
},
|
|
882
|
+
{
|
|
883
|
+
"name": "plugins",
|
|
884
|
+
"description": "Space-separated registered plugin ids; fixed per pane.",
|
|
885
|
+
"type": {
|
|
886
|
+
"text": "string"
|
|
887
|
+
}
|
|
888
|
+
},
|
|
889
|
+
{
|
|
890
|
+
"name": "theme",
|
|
891
|
+
"description": "`light` (the default), `dark` or `auto`.",
|
|
892
|
+
"type": {
|
|
893
|
+
"text": "'light' | 'dark' | 'auto'"
|
|
894
|
+
},
|
|
895
|
+
"default": "'light'",
|
|
896
|
+
"fieldName": "theme"
|
|
897
|
+
}
|
|
898
|
+
],
|
|
899
|
+
"members": [
|
|
900
|
+
{
|
|
901
|
+
"kind": "field",
|
|
902
|
+
"name": "workbook",
|
|
903
|
+
"privacy": "public",
|
|
904
|
+
"type": {
|
|
905
|
+
"text": "WorkbookStore | undefined"
|
|
906
|
+
},
|
|
907
|
+
"description": "The pane's store; assigning one replaces the `pane` lookup."
|
|
908
|
+
},
|
|
909
|
+
{
|
|
910
|
+
"kind": "field",
|
|
911
|
+
"name": "errors",
|
|
912
|
+
"privacy": "public",
|
|
913
|
+
"type": {
|
|
914
|
+
"text": "SheetpaneError[]"
|
|
915
|
+
},
|
|
916
|
+
"description": "A copy of the pane's errors; assigning restores a saved review, like `setErrors()`."
|
|
917
|
+
},
|
|
918
|
+
{
|
|
919
|
+
"kind": "field",
|
|
920
|
+
"name": "errorTypes",
|
|
921
|
+
"privacy": "public",
|
|
922
|
+
"type": {
|
|
923
|
+
"text": "readonly ErrorType[]"
|
|
924
|
+
},
|
|
925
|
+
"description": "The types offered in the form; an empty list falls back to `DEFAULT_ERROR_TYPES`."
|
|
926
|
+
},
|
|
927
|
+
{
|
|
928
|
+
"kind": "field",
|
|
929
|
+
"name": "readOnly",
|
|
930
|
+
"privacy": "public",
|
|
931
|
+
"type": {
|
|
932
|
+
"text": "boolean"
|
|
933
|
+
},
|
|
934
|
+
"description": "Whether the list is read-only (the `readonly` attribute).",
|
|
935
|
+
"attribute": "readonly",
|
|
936
|
+
"reflects": true
|
|
937
|
+
},
|
|
938
|
+
{
|
|
939
|
+
"kind": "field",
|
|
940
|
+
"name": "theme",
|
|
941
|
+
"privacy": "public",
|
|
942
|
+
"type": {
|
|
943
|
+
"text": "Theme"
|
|
944
|
+
},
|
|
945
|
+
"description": "`light` (the default), `dark` or `auto` — the same tokens as the sheet (W-29).",
|
|
946
|
+
"attribute": "theme",
|
|
947
|
+
"reflects": true
|
|
948
|
+
},
|
|
949
|
+
{
|
|
950
|
+
"kind": "method",
|
|
951
|
+
"name": "getErrors",
|
|
952
|
+
"privacy": "public",
|
|
953
|
+
"description": "A copy of the pane's errors, to save a review.",
|
|
954
|
+
"return": {
|
|
955
|
+
"type": {
|
|
956
|
+
"text": "SheetpaneError[]"
|
|
957
|
+
}
|
|
958
|
+
}
|
|
959
|
+
},
|
|
960
|
+
{
|
|
961
|
+
"kind": "method",
|
|
962
|
+
"name": "setErrors",
|
|
963
|
+
"privacy": "public",
|
|
964
|
+
"description": "Restores a saved review. `plugins` (from the saved `sheetpane-errors` envelope) shows a notice when it differs from this pane's set.",
|
|
965
|
+
"parameters": [
|
|
966
|
+
{
|
|
967
|
+
"name": "list",
|
|
968
|
+
"type": {
|
|
969
|
+
"text": "SheetpaneError[]"
|
|
970
|
+
}
|
|
971
|
+
},
|
|
972
|
+
{
|
|
973
|
+
"name": "o",
|
|
974
|
+
"optional": true,
|
|
975
|
+
"type": {
|
|
976
|
+
"text": "{ plugins?: string[] }"
|
|
977
|
+
}
|
|
978
|
+
}
|
|
979
|
+
],
|
|
980
|
+
"return": {
|
|
981
|
+
"type": {
|
|
982
|
+
"text": "void"
|
|
983
|
+
}
|
|
984
|
+
}
|
|
985
|
+
},
|
|
986
|
+
{
|
|
987
|
+
"kind": "method",
|
|
988
|
+
"name": "renderNow",
|
|
989
|
+
"privacy": "public",
|
|
990
|
+
"description": "Renders now (tests and the first frame).",
|
|
991
|
+
"return": {
|
|
992
|
+
"type": {
|
|
993
|
+
"text": "void"
|
|
994
|
+
}
|
|
995
|
+
}
|
|
996
|
+
}
|
|
997
|
+
],
|
|
998
|
+
"events": [
|
|
999
|
+
{
|
|
1000
|
+
"name": "sheetpane-errors",
|
|
1001
|
+
"type": {
|
|
1002
|
+
"text": "CustomEvent<{ errors: SheetpaneError[]; plugins: string[] }>"
|
|
1003
|
+
},
|
|
1004
|
+
"description": "`{ errors, plugins }` when the pane's errors change — the envelope to save a review."
|
|
1005
|
+
},
|
|
1006
|
+
{
|
|
1007
|
+
"name": "sheetpane-change",
|
|
1008
|
+
"type": {
|
|
1009
|
+
"text": "CustomEvent<{ sheet: string; ref: string; kind: ChangeKind; was: unknown; now: unknown }>"
|
|
1010
|
+
},
|
|
1011
|
+
"description": "`{ sheet, ref, kind, was, now }` when a cell changes from here (\"Also change the cell\", undo, redo)."
|
|
1012
|
+
},
|
|
1013
|
+
{
|
|
1014
|
+
"name": "sheetpane-select",
|
|
1015
|
+
"type": {
|
|
1016
|
+
"text": "CustomEvent<{ sheet: string; ref: string }>"
|
|
1017
|
+
},
|
|
1018
|
+
"description": "`{ sheet, ref }` when picking a row selects its cell."
|
|
1019
|
+
},
|
|
1020
|
+
{
|
|
1021
|
+
"name": "sheetpane-history",
|
|
1022
|
+
"type": {
|
|
1023
|
+
"text": "CustomEvent<{ reason: 'undo' | 'redo' | 'cleared'; canUndo: boolean; canRedo: boolean }>"
|
|
1024
|
+
},
|
|
1025
|
+
"description": "`{ reason, canUndo, canRedo }` on undo, redo, or the stack cleared by `setErrors()`."
|
|
1026
|
+
},
|
|
1027
|
+
{
|
|
1028
|
+
"name": "sheetpane-reveal",
|
|
1029
|
+
"type": {
|
|
1030
|
+
"text": "CustomEvent<{ error: SheetpaneError }>"
|
|
1031
|
+
},
|
|
1032
|
+
"description": "`{ error }` on Show in sheet, so the host can switch tab or open the pop-up."
|
|
1033
|
+
}
|
|
1034
|
+
],
|
|
1035
|
+
"slots": [],
|
|
1036
|
+
"cssParts": [
|
|
1037
|
+
{
|
|
1038
|
+
"name": "root",
|
|
1039
|
+
"description": "The panel's frame: the header, the form, the filters and the list."
|
|
1040
|
+
}
|
|
1041
|
+
],
|
|
1042
|
+
"cssProperties": [
|
|
1043
|
+
{
|
|
1044
|
+
"name": "--sp-ground",
|
|
1045
|
+
"description": "The ground behind panels: toolbar, cell bar, status line. Dark theme: `#16171A`.",
|
|
1046
|
+
"default": "#F6F6F4"
|
|
1047
|
+
},
|
|
1048
|
+
{
|
|
1049
|
+
"name": "--sp-surface",
|
|
1050
|
+
"description": "Panels, buttons and inputs. Dark theme: `#262729`.",
|
|
1051
|
+
"default": "#FFFFFF"
|
|
1052
|
+
},
|
|
1053
|
+
{
|
|
1054
|
+
"name": "--sp-sunken",
|
|
1055
|
+
"description": "Sunken fills: segmented controls, chips, tracks. Dark theme: `#3A3B3D`.",
|
|
1056
|
+
"default": "#EFEFEB"
|
|
1057
|
+
},
|
|
1058
|
+
{
|
|
1059
|
+
"name": "--sp-line",
|
|
1060
|
+
"description": "Hairline borders. Dark theme: `#47484A`.",
|
|
1061
|
+
"default": "#E2E2DD"
|
|
1062
|
+
},
|
|
1063
|
+
{
|
|
1064
|
+
"name": "--sp-line-strong",
|
|
1065
|
+
"description": "Borders of controls. Dark theme: `#6B6C6D`.",
|
|
1066
|
+
"default": "#CBCBC5"
|
|
1067
|
+
},
|
|
1068
|
+
{
|
|
1069
|
+
"name": "--sp-cell",
|
|
1070
|
+
"description": "The cell background. Dark theme: `#262729`.",
|
|
1071
|
+
"default": "#FFFFFF"
|
|
1072
|
+
},
|
|
1073
|
+
{
|
|
1074
|
+
"name": "--sp-head",
|
|
1075
|
+
"description": "Row and column headers. Dark theme: `#313234`.",
|
|
1076
|
+
"default": "#F3F3F0"
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
"name": "--sp-grid",
|
|
1080
|
+
"description": "Cell gridlines. Dark theme: `#3E3F41`.",
|
|
1081
|
+
"default": "#E6E6E1"
|
|
1082
|
+
},
|
|
1083
|
+
{
|
|
1084
|
+
"name": "--sp-ink",
|
|
1085
|
+
"description": "Body text. Dark theme: `#F6F6F4`.",
|
|
1086
|
+
"default": "#16171A"
|
|
1087
|
+
},
|
|
1088
|
+
{
|
|
1089
|
+
"name": "--sp-ink-2",
|
|
1090
|
+
"description": "Secondary text. Dark theme: `#C9C9C8`.",
|
|
1091
|
+
"default": "#45484F"
|
|
1092
|
+
},
|
|
1093
|
+
{
|
|
1094
|
+
"name": "--sp-ink-3",
|
|
1095
|
+
"description": "Muted text and icons. Dark theme: `#A1A1A1`.",
|
|
1096
|
+
"default": "#63666E"
|
|
1097
|
+
},
|
|
1098
|
+
{
|
|
1099
|
+
"name": "--sp-accent",
|
|
1100
|
+
"description": "Selection, focus ring and primary buttons. Dark theme: `#8C9EDE`.",
|
|
1101
|
+
"default": "#2346C8"
|
|
1102
|
+
},
|
|
1103
|
+
{
|
|
1104
|
+
"name": "--sp-accent-ink",
|
|
1105
|
+
"description": "Accent text and pressed primary buttons. Dark theme: `#B7C1E7`.",
|
|
1106
|
+
"default": "#1A36A0"
|
|
1107
|
+
},
|
|
1108
|
+
{
|
|
1109
|
+
"name": "--sp-accent-soft",
|
|
1110
|
+
"description": "The selected range and active rows. Dark theme: `#1A254E`.",
|
|
1111
|
+
"default": "#EBEEFB"
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"name": "--sp-pass",
|
|
1115
|
+
"description": "Resolved, passing. Dark theme: `#86B399`.",
|
|
1116
|
+
"default": "#16703E"
|
|
1117
|
+
},
|
|
1118
|
+
{
|
|
1119
|
+
"name": "--sp-pass-soft",
|
|
1120
|
+
"description": "Resolved, passing — the tint. Dark theme: `#163225`.",
|
|
1121
|
+
"default": "#E6F2EA"
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
"name": "--sp-fail",
|
|
1125
|
+
"description": "Errors. Dark theme: `#D2827B`.",
|
|
1126
|
+
"default": "#B42318"
|
|
1127
|
+
},
|
|
1128
|
+
{
|
|
1129
|
+
"name": "--sp-fail-soft",
|
|
1130
|
+
"description": "Errors — the tint. Dark theme: `#451B19`.",
|
|
1131
|
+
"default": "#FBE9E7"
|
|
1132
|
+
},
|
|
1133
|
+
{
|
|
1134
|
+
"name": "--sp-warn",
|
|
1135
|
+
"description": "Warnings. Dark theme: `#CAB692`.",
|
|
1136
|
+
"default": "#875600"
|
|
1137
|
+
},
|
|
1138
|
+
{
|
|
1139
|
+
"name": "--sp-warn-soft",
|
|
1140
|
+
"description": "Warnings — the tint. Dark theme: `#412F10`.",
|
|
1141
|
+
"default": "#FBF0D9"
|
|
1142
|
+
},
|
|
1143
|
+
{
|
|
1144
|
+
"name": "--sp-changed",
|
|
1145
|
+
"description": "The changed-cell mark. Dark theme: `#D39449`.",
|
|
1146
|
+
"default": "#C46A00"
|
|
1147
|
+
},
|
|
1148
|
+
{
|
|
1149
|
+
"name": "--sp-changed-soft",
|
|
1150
|
+
"description": "The changed-cell mark — the tint. Dark theme: `#4A3012`.",
|
|
1151
|
+
"default": "#FDF1E3"
|
|
1152
|
+
},
|
|
1153
|
+
{
|
|
1154
|
+
"name": "--sp-note",
|
|
1155
|
+
"description": "Notes. Dark theme: `#AA9DDE`.",
|
|
1156
|
+
"default": "#6B55CC"
|
|
1157
|
+
},
|
|
1158
|
+
{
|
|
1159
|
+
"name": "--sp-ref-1",
|
|
1160
|
+
"description": "The first reference colour (formula ranges, plugins). Dark theme: `#8C9EDE`.",
|
|
1161
|
+
"default": "#2346C8"
|
|
1162
|
+
},
|
|
1163
|
+
{
|
|
1164
|
+
"name": "--sp-ref-2",
|
|
1165
|
+
"description": "The second reference colour. Dark theme: `#AA9DDE`.",
|
|
1166
|
+
"default": "#6B55CC"
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
"name": "--sp-ref-3",
|
|
1170
|
+
"description": "The third reference colour. Dark theme: `#D8A262`.",
|
|
1171
|
+
"default": "#C46A00"
|
|
1172
|
+
},
|
|
1173
|
+
{
|
|
1174
|
+
"name": "--sp-on-solid",
|
|
1175
|
+
"description": "Text on solid fills: pins, badges, primary buttons. Dark theme: `#16171A`.",
|
|
1176
|
+
"default": "#FFFFFF"
|
|
1177
|
+
},
|
|
1178
|
+
{
|
|
1179
|
+
"name": "--sp-hit",
|
|
1180
|
+
"description": "Find hits. Dark theme: `#4A3D12`.",
|
|
1181
|
+
"default": "#FFF4C2"
|
|
1182
|
+
},
|
|
1183
|
+
{
|
|
1184
|
+
"name": "--sp-hit-current",
|
|
1185
|
+
"description": "The current find hit. Dark theme: `#7A5F12`.",
|
|
1186
|
+
"default": "#FFE07A"
|
|
1187
|
+
},
|
|
1188
|
+
{
|
|
1189
|
+
"name": "--sp-r-sm",
|
|
1190
|
+
"description": "Small radius.",
|
|
1191
|
+
"default": "4px"
|
|
1192
|
+
},
|
|
1193
|
+
{
|
|
1194
|
+
"name": "--sp-r",
|
|
1195
|
+
"description": "Radius.",
|
|
1196
|
+
"default": "6px"
|
|
1197
|
+
},
|
|
1198
|
+
{
|
|
1199
|
+
"name": "--sp-r-lg",
|
|
1200
|
+
"description": "Large radius (panels).",
|
|
1201
|
+
"default": "10px"
|
|
1202
|
+
},
|
|
1203
|
+
{
|
|
1204
|
+
"name": "--sp-r-xl",
|
|
1205
|
+
"description": "Extra-large radius (the pop-up).",
|
|
1206
|
+
"default": "14px"
|
|
1207
|
+
},
|
|
1208
|
+
{
|
|
1209
|
+
"name": "--sp-shadow",
|
|
1210
|
+
"description": "Menus, callouts and pop-overs. Dark theme: `0 1px 2px rgba(0,0,0,.4),0 6px 20px rgba(0,0,0,.45)`.",
|
|
1211
|
+
"default": "0 1px 2px rgba(22,23,26,.06),0 6px 20px rgba(22,23,26,.08)"
|
|
1212
|
+
},
|
|
1213
|
+
{
|
|
1214
|
+
"name": "--sp-shadow-lg",
|
|
1215
|
+
"description": "The pop-up dialog. Dark theme: `0 24px 64px rgba(0,0,0,.6)`.",
|
|
1216
|
+
"default": "0 24px 64px rgba(22,23,26,.22)"
|
|
1217
|
+
},
|
|
1218
|
+
{
|
|
1219
|
+
"name": "--sp-cell-font-size",
|
|
1220
|
+
"description": "The cell text size (SR-GRID decision 15).",
|
|
1221
|
+
"default": ".93em"
|
|
1222
|
+
}
|
|
1223
|
+
]
|
|
1224
|
+
}
|
|
1225
|
+
],
|
|
1226
|
+
"exports": [
|
|
1227
|
+
{
|
|
1228
|
+
"kind": "js",
|
|
1229
|
+
"name": "SheetpaneErrors",
|
|
1230
|
+
"declaration": {
|
|
1231
|
+
"name": "SheetpaneErrors",
|
|
1232
|
+
"module": "dist/errors/element.js"
|
|
1233
|
+
}
|
|
1234
|
+
},
|
|
1235
|
+
{
|
|
1236
|
+
"kind": "custom-element-definition",
|
|
1237
|
+
"name": "sheetpane-errors",
|
|
1238
|
+
"declaration": {
|
|
1239
|
+
"name": "SheetpaneErrors",
|
|
1240
|
+
"module": "dist/errors/element.js"
|
|
1241
|
+
}
|
|
1242
|
+
}
|
|
1243
|
+
]
|
|
1244
|
+
}
|
|
1245
|
+
]
|
|
1246
|
+
}
|