@handsontable/react-wrapper 18.1.2 → 19.0.0-rc2
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/README.md +36 -17
- package/commonjs/react-handsontable.js +877 -190
- package/dist/react-handsontable.js +880 -193
- package/dist/react-handsontable.js.map +1 -1
- package/dist/react-handsontable.min.js +2 -2
- package/dist/react-handsontable.min.js.map +1 -1
- package/es/react-handsontable.mjs +878 -191
- package/helpers.d.ts +125 -12
- package/hotColumnContext.d.ts +6 -0
- package/hotEditor.d.ts +24 -6
- package/hotTableContext.d.ts +10 -8
- package/package.json +15 -4
- package/settingsMapper.d.ts +27 -4
- package/types.d.ts +41 -4
package/README.md
CHANGED
|
@@ -3,17 +3,17 @@
|
|
|
3
3
|
<picture>
|
|
4
4
|
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/handsontable/handsontable/blob/develop/resources/handsontable-logo-white.svg?raw=true"/>
|
|
5
5
|
<source media="(prefers-color-scheme: light)" srcset="https://github.com/handsontable/handsontable/blob/develop/resources/handsontable-logo-black.svg?raw=true"/>
|
|
6
|
-
<img width="360" alt="Logo of Handsontable
|
|
6
|
+
<img width="360" alt="Logo of Handsontable DataGrid" src="https://github.com/handsontable/handsontable/blob/develop/resources/handsontable-logo-black.svg?raw=true"/>
|
|
7
7
|
</picture>
|
|
8
8
|
<br><br>
|
|
9
|
-
<h3>The official <img src="https://raw.githubusercontent.com/handsontable/handsontable/develop/resources/icons/react-icon.svg" width="16" height="16"> React <i>functional</i> wrapper for Handsontable.
|
|
9
|
+
<h3>The official <img src="https://raw.githubusercontent.com/handsontable/handsontable/develop/resources/icons/react-icon.svg" width="16" height="16"> React <i>functional</i> wrapper for Handsontable DataGrid.
|
|
10
10
|
<br>
|
|
11
|
-
<a href="https://handsontable.com/docs/react-data-grid" target="_blank">JavaScript
|
|
11
|
+
<a href="https://handsontable.com/docs/react-data-grid" target="_blank">JavaScript component</a> with a spreadsheet-like look and feel.
|
|
12
12
|
</h3>
|
|
13
13
|
|
|
14
14
|
<p>With its spreadsheet-like editing features, it’s perfect for building data-rich internal apps. It allows users to enter, edit, validate, and process data from various sources. Common use cases include resource planning software (ERP), inventory management systems, digital platforms, and data modeling applications.</p>
|
|
15
15
|
|
|
16
|
-
<a href="https://handsontable.com">Website</a> — <a href="https://handsontable.com/docs/react-data-grid">Documentation</a> — <a href="https://handsontable.com/docs/react-data-grid/themes">Themes</a> — <a href="https://handsontable.com/docs/react-data-grid/api">API</a> — <a href="https://
|
|
16
|
+
<a href="https://handsontable.com">Website</a> — <a href="https://handsontable.com/docs/react-data-grid">Documentation</a> — <a href="https://handsontable.com/docs/react-data-grid/themes">Themes</a> — <a href="https://handsontable.com/docs/react-data-grid/api">API</a> — <a href="https://forum.handsontable.com/">Community</a>
|
|
17
17
|
|
|
18
18
|
<br>
|
|
19
19
|
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
✅ [IME support](https://handsontable.com/docs/react-data-grid/ime-support/) <br>
|
|
44
44
|
✅ [Internationalization](https://handsontable.com/docs/react-data-grid/language/) <br>
|
|
45
45
|
✅ [RTL support](https://handsontable.com/docs/react-data-grid/layout-direction/) <br>
|
|
46
|
-
✅ [Accessibility](https://handsontable.com/docs/react-data-grid/accessibility/) <br>
|
|
46
|
+
✅ [Accessibility](https://handsontable.com/docs/react-data-grid/accessibility/) ([targets WCAG 2.2 AA](https://handsontable.com/docs/react-data-grid/accessibility-conformance-report/)) <br>
|
|
47
47
|
✅ [Keyboard shortcuts](https://handsontable.com/docs/react-data-grid/keyboard-shortcuts/) <br>
|
|
48
48
|
✅ [Sorting data](https://handsontable.com/docs/react-data-grid/rows-sorting/) <br>
|
|
49
49
|
✅ [Filtering data](https://handsontable.com/docs/react-data-grid/column-filter/) <br>
|
|
@@ -56,6 +56,11 @@
|
|
|
56
56
|
✅ [Hiding columns](https://handsontable.com/docs/react-data-grid/column-hiding/) <br>
|
|
57
57
|
✅ [Right-click context menu](https://handsontable.com/docs/react-data-grid/context-menu/) <br>
|
|
58
58
|
✅ [Row pagination](https://handsontable.com/docs/react-data-grid/rows-pagination/) <br>
|
|
59
|
+
✅ [Server-side data](https://handsontable.com/docs/react-data-grid/server-side-data/) <br>
|
|
60
|
+
✅ [Notifications](https://handsontable.com/docs/react-data-grid/notification/) <br>
|
|
61
|
+
✅ [Export to Excel](https://handsontable.com/docs/react-data-grid/export-to-excel/) <br>
|
|
62
|
+
✅ [Date and time editing](https://handsontable.com/docs/react-data-grid/cell-type/) <br>
|
|
63
|
+
✅ [Shadow DOM / Web Components support](https://handsontable.com/docs/react-data-grid/shadow-dom/) <br>
|
|
59
64
|
|
|
60
65
|
<div id="installation">
|
|
61
66
|
|
|
@@ -95,6 +100,7 @@ registerAllModules();
|
|
|
95
100
|
const ExampleComponent = () => {
|
|
96
101
|
return (
|
|
97
102
|
<HotTable
|
|
103
|
+
// licenseKey="your-license-key" // get a key at https://handsontable.com/pricing/
|
|
98
104
|
data={[
|
|
99
105
|
{ company: 'Tagcat', country: 'United Kingdom', rating: 4.4 },
|
|
100
106
|
{ company: 'Zoomzone', country: 'Japan', rating: 4.5 },
|
|
@@ -106,7 +112,6 @@ const ExampleComponent = () => {
|
|
|
106
112
|
tabNavigation={true}
|
|
107
113
|
multiColumnSorting={true}
|
|
108
114
|
headerClassName="htLeft"
|
|
109
|
-
licenseKey="non-commercial-and-evaluation"
|
|
110
115
|
>
|
|
111
116
|
<HotColumn title="Company" data="company" width="100"></HotColumn>
|
|
112
117
|
<HotColumn title="Country" data="country" width="170" type="dropdown" source={['United Kingdom', 'Japan', 'United States']}></HotColumn>
|
|
@@ -124,7 +129,7 @@ const ExampleComponent = () => {
|
|
|
124
129
|
|
|
125
130
|
## 🎨 Themes
|
|
126
131
|
|
|
127
|
-
Handsontable themes control how your data
|
|
132
|
+
Handsontable themes control how your data grid looks: colors, spacing, typography, borders, and overall visual style.
|
|
128
133
|
|
|
129
134
|
You get three built-in themes out of the box:
|
|
130
135
|
- main – modern, clean, default choice
|
|
@@ -161,9 +166,9 @@ To stay aligned with design, you can rely on the:
|
|
|
161
166
|
|
|
162
167
|
<br>
|
|
163
168
|
|
|
164
|
-
## 🤔 Is Handsontable a
|
|
169
|
+
## 🤔 Is Handsontable DataGrid a data grid or a spreadsheet?
|
|
165
170
|
|
|
166
|
-
Handsontable is a data grid component written in JavaScript, not a spreadsheet. However, it brings in many features typically found in spreadsheet software. We designed it this way because spreadsheet-like patterns are often the most user-friendly when it comes to data entry and management.
|
|
171
|
+
Handsontable DataGrid is a data grid component written in JavaScript, not a spreadsheet. However, it brings in many features typically found in spreadsheet software. We designed it this way because spreadsheet-like patterns are often the most user-friendly when it comes to data entry and management.
|
|
167
172
|
|
|
168
173
|
### Spreadsheet-like features in Handsontable:
|
|
169
174
|
|
|
@@ -181,12 +186,20 @@ At first glance, it might seem that a data table, spreadsheet, and data grid are
|
|
|
181
186
|
|
|
182
187
|
<br>
|
|
183
188
|
|
|
189
|
+
## 🤖 AI & agent resources
|
|
190
|
+
|
|
191
|
+
Working with an AI assistant or coding agent? Handsontable DataGrid and HyperFormula ship first-party agent resources:
|
|
192
|
+
|
|
193
|
+
- **Agent Skills** — install in Claude Code with `/plugin marketplace add handsontable/handsontable-skills` → [github.com/handsontable/handsontable-skills](https://github.com/handsontable/handsontable-skills)
|
|
194
|
+
- **Docs MCP server** — live semantic search over the docs, API reference, release notes, and GitHub issues: `claude mcp add --transport http handsontable-docs https://docs-assistant.handsontable.com/mcp` → [guide](https://handsontable.com/docs/react-data-grid/docs-mcp-server/)
|
|
195
|
+
- **Docs written for agents** — every docs page has a Markdown twin; start at [handsontable.com/docs/llms.txt](https://handsontable.com/docs/llms.txt)
|
|
196
|
+
|
|
184
197
|
## 🛟 Support
|
|
185
198
|
|
|
186
199
|
**We're here to help!**
|
|
187
200
|
|
|
188
201
|
If you're using Handsontable with a free, non-commercial license, you can:
|
|
189
|
-
-
|
|
202
|
+
- Get quick help from our [**Ask AI** assistant](https://handsontable.com/docs/react-data-grid/ai-docs-assistant/) available in the documentation.
|
|
190
203
|
- Report any bugs you find on our [GitHub Issue Board](https://github.com/handsontable/handsontable/issues).
|
|
191
204
|
- Connect with other developers and find answers on our [Developer Forum](https://forum.handsontable.com).
|
|
192
205
|
|
|
@@ -196,22 +209,28 @@ If you have a commercial license, feel free to contact us directly at [support@h
|
|
|
196
209
|
|
|
197
210
|
## 📖 Licenses
|
|
198
211
|
|
|
199
|
-
Handsontable is available under
|
|
212
|
+
Handsontable DataGrid is available under the following licensing options. Each license comes with its own terms and conditions, as outlined below:
|
|
200
213
|
|
|
201
|
-
### ① Free
|
|
202
|
-
|
|
203
|
-
[Learn more here](https://github.com/handsontable/handsontable/blob/master/handsontable-non-commercial-license.pdf).
|
|
214
|
+
### ① Free trial for evaluation
|
|
215
|
+
Businesses and other organizations can evaluate Handsontable DataGrid for free. Start a trial at [handsontable.com/pricing](https://handsontable.com/pricing/) to get a trial license key. The trial covers internal evaluation outside production, runs once, and can't be renewed. During the trial, you can contact our technical support team. When it ends, you need a commercial license to keep using Handsontable DataGrid.
|
|
204
216
|
|
|
205
217
|
### ② Commercial license
|
|
206
218
|
For commercial use, a paid license is required. This license includes support and maintenance to ensure you get the most out of Handsontable. The commercial license can be purchased directly from Handsoncode or through an [authorized reseller](https://handsontable.com/resellers). See the [pricing page](https://handsontable.com/pricing) for details.
|
|
207
219
|
|
|
220
|
+
### ③ Free license for non-commercial projects
|
|
221
|
+
Non-commercial projects, such as teaching or academic research, may qualify for a free license. To apply, [contact our sales team](https://handsontable.com/contact/) and tell us about your project.
|
|
222
|
+
|
|
208
223
|
<br>
|
|
209
224
|
|
|
210
225
|
## 🔑 License Key
|
|
211
226
|
|
|
212
|
-
|
|
227
|
+
Pass your license key in the `licenseKey` option. The examples above leave that line commented out: uncomment it and add your key.
|
|
228
|
+
|
|
229
|
+
To evaluate Handsontable, [get a trial key](https://handsontable.com/pricing/). During the trial, the grid shows the Handsontable badge and a "Powered by Handsontable DataGrid" bar below the table, and the console warns how many days remain. After the trial expires, the grid shows an expiration message and the console reports an error. When the grace period stored in the key also passes, a blocking screen replaces the grid. See [Trial keys](https://handsontable.com/docs/react-data-grid/license-key/#trial-keys) for details.
|
|
230
|
+
|
|
231
|
+
For non-commercial use, [contact our sales team](https://handsontable.com/contact/) to apply for a free license.
|
|
213
232
|
|
|
214
|
-
If you're using Handsontable in a project that supports commercial activities, you'll need to purchase a license key at [handsontable.com/pricing](https://handsontable.com/pricing). You can find more details in [our documentation](https://handsontable.com/docs/license-key/).
|
|
233
|
+
If you're using Handsontable in a project that supports commercial activities, you'll need to purchase a license key at [handsontable.com/pricing](https://handsontable.com/pricing). You can find more details in [our documentation](https://handsontable.com/docs/react-data-grid/license-key/).
|
|
215
234
|
|
|
216
235
|
<br>
|
|
217
236
|
|
|
@@ -226,4 +245,4 @@ Created and maintained by the [Handsontable Team](https://handsontable.com/team)
|
|
|
226
245
|
|
|
227
246
|
---
|
|
228
247
|
|
|
229
|
-
© 2012 -
|
|
248
|
+
© 2012 - 2026 Handsoncode
|