@svgrid/grid 2.2.27 → 2.2.29

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.
Files changed (248) hide show
  1. package/README.md +199 -199
  2. package/dist/FlexRender.svelte +96 -96
  3. package/dist/GridFooter.svelte +179 -179
  4. package/dist/GridMenus.svelte +782 -734
  5. package/dist/SvAutoComplete.svelte +165 -165
  6. package/dist/SvCalendar.svelte +503 -503
  7. package/dist/SvCarousel.svelte +141 -141
  8. package/dist/SvCheckBox.svelte +101 -101
  9. package/dist/SvColorInput.svelte +181 -181
  10. package/dist/SvComboBox.svelte +275 -275
  11. package/dist/SvContextMenu.svelte +116 -116
  12. package/dist/SvCountryInput.svelte +160 -160
  13. package/dist/SvDrawer.svelte +254 -250
  14. package/dist/SvDropDownList.svelte +374 -374
  15. package/dist/SvDurationInput.svelte +126 -126
  16. package/dist/SvField.svelte +293 -293
  17. package/dist/SvForm.svelte +437 -437
  18. package/dist/SvGrid.controller.svelte.d.ts +14 -1
  19. package/dist/SvGrid.controller.svelte.js +112 -28
  20. package/dist/SvGrid.css +2704 -2723
  21. package/dist/SvGrid.svelte +3361 -3333
  22. package/dist/SvGrid.types.d.ts +20 -5
  23. package/dist/SvGridChart.svelte +1724 -1724
  24. package/dist/SvGridChartPanel.svelte +485 -485
  25. package/dist/SvGridChartView.svelte +70 -70
  26. package/dist/SvGridDropdown.svelte +696 -696
  27. package/dist/SvGridSelect.svelte +259 -259
  28. package/dist/SvGroupCell.svelte +109 -109
  29. package/dist/SvListBox.svelte +326 -287
  30. package/dist/SvListBox.svelte.d.ts +10 -1
  31. package/dist/SvMaskedInput.svelte +122 -122
  32. package/dist/SvMenu.svelte +124 -124
  33. package/dist/SvMenuList.svelte +146 -146
  34. package/dist/SvMultiSelect.svelte +281 -281
  35. package/dist/SvNumberInput.svelte +168 -168
  36. package/dist/SvOtpInput.svelte +158 -158
  37. package/dist/SvPasswordInput.svelte +151 -151
  38. package/dist/SvPhoneInput.svelte +133 -131
  39. package/dist/SvPopover.svelte +197 -197
  40. package/dist/SvRadioGroup.svelte +107 -107
  41. package/dist/SvRowGroupPanel.svelte +170 -170
  42. package/dist/SvScrollArea.svelte +61 -61
  43. package/dist/SvSlider.svelte +200 -200
  44. package/dist/SvSwitchButton.svelte +107 -107
  45. package/dist/SvTagsInput.svelte +112 -112
  46. package/dist/SvTextInput.svelte +147 -147
  47. package/dist/SvTimePicker.svelte +245 -245
  48. package/dist/SvToaster.svelte +159 -159
  49. package/dist/SvToggleButton.svelte +85 -85
  50. package/dist/SvTooltip.svelte +161 -161
  51. package/dist/SvTour.svelte +204 -204
  52. package/dist/SvTree.svelte +437 -437
  53. package/dist/SvTreeSelect.svelte +233 -233
  54. package/dist/cdn/GridMenus-Da_p7SKS.js +486 -0
  55. package/dist/cdn/GridMenus-Ds3OpzZT.js +490 -0
  56. package/dist/cdn/{SvDateTimePicker-B1sDc9Pz.js → SvDateTimePicker-B8GopjhC.js} +2 -2
  57. package/dist/cdn/{SvDateTimePicker-Bh0FTs1E.js → SvDateTimePicker-DB0aIEk8.js} +2 -2
  58. package/dist/cdn/{SvGridChart-Bgk4hDs8.js → SvGridChart-BcLCYvw9.js} +1 -1
  59. package/dist/cdn/{SvGridChart-BKQsO5fZ.js → SvGridChart-BhnFdLd0.js} +1 -1
  60. package/dist/cdn/{SvGridChartPanel-DkCc2Z7b.js → SvGridChartPanel-Cmx9DHAS.js} +1 -1
  61. package/dist/cdn/{SvGridChartPanel-DSkHIQDd.js → SvGridChartPanel-DvjwxLvK.js} +1 -1
  62. package/dist/cdn/{SvGridChartView-BrbVaELm.js → SvGridChartView-B40DTJSX.js} +1 -1
  63. package/dist/cdn/{SvGridChartView-i9rWvSKg.js → SvGridChartView-PwqI4s02.js} +1 -1
  64. package/dist/cdn/{SvGridDropdown-D08sVmAy.js → SvGridDropdown-DjALc_4f.js} +1 -1
  65. package/dist/cdn/{SvGridDropdown-CGxxopQ4.js → SvGridDropdown-hpnHvOGt.js} +1 -1
  66. package/dist/cdn/{src-cgs1wcUS.js → src-BLJfdyL0.js} +4034 -3889
  67. package/dist/cdn/{src-Cw8d9U8j.js → src-DYDCiC0D.js} +7053 -6908
  68. package/dist/cdn/svgrid.js +9 -9
  69. package/dist/cdn/svgrid.svelte-external.js +9 -9
  70. package/dist/chart-export.js +8 -8
  71. package/dist/column-groups.js +8 -10
  72. package/dist/column-id.d.ts +9 -0
  73. package/dist/column-id.js +25 -0
  74. package/dist/core.js +2 -1
  75. package/dist/createListbox.svelte.d.ts +15 -2
  76. package/dist/createListbox.svelte.js +27 -6
  77. package/dist/editing.d.ts +1 -0
  78. package/dist/editing.js +45 -10
  79. package/dist/filtering/excel-filters.d.ts +30 -10
  80. package/dist/filtering/excel-filters.js +96 -15
  81. package/dist/index.d.ts +2 -2
  82. package/dist/index.js +2 -2
  83. package/dist/menus.d.ts +2 -0
  84. package/dist/menus.js +25 -0
  85. package/dist/row-resize.js +40 -0
  86. package/dist/selection.js +1 -1
  87. package/package.json +10 -10
  88. package/src/FlexRender.svelte +96 -96
  89. package/src/GridFooter.svelte +179 -179
  90. package/src/GridMenus.svelte +782 -734
  91. package/src/SvAutoComplete.svelte +165 -165
  92. package/src/SvCalendar.svelte +503 -503
  93. package/src/SvCalendar.test.ts +226 -226
  94. package/src/SvCarousel.svelte +141 -141
  95. package/src/SvCheckBox.svelte +101 -101
  96. package/src/SvColorInput.svelte +181 -181
  97. package/src/SvComboBox.svelte +275 -275
  98. package/src/SvContextMenu.svelte +116 -116
  99. package/src/SvCountryInput.svelte +160 -160
  100. package/src/SvDrawer.svelte +254 -250
  101. package/src/SvDrawer.test.ts +18 -1
  102. package/src/SvDropDownList.svelte +374 -374
  103. package/src/SvDurationInput.svelte +126 -126
  104. package/src/SvField.svelte +293 -293
  105. package/src/SvForm.svelte +437 -437
  106. package/src/SvForm.test.ts +411 -411
  107. package/src/SvGrid.controller.svelte.ts +3335 -3239
  108. package/src/SvGrid.css +2704 -2723
  109. package/src/SvGrid.svelte +3361 -3333
  110. package/src/SvGrid.types.ts +1628 -1613
  111. package/src/SvGridChart.svelte +1724 -1724
  112. package/src/SvGridChartPanel.svelte +485 -485
  113. package/src/SvGridChartView.svelte +70 -70
  114. package/src/SvGridDropdown.svelte +696 -696
  115. package/src/SvGridSelect.svelte +259 -259
  116. package/src/SvGroupCell.svelte +109 -109
  117. package/src/SvListBox.svelte +326 -287
  118. package/src/SvMaskedInput.svelte +122 -122
  119. package/src/SvMenu.svelte +124 -124
  120. package/src/SvMenu.test.ts +97 -97
  121. package/src/SvMenuList.svelte +146 -146
  122. package/src/SvMultiSelect.svelte +281 -281
  123. package/src/SvNavPane.test.ts +15 -4
  124. package/src/SvNumberInput.svelte +168 -168
  125. package/src/SvOtpInput.svelte +158 -158
  126. package/src/SvPasswordInput.svelte +151 -151
  127. package/src/SvPhoneInput.svelte +133 -131
  128. package/src/SvPopover.svelte +197 -197
  129. package/src/SvRadioGroup.svelte +107 -107
  130. package/src/SvRowGroupPanel.svelte +170 -170
  131. package/src/SvScrollArea.svelte +61 -61
  132. package/src/SvSlider.svelte +200 -200
  133. package/src/SvSwitchButton.svelte +107 -107
  134. package/src/SvTagsInput.svelte +112 -112
  135. package/src/SvTextInput.svelte +147 -147
  136. package/src/SvTimePicker.svelte +245 -245
  137. package/src/SvToaster.svelte +159 -159
  138. package/src/SvToaster.test.ts +95 -95
  139. package/src/SvToggleButton.svelte +85 -85
  140. package/src/SvTooltip.svelte +161 -161
  141. package/src/SvTour.svelte +204 -204
  142. package/src/SvTree.svelte +437 -437
  143. package/src/SvTreeSelect.svelte +233 -233
  144. package/src/a11y/dismissable.test.ts +119 -119
  145. package/src/a11y/dismissable.ts +114 -114
  146. package/src/a11y.contract.test.ts +49 -49
  147. package/src/a11y.test.ts +59 -59
  148. package/src/a11y.ts +61 -61
  149. package/src/ai.test.ts +502 -502
  150. package/src/ai.ts +1391 -1391
  151. package/src/build-api.coverage.test.ts +633 -633
  152. package/src/build-api.ts +895 -895
  153. package/src/builtin-editors.grid.test.ts +85 -85
  154. package/src/cell-formatting.ts +169 -169
  155. package/src/cell-render.ts +469 -469
  156. package/src/chart-export.ts +201 -201
  157. package/src/chart-view.svelte.ts +36 -36
  158. package/src/chart.ts +2296 -2296
  159. package/src/collaboration.test.ts +104 -104
  160. package/src/collaboration.ts +167 -167
  161. package/src/column-groups.test.ts +48 -0
  162. package/src/column-groups.ts +8 -10
  163. package/src/column-id.ts +30 -0
  164. package/src/core.performance.test.ts +30 -30
  165. package/src/core.ts +1112 -1111
  166. package/src/createAutocomplete.svelte.ts +132 -132
  167. package/src/createCombobox.svelte.ts +191 -191
  168. package/src/createCountryInput.svelte.ts +157 -157
  169. package/src/createDropdownList.svelte.ts +168 -168
  170. package/src/createForm.svelte.ts +386 -386
  171. package/src/createGrid.svelte.ts +42 -42
  172. package/src/createGrid.test.ts +10 -10
  173. package/src/createGridState.svelte.ts +17 -17
  174. package/src/createListbox.svelte.ts +39 -7
  175. package/src/createMenu.svelte.ts +225 -225
  176. package/src/createPopoverSelect.svelte.ts +213 -213
  177. package/src/createSlider.svelte.ts +191 -191
  178. package/src/createTooltip.svelte.ts +144 -144
  179. package/src/createTree.svelte.ts +319 -319
  180. package/src/editing.test.ts +949 -859
  181. package/src/editing.ts +709 -675
  182. package/src/editor-contract.ts +157 -157
  183. package/src/export-data-api.test.ts +126 -126
  184. package/src/export-format.test.ts +107 -107
  185. package/src/export-format.ts +598 -598
  186. package/src/filter-operators.ts +157 -157
  187. package/src/filtering/excel-filters.test.ts +44 -1
  188. package/src/filtering/excel-filters.ts +91 -14
  189. package/src/flex-render.ts +3 -3
  190. package/src/form-field.ts +127 -127
  191. package/src/index.ts +715 -713
  192. package/src/js-scroller.svelte.ts +173 -173
  193. package/src/keyboard.test.ts +59 -59
  194. package/src/keyboard.ts +97 -97
  195. package/src/list-nav.test.ts +49 -49
  196. package/src/list-nav.ts +29 -29
  197. package/src/list-option.test.ts +56 -56
  198. package/src/list-option.ts +172 -172
  199. package/src/menus.test.ts +736 -700
  200. package/src/menus.ts +679 -652
  201. package/src/merge-objects.ts +48 -48
  202. package/src/overlays.test.ts +90 -90
  203. package/src/render-component.ts +28 -28
  204. package/src/row-resize.test.ts +100 -0
  205. package/src/row-resize.ts +36 -0
  206. package/src/scheduler-model.test.ts +562 -562
  207. package/src/scheduler-model.ts +872 -872
  208. package/src/selection.test.ts +754 -754
  209. package/src/selection.ts +600 -600
  210. package/src/server-data-source.test.ts +289 -289
  211. package/src/server-data-source.ts +413 -413
  212. package/src/sparkline.test.ts +68 -68
  213. package/src/sparkline.ts +169 -169
  214. package/src/spreadsheet.test.ts +489 -489
  215. package/src/spreadsheet.ts +312 -312
  216. package/src/static-functions.ts +11 -11
  217. package/src/subscribe.ts +38 -38
  218. package/src/svgrid-wrapper.types.ts +524 -524
  219. package/src/svgrid.api-extensions.test.ts +8 -3
  220. package/src/svgrid.behavior.test.ts +706 -706
  221. package/src/svgrid.cell-dom-ids.test.ts +96 -0
  222. package/src/svgrid.charting.test.ts +534 -534
  223. package/src/svgrid.conditional-stat-scope.test.ts +111 -0
  224. package/src/svgrid.features.test.ts +157 -157
  225. package/src/svgrid.filter-menu-listbox.svelte.test.ts +308 -0
  226. package/src/svgrid.filter-menu-scroll.test.ts +3 -1
  227. package/src/svgrid.group-header-ids.test.ts +121 -0
  228. package/src/svgrid.new-features.wrapper.test.ts +251 -251
  229. package/src/svgrid.wrapper.test.ts +40 -40
  230. package/src/test-setup.ts +62 -62
  231. package/src/themes/index.ts +215 -215
  232. package/src/toast-store.svelte.ts +246 -246
  233. package/src/toast-store.test.ts +147 -147
  234. package/src/ui-buttons.test.ts +144 -144
  235. package/src/ui-inputs.test.ts +118 -118
  236. package/src/ui-range.test.ts +70 -70
  237. package/src/ui-selection.test.ts +155 -155
  238. package/src/ui-tier1.test.ts +142 -142
  239. package/src/virtual.test.ts +88 -88
  240. package/src/virtualization/column-virtualizer.test.ts +27 -27
  241. package/src/virtualization/column-virtualizer.ts +30 -30
  242. package/src/virtualization/svelte-virtualizer.svelte.ts +26 -26
  243. package/src/virtualization/types.ts +30 -30
  244. package/src/virtualization/virtualizer.test.ts +47 -47
  245. package/src/virtualization/virtualizer.ts +296 -296
  246. package/themes/ember.css +71 -71
  247. package/dist/cdn/GridMenus-BzxEYNtW.js +0 -421
  248. package/dist/cdn/GridMenus-Dr-nGEXn.js +0 -417
package/README.md CHANGED
@@ -1,199 +1,199 @@
1
- <p align="center">
2
- <img src="https://svgrid.com/brand/svgrid-logo-icon-1200.png" alt="SvGrid" width="100" height="100" />
3
- </p>
4
-
5
- <h1 align="center">@svgrid/grid</h1>
6
-
7
- <p align="center"><strong>The Svelte 5 native data grid. Headless-first. Render-ready.</strong></p>
8
-
9
- <p align="center">
10
- <a href="https://www.npmjs.com/package/@svgrid/grid"><img src="https://img.shields.io/npm/v/%40svgrid%2Fgrid.svg?label=%40svgrid%2Fgrid" alt="npm version" /></a>
11
- <a href="https://www.npmjs.com/package/@svgrid/grid"><img src="https://img.shields.io/npm/dm/%40svgrid%2Fgrid.svg" alt="npm downloads" /></a>
12
- <a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License" /></a>
13
- <a href="https://www.npmjs.com/package/@svgrid/grid"><img src="https://img.shields.io/badge/types-included-blue.svg" alt="TypeScript" /></a>
14
- <a href="https://svelte.dev"><img src="https://img.shields.io/badge/svelte-5-ff3e00.svg" alt="Svelte 5" /></a>
15
- </p>
16
-
17
- <p align="center">
18
- <a href="https://svgrid.com">Website</a> ·
19
- <a href="https://svgrid.com/docs/">Docs</a> ·
20
- <a href="https://svgrid.com/demos/">370+ Demos</a> ·
21
- <a href="https://svgrid.com/pricing/">Pricing</a> ·
22
- <a href="https://svgrid.com/roadmap/">Roadmap</a>
23
- </p>
24
-
25
- ---
26
-
27
- A production-grade **Svelte 5 data grid and data table** built from the first line for **runes**, not a
28
- React grid wrapped in a Svelte shim. Virtual scrolling over 100k+ rows, Excel-style filtering, inline
29
- editing, row grouping, tree data, and server-side data. Compose the headless engine yourself, or drop in
30
- the full `<SvGrid />` render component and ship. The MIT core has **zero feature gating**: no license key,
31
- no watermark, no row-count cap.
32
-
33
- <p align="center">
34
- <img src="https://svgrid.com/brand/svgrid-hero.png" alt="A SvGrid trading desk: KPI cards, sector filter chips, and a virtualized data table with sparkline trend columns, conditional colour, and pinned columns." width="100%" />
35
- </p>
36
-
37
- ## Install
38
-
39
- Scaffold a working Vite + Svelte 5 app with SvGrid wired up:
40
-
41
- ```bash
42
- npm create @svgrid@latest
43
- ```
44
-
45
- Or add it to an existing app:
46
-
47
- ```bash
48
- npm install @svgrid/grid
49
- ```
50
-
51
- ## Quick start
52
-
53
- ```svelte
54
- <script lang="ts">
55
- import { SvGrid, type ColumnDef } from '@svgrid/grid'
56
-
57
- const rows = [
58
- { firstName: 'Ada', age: 36, status: 'active' },
59
- { firstName: 'Linus', age: 54, status: 'active' },
60
- { firstName: 'Grace', age: 85, status: 'inactive' },
61
- ]
62
- const columns: ColumnDef<{}, (typeof rows)[number]>[] = [
63
- { field: 'firstName', header: 'First name' },
64
- { field: 'age', header: 'Age' },
65
- { field: 'status', header: 'Status' },
66
- ]
67
- </script>
68
-
69
- <SvGrid data={rows} columns={columns} />
70
- ```
71
-
72
- That is a real, accessible grid. Sorting, filtering, virtualization, cell selection, and inline editing
73
- all wire up the moment you turn on the matching prop.
74
-
75
- ## Quick facts
76
-
77
- | | |
78
- |---|---|
79
- | **License** | MIT, free for commercial use |
80
- | **Requires** | `svelte@^5` (peer dependency), Node 16+ |
81
- | **Bundle (gzip)** | ~2 KB headless core, ~80 KB full `<SvGrid>` + ~9 KB CSS |
82
- | **Types** | Bundled, no `@types/` package needed |
83
- | **Module format** | ESM, plus a CDN build at `@svgrid/grid/cdn` |
84
- | **SSR** | Works under SvelteKit SSR and static builds |
85
- | **Theming** | `--sg-*` CSS custom properties, dark mode + high contrast |
86
-
87
- ## Capabilities
88
-
89
- - **Virtual scrolling** - row + column windowing; 100k x 100 stays smooth, with a 1M-row demo.
90
- - **Filtering** - Excel-style filter menu, inline filter row, set / value-list filter, locale-aware matching, between operators.
91
- - **Editing** - 14 built-in `editorType`s (text, number, date, datetime, time, select, rich-select with typeahead, textarea, color, checkbox, list, chips, rating, password) plus a `cellEditor` snippet slot for anything custom.
92
- - **Selection** - cell-range click+drag and Shift+arrows, copy/paste as TSV, Excel-style fill handle, row selection.
93
- - **Views** - row grouping with aggregation, tree data, master/detail, full-width detail rows, spreadsheet mode with formulas.
94
- - **Layout** - row + column pinning, sticky header + first column, header drag-to-reorder, autosize, keyboard-accessible column sizing, zebra rows, responsive mode.
95
- - **Data operations** - find in grid (Ctrl+F), undo / redo, transaction API, optimistic updates, server-side row model with sort / filter / group pushdown.
96
- - **AI helpers, free** - natural-language filter, smart fill, summarize, classify, anomaly detection, and "chart this". Model-agnostic: register one provider, nothing is bundled.
97
- - **UI components** - a Svelte 5 component suite ships in the package (inputs, selection, date/time, overlays, layout, feedback), standalone or as grid cell editors.
98
- - **Accessibility** - WAI-ARIA grid roles, full keyboard navigation, RTL, high-contrast theme.
99
- - **Engineered for production** - first-class TypeScript types, CSP / Trusted-Types safe rendering, SSR-friendly, themeable via `--sg-*` CSS tokens.
100
-
101
- ## Headless or render-ready
102
-
103
- SvGrid ships two layers from one package, so you can choose how much control you want:
104
-
105
- ```ts
106
- import {
107
- // Drop-in render component
108
- SvGrid,
109
- // Headless engine + row-model factories
110
- createSvGrid,
111
- createCoreRowModel,
112
- createFilteredRowModel,
113
- createSortedRowModel,
114
- createGroupedRowModel,
115
- createExpandedRowModel,
116
- createPaginatedRowModel,
117
- // Feature modules
118
- tableFeatures,
119
- rowSortingFeature,
120
- columnFilteringFeature,
121
- columnGroupingFeature,
122
- rowExpandingFeature,
123
- rowPaginationFeature,
124
- rowSelectionFeature,
125
- // Cell renderers
126
- renderSnippet,
127
- renderComponent,
128
- type ColumnDef,
129
- type SvGridApi,
130
- } from '@svgrid/grid'
131
- ```
132
-
133
- - **Headless** - drive `createSvGrid` and the row-model factories, render your own markup.
134
- `getGrid*A11yProps` helpers keep custom markup accessible. About 2 KB gzipped.
135
- - **Render-ready** - `<SvGrid />` is a complete, accessible, themeable grid you configure with props.
136
-
137
- Compatibility aliases are provided for the framework-neutral names: `createGrid`, `createGridState`,
138
- `subscribeGrid`.
139
-
140
- ## AI-native
141
-
142
- SvGrid publishes an [MCP server](https://www.npmjs.com/package/@svgrid/mcp) plus
143
- [llms.txt](https://svgrid.com/llms.txt) and [llms-full.txt](https://svgrid.com/llms-full.txt), so Claude,
144
- Cursor, and Zed answer with accurate, version-pinned APIs and all 370+ demo sources as context rather
145
- than hallucinated methods.
146
-
147
- ```bash
148
- claude mcp add svgrid -- npx -y @svgrid/mcp
149
- npx skills add sv-grid/sv-grid # always-on house-style rules
150
- ```
151
-
152
- See [Use sv-grid docs as LLM context](https://svgrid.com/docs/help/llm-grounding/).
153
-
154
- ## Enterprise features
155
-
156
- The MIT core is free for any use, including commercial, with **no feature gating**. Sorting, filtering,
157
- editing, virtualization, the **server-side row model**, and the **AI helpers** all ship in the free
158
- package. The optional [`@svgrid/enterprise`](https://www.npmjs.com/package/@svgrid/enterprise) pack layers
159
- on the export- and analytics-heavy features teams tend to need last:
160
-
161
- - **Excel / PDF / CSV / TSV / HTML export** plus paginated print.
162
- - **Excel / CSV / TSV / JSON import** with auto-mapping and per-row validation.
163
- - **Pivot tables** with a drag-and-drop pivot Designer.
164
- - **Kanban board and scheduler / calendar renderers** for the `board` and `scheduler` props.
165
-
166
- OSS projects receive an Enterprise key free. See [Pricing](https://svgrid.com/pricing/).
167
-
168
- ## Comparison
169
-
170
- | | SvGrid | AG Grid Community | TanStack Table |
171
- |---|---|---|---|
172
- | **Svelte 5 runes native** | Yes | No, JS core + wrapper | Adapter only |
173
- | **Ships a renderer** | Yes, plus headless | Yes | No, headless only |
174
- | **Bundle (gzip)** | ~2 KB headless / ~80 KB full | ~340 KB | ~12-14 KB |
175
- | **Master/detail, tree, range selection** | Free | Enterprise only | Build it yourself |
176
-
177
- Full detail: [SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/) ·
178
- [Migrating from AG Grid](https://svgrid.com/docs/help/migrating-from-ag-grid/)
179
-
180
- ## Documentation
181
-
182
- - [Getting started](https://svgrid.com/docs/getting-started/) - end-to-end walkthrough.
183
- - [370+ live demos](https://svgrid.com/demos/) - copy-paste recipes for every feature.
184
- - [Why headless?](https://svgrid.com/docs/why-headless/) - when to compose vs. drop in.
185
- - [Theming and Tailwind](https://svgrid.com/docs/help/tailwind/) - re-skin via `--sg-*` tokens and dark mode.
186
- - [Accessibility](https://svgrid.com/docs/help/accessibility/) - the WAI-ARIA grid pattern as implemented.
187
- - [Bundle size](https://svgrid.com/docs/reference/bundle-size/) - measured numbers and how to reproduce them.
188
-
189
- ## Who's behind it
190
-
191
- SvGrid is built by [jQWidgets](https://www.jqwidgets.com), shipping UI components since 2011 to 5,000+
192
- companies including Samsung, Boeing, NVIDIA, Microsoft, Nokia, and Intel. SvGrid is our Svelte 5 native
193
- effort.
194
-
195
- ## License & trademark
196
-
197
- The source code is **MIT-licensed** - see [LICENSE](./LICENSE). It is free for commercial use.
198
- SvGrid&trade; and sv-grid&trade; are trademarks of jQWidgets Ltd; the license covers the code only, not
199
- the name or logo.
1
+ <p align="center">
2
+ <img src="https://svgrid.com/brand/svgrid-logo-icon-1200.png" alt="SvGrid" width="100" height="100" />
3
+ </p>
4
+
5
+ <h1 align="center">@svgrid/grid</h1>
6
+
7
+ <p align="center"><strong>The Svelte 5 native data grid. Headless-first. Render-ready.</strong></p>
8
+
9
+ <p align="center">
10
+ <a href="https://www.npmjs.com/package/@svgrid/grid"><img src="https://img.shields.io/npm/v/%40svgrid%2Fgrid.svg?label=%40svgrid%2Fgrid" alt="npm version" /></a>
11
+ <a href="https://www.npmjs.com/package/@svgrid/grid"><img src="https://img.shields.io/npm/dm/%40svgrid%2Fgrid.svg" alt="npm downloads" /></a>
12
+ <a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License" /></a>
13
+ <a href="https://www.npmjs.com/package/@svgrid/grid"><img src="https://img.shields.io/badge/types-included-blue.svg" alt="TypeScript" /></a>
14
+ <a href="https://svelte.dev"><img src="https://img.shields.io/badge/svelte-5-ff3e00.svg" alt="Svelte 5" /></a>
15
+ </p>
16
+
17
+ <p align="center">
18
+ <a href="https://svgrid.com">Website</a> ·
19
+ <a href="https://svgrid.com/docs/">Docs</a> ·
20
+ <a href="https://svgrid.com/demos/">370+ Demos</a> ·
21
+ <a href="https://svgrid.com/pricing/">Pricing</a> ·
22
+ <a href="https://svgrid.com/roadmap/">Roadmap</a>
23
+ </p>
24
+
25
+ ---
26
+
27
+ A production-grade **Svelte 5 data grid and data table** built from the first line for **runes**, not a
28
+ React grid wrapped in a Svelte shim. Virtual scrolling over 100k+ rows, Excel-style filtering, inline
29
+ editing, row grouping, tree data, and server-side data. Compose the headless engine yourself, or drop in
30
+ the full `<SvGrid />` render component and ship. The MIT core has **zero feature gating**: no license key,
31
+ no watermark, no row-count cap.
32
+
33
+ <p align="center">
34
+ <img src="https://svgrid.com/brand/svgrid-hero.png" alt="A SvGrid trading desk: KPI cards, sector filter chips, and a virtualized data table with sparkline trend columns, conditional colour, and pinned columns." width="100%" />
35
+ </p>
36
+
37
+ ## Install
38
+
39
+ Scaffold a working Vite + Svelte 5 app with SvGrid wired up:
40
+
41
+ ```bash
42
+ npm create @svgrid@latest
43
+ ```
44
+
45
+ Or add it to an existing app:
46
+
47
+ ```bash
48
+ npm install @svgrid/grid
49
+ ```
50
+
51
+ ## Quick start
52
+
53
+ ```svelte
54
+ <script lang="ts">
55
+ import { SvGrid, type ColumnDef } from '@svgrid/grid'
56
+
57
+ const rows = [
58
+ { firstName: 'Ada', age: 36, status: 'active' },
59
+ { firstName: 'Linus', age: 54, status: 'active' },
60
+ { firstName: 'Grace', age: 85, status: 'inactive' },
61
+ ]
62
+ const columns: ColumnDef<{}, (typeof rows)[number]>[] = [
63
+ { field: 'firstName', header: 'First name' },
64
+ { field: 'age', header: 'Age' },
65
+ { field: 'status', header: 'Status' },
66
+ ]
67
+ </script>
68
+
69
+ <SvGrid data={rows} columns={columns} />
70
+ ```
71
+
72
+ That is a real, accessible grid. Sorting, filtering, virtualization, cell selection, and inline editing
73
+ all wire up the moment you turn on the matching prop.
74
+
75
+ ## Quick facts
76
+
77
+ | | |
78
+ |---|---|
79
+ | **License** | MIT, free for commercial use |
80
+ | **Requires** | `svelte@^5` (peer dependency), Node 16+ |
81
+ | **Bundle (gzip)** | ~2 KB headless core, ~80 KB full `<SvGrid>` + ~9 KB CSS |
82
+ | **Types** | Bundled, no `@types/` package needed |
83
+ | **Module format** | ESM, plus a CDN build at `@svgrid/grid/cdn` |
84
+ | **SSR** | Works under SvelteKit SSR and static builds |
85
+ | **Theming** | `--sg-*` CSS custom properties, dark mode + high contrast |
86
+
87
+ ## Capabilities
88
+
89
+ - **Virtual scrolling** - row + column windowing; 100k x 100 stays smooth, with a 1M-row demo.
90
+ - **Filtering** - Excel-style filter menu, inline filter row, set / value-list filter, locale-aware matching, between operators.
91
+ - **Editing** - 14 built-in `editorType`s (text, number, date, datetime, time, select, rich-select with typeahead, textarea, color, checkbox, list, chips, rating, password) plus a `cellEditor` snippet slot for anything custom.
92
+ - **Selection** - cell-range click+drag and Shift+arrows, copy/paste as TSV, Excel-style fill handle, row selection.
93
+ - **Views** - row grouping with aggregation, tree data, master/detail, full-width detail rows, spreadsheet mode with formulas.
94
+ - **Layout** - row + column pinning, sticky header + first column, header drag-to-reorder, autosize, keyboard-accessible column sizing, zebra rows, responsive mode.
95
+ - **Data operations** - find in grid (Ctrl+F), undo / redo, transaction API, optimistic updates, server-side row model with sort / filter / group pushdown.
96
+ - **AI helpers, free** - natural-language filter, smart fill, summarize, classify, anomaly detection, and "chart this". Model-agnostic: register one provider, nothing is bundled.
97
+ - **UI components** - a Svelte 5 component suite ships in the package (inputs, selection, date/time, overlays, layout, feedback), standalone or as grid cell editors.
98
+ - **Accessibility** - WAI-ARIA grid roles, full keyboard navigation, RTL, high-contrast theme.
99
+ - **Engineered for production** - first-class TypeScript types, CSP / Trusted-Types safe rendering, SSR-friendly, themeable via `--sg-*` CSS tokens.
100
+
101
+ ## Headless or render-ready
102
+
103
+ SvGrid ships two layers from one package, so you can choose how much control you want:
104
+
105
+ ```ts
106
+ import {
107
+ // Drop-in render component
108
+ SvGrid,
109
+ // Headless engine + row-model factories
110
+ createSvGrid,
111
+ createCoreRowModel,
112
+ createFilteredRowModel,
113
+ createSortedRowModel,
114
+ createGroupedRowModel,
115
+ createExpandedRowModel,
116
+ createPaginatedRowModel,
117
+ // Feature modules
118
+ tableFeatures,
119
+ rowSortingFeature,
120
+ columnFilteringFeature,
121
+ columnGroupingFeature,
122
+ rowExpandingFeature,
123
+ rowPaginationFeature,
124
+ rowSelectionFeature,
125
+ // Cell renderers
126
+ renderSnippet,
127
+ renderComponent,
128
+ type ColumnDef,
129
+ type SvGridApi,
130
+ } from '@svgrid/grid'
131
+ ```
132
+
133
+ - **Headless** - drive `createSvGrid` and the row-model factories, render your own markup.
134
+ `getGrid*A11yProps` helpers keep custom markup accessible. About 2 KB gzipped.
135
+ - **Render-ready** - `<SvGrid />` is a complete, accessible, themeable grid you configure with props.
136
+
137
+ Compatibility aliases are provided for the framework-neutral names: `createGrid`, `createGridState`,
138
+ `subscribeGrid`.
139
+
140
+ ## AI-native
141
+
142
+ SvGrid publishes an [MCP server](https://www.npmjs.com/package/@svgrid/mcp) plus
143
+ [llms.txt](https://svgrid.com/llms.txt) and [llms-full.txt](https://svgrid.com/llms-full.txt), so Claude,
144
+ Cursor, and Zed answer with accurate, version-pinned APIs and all 370+ demo sources as context rather
145
+ than hallucinated methods.
146
+
147
+ ```bash
148
+ claude mcp add svgrid -- npx -y @svgrid/mcp
149
+ npx skills add sv-grid/sv-grid # always-on house-style rules
150
+ ```
151
+
152
+ See [Use sv-grid docs as LLM context](https://svgrid.com/docs/help/llm-grounding/).
153
+
154
+ ## Enterprise features
155
+
156
+ The MIT core is free for any use, including commercial, with **no feature gating**. Sorting, filtering,
157
+ editing, virtualization, the **server-side row model**, and the **AI helpers** all ship in the free
158
+ package. The optional [`@svgrid/enterprise`](https://www.npmjs.com/package/@svgrid/enterprise) pack layers
159
+ on the export- and analytics-heavy features teams tend to need last:
160
+
161
+ - **Excel / PDF / CSV / TSV / HTML export** plus paginated print.
162
+ - **Excel / CSV / TSV / JSON import** with auto-mapping and per-row validation.
163
+ - **Pivot tables** with a drag-and-drop pivot Designer.
164
+ - **Kanban board and scheduler / calendar renderers** for the `board` and `scheduler` props.
165
+
166
+ OSS projects receive an Enterprise key free. See [Pricing](https://svgrid.com/pricing/).
167
+
168
+ ## Comparison
169
+
170
+ | | SvGrid | AG Grid Community | TanStack Table |
171
+ |---|---|---|---|
172
+ | **Svelte 5 runes native** | Yes | No, JS core + wrapper | Adapter only |
173
+ | **Ships a renderer** | Yes, plus headless | Yes | No, headless only |
174
+ | **Bundle (gzip)** | ~2 KB headless / ~80 KB full | ~340 KB | ~12-14 KB |
175
+ | **Master/detail, tree, range selection** | Free | Enterprise only | Build it yourself |
176
+
177
+ Full detail: [SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/) ·
178
+ [Migrating from AG Grid](https://svgrid.com/docs/help/migrating-from-ag-grid/)
179
+
180
+ ## Documentation
181
+
182
+ - [Getting started](https://svgrid.com/docs/getting-started/) - end-to-end walkthrough.
183
+ - [370+ live demos](https://svgrid.com/demos/) - copy-paste recipes for every feature.
184
+ - [Why headless?](https://svgrid.com/docs/why-headless/) - when to compose vs. drop in.
185
+ - [Theming and Tailwind](https://svgrid.com/docs/help/tailwind/) - re-skin via `--sg-*` tokens and dark mode.
186
+ - [Accessibility](https://svgrid.com/docs/help/accessibility/) - the WAI-ARIA grid pattern as implemented.
187
+ - [Bundle size](https://svgrid.com/docs/reference/bundle-size/) - measured numbers and how to reproduce them.
188
+
189
+ ## Who's behind it
190
+
191
+ SvGrid is built by [jQWidgets](https://www.jqwidgets.com), shipping UI components since 2011 to 5,000+
192
+ companies including Samsung, Boeing, NVIDIA, Microsoft, Nokia, and Intel. SvGrid is our Svelte 5 native
193
+ effort.
194
+
195
+ ## License & trademark
196
+
197
+ The source code is **MIT-licensed** - see [LICENSE](./LICENSE). It is free for commercial use.
198
+ SvGrid&trade; and sv-grid&trade; are trademarks of jQWidgets Ltd; the license covers the code only, not
199
+ the name or logo.
@@ -1,96 +1,96 @@
1
- <script
2
- lang="ts"
3
- generics="TData extends RowData"
4
- >
5
- import { isFunction } from './core'
6
- import {
7
- RenderComponentConfig,
8
- RenderSnippetConfig,
9
- } from './render-component'
10
- import type {
11
- Cell,
12
- CellContext,
13
- ColumnDefTemplate,
14
- Header,
15
- HeaderContext,
16
- RowData,
17
- } from './core'
18
-
19
- type Props =
20
- | {
21
- content?: ColumnDefTemplate<
22
- | HeaderContext<TData>
23
- | CellContext<TData>
24
- >
25
- context:
26
- | HeaderContext<TData>
27
- | CellContext<TData>
28
- cell?: never
29
- header?: never
30
- footer?: never
31
- }
32
- | {
33
- cell: Cell<TData>
34
- content?: never
35
- context?: never
36
- header?: never
37
- footer?: never
38
- }
39
- | {
40
- header: Header<TData>
41
- content?: never
42
- context?: never
43
- cell?: never
44
- footer?: never
45
- }
46
- | {
47
- footer: Header<TData>
48
- content?: never
49
- context?: never
50
- cell?: never
51
- header?: never
52
- }
53
-
54
- let props: Props = $props()
55
-
56
- const resolved = $derived.by(() => {
57
- if ('cell' in props && props.cell) {
58
- return {
59
- content: props.cell.column.columnDef.cell,
60
- context: props.cell.getContext(),
61
- }
62
- }
63
- if ('header' in props && props.header) {
64
- return {
65
- content: props.header.column.columnDef.header,
66
- context: props.header.getContext(),
67
- }
68
- }
69
- if ('footer' in props && props.footer) {
70
- return {
71
- content: props.footer.column.columnDef.footer,
72
- context: props.footer.getContext(),
73
- }
74
- }
75
- return {
76
- content: props.content,
77
- context: props.context,
78
- }
79
- })
80
-
81
- const result = $derived(
82
- isFunction(resolved.content)
83
- ? resolved.content(resolved.context as any)
84
- : undefined,
85
- )
86
- </script>
87
-
88
- {#if typeof resolved.content === 'string'}
89
- {resolved.content}
90
- {:else if result instanceof RenderComponentConfig}
91
- <result.component {...result.props} />
92
- {:else if result instanceof RenderSnippetConfig}
93
- {@render result.snippet(result.params)}
94
- {:else if result !== undefined}
95
- {result}
96
- {/if}
1
+ <script
2
+ lang="ts"
3
+ generics="TData extends RowData"
4
+ >
5
+ import { isFunction } from './core'
6
+ import {
7
+ RenderComponentConfig,
8
+ RenderSnippetConfig,
9
+ } from './render-component'
10
+ import type {
11
+ Cell,
12
+ CellContext,
13
+ ColumnDefTemplate,
14
+ Header,
15
+ HeaderContext,
16
+ RowData,
17
+ } from './core'
18
+
19
+ type Props =
20
+ | {
21
+ content?: ColumnDefTemplate<
22
+ | HeaderContext<TData>
23
+ | CellContext<TData>
24
+ >
25
+ context:
26
+ | HeaderContext<TData>
27
+ | CellContext<TData>
28
+ cell?: never
29
+ header?: never
30
+ footer?: never
31
+ }
32
+ | {
33
+ cell: Cell<TData>
34
+ content?: never
35
+ context?: never
36
+ header?: never
37
+ footer?: never
38
+ }
39
+ | {
40
+ header: Header<TData>
41
+ content?: never
42
+ context?: never
43
+ cell?: never
44
+ footer?: never
45
+ }
46
+ | {
47
+ footer: Header<TData>
48
+ content?: never
49
+ context?: never
50
+ cell?: never
51
+ header?: never
52
+ }
53
+
54
+ let props: Props = $props()
55
+
56
+ const resolved = $derived.by(() => {
57
+ if ('cell' in props && props.cell) {
58
+ return {
59
+ content: props.cell.column.columnDef.cell,
60
+ context: props.cell.getContext(),
61
+ }
62
+ }
63
+ if ('header' in props && props.header) {
64
+ return {
65
+ content: props.header.column.columnDef.header,
66
+ context: props.header.getContext(),
67
+ }
68
+ }
69
+ if ('footer' in props && props.footer) {
70
+ return {
71
+ content: props.footer.column.columnDef.footer,
72
+ context: props.footer.getContext(),
73
+ }
74
+ }
75
+ return {
76
+ content: props.content,
77
+ context: props.context,
78
+ }
79
+ })
80
+
81
+ const result = $derived(
82
+ isFunction(resolved.content)
83
+ ? resolved.content(resolved.context as any)
84
+ : undefined,
85
+ )
86
+ </script>
87
+
88
+ {#if typeof resolved.content === 'string'}
89
+ {resolved.content}
90
+ {:else if result instanceof RenderComponentConfig}
91
+ <result.component {...result.props} />
92
+ {:else if result instanceof RenderSnippetConfig}
93
+ {@render result.snippet(result.params)}
94
+ {:else if result !== undefined}
95
+ {result}
96
+ {/if}