Added
- Breaking change: Added treegrid accessibility to the NestedRows plugin: tree attributes on rows, Ctrl/Cmd+arrow keys on a row header to expand, collapse, or move to the parent row, and screen reader announcements. On a row header, Ctrl/Cmd+arrow keys no longer jump to the edge of the row, and Enter no longer toggles while an overlay covers the grid. #13759
- Breaking change: The
Loadingplugin now needs theDialogplugin registered:new Handsontable()throws an error without it, where the loading overlay used to show nothing. RegisterDialogalongsideLoading. Addeddist/manifest.jsonto the package: a list of every feature, the license token that names it, and the features it needs. #14094 - Added the FormulaBuilder plugin: a formula bar, an inline formula editor with colored references, cell/range/header reference picking, autocomplete, function help, and formula error indicators. DragToScroll no longer starts auto-scrolling on a mouse press that an earlier listener stopped with
stopImmediatePropagation(), and the autocomplete, dropdown, and multiselect cell arrows ignore such a press too. #13172 - Added the
preserveTextValuecell meta option that makes theFormulasplugin pass values oftext-type cells to the calculation engine as strings, preserving leading zeros of number-like values. Aligning the escaping across every write path also changed howloadData(),updateData(),updateSettings(), andsetSourceDataAtCell()feeddate-type cells to the engine: non-ISO date-like values (for example'123','12:30', or'TRUE') now reach the engine as text instead of a number, a time fraction, or a boolean, atypeset only through thecells()function now applies on those paths, and those paths now call thecells()function and thebeforeGetCellMetaandafterGetCellMetahooks once per non-formula text cell. The same work fixes the plugin addressing the wrong engine row fromsetSourceDataAtCell()on a sorted or moved grid, writing#REF!over a formula whose target still existed and reading a cell'svalueGetterfrom the wrong row or column when detaching a row with theNestedRowsplugin, and reading the autofill source cell's configuration from another cell when rows or columns were trimmed or moved. #13213 - Added a searchable matrix of which configuration levels each option takes effect at, and the same information to every option in the API reference. #13305
- Added the
clearManualSizes()method to theManualRowResizeandManualColumnResizeplugins, and theclearManualSize()method toManualRowResize, whichManualColumnResizealready had. They discard the sizes stored by manual resizing, for one row or column or for all of them. #13307 - Added the
textExtractoroption, which writes column and row headers to an exported file, and column headers to the clipboard, as the text the grid displays instead of their raw HTML. #13308 - Added the
renderModeoption, which lets a grid, column, or cell skip repainting cells that did not change since their last render, together with themarkCellChanged()andmarkAllCellsChanged()methods, and made the selection pass update only the cells whose selection state changed. Under'onChange', a vertical scroll paints only the rows that enter the rendered area; with merged cells, the cells of the merged blocks repaint too. #13384 - Added the
SheetsBarplugin — a tab bar for switching between sheets of a multi-sheet workbook — and thegetManualSize(),getManualSizes(), andsetManualSizes()methods to theManualColumnResizeandManualRowResizeplugins. #13409 - Added the
autoLinkoption, which renders the URLs, email addresses, and phone numbers in cell values as clickable links, with astrict: falsemode that also links bare domains and email addresses;formulas.hyperlinksnow also accepts a{ target, schemes }object, and the Formulas plugin'sregisterShortcuts()andunregisterShortcuts()methods are deprecated no-ops because the Alt+Enter link shortcut is a core grid shortcut. #13448 - Added a
sortFixedRowsoption to theColumnSortingandMultiColumnSortingplugins. It defaults tofalse, which keeps the rows frozen byfixedRowsTopandfixedRowsBottomout of sorting, as in 18.0.0. Set it totrueto sort the whole dataset, including both frozen areas. The option is grid-level only. #13456 - Added two ways to narrow what the
Filtersplugin covers. The newfilterFixedRowsoption, set tofalse, keeps the rows frozen byfixedRowsTopandfixedRowsBottomout of filtering: they are never hidden by a filter, and their values are no longer listed underFilter by value. Settingfilterstofalsefor a column in thecolumnsoption now hides that column's filter controls in its dropdown menu. #13522 - Added the
ImportFileplugin, which loads an.xlsxworkbook into the grid through the ExcelJS engine: cell values and inferred types with their number, date, and time formats, dropdown sources, formulas, merged cells, frozen panes, hidden rows and columns, column widths and row heights, read-only cells from sheet protection, comments, nested headers, and, withimportStyles, alignment, font, fill, and borders. Features the engine cannot read are reported in one console warning per call. TheExportFileplugin's XLSX writer now shares the same engine adapter: date and time cells export the Excel number format derived from theirdateFormatandtimeFormatoptions (a cell using the default options and the defaulten-USlocale now writesmm/dd/yyyyandhh:mm AM/PMinstead ofmm-dd-yyandh:mm:ss; a date cell follows itslocale, sode-DEwritesdd.mm.yyyy), formula cells carry their column's number format and a cached result, sheet names are sanitized,compression: falsewrites an uncompressed archive, a formula reference qualified with a sheet name (Rates!A1) is written and read back unshifted (a known limitation when the referenced sheet is exported in the same workbook with headers, see the export guide), a rendered cell's font color is exported from the cell itself while a cell outside the viewport is read from its classes only, and a rendered font color inherited from a container-scoped CSS variable is no longer written to the file.batch(),batchRender(), andbatchExecution()now resume rendering and execution when the wrapped callback throws, instead of leaving the grid suspended. #13551 - Added the
refetchAfterCreateoption todataProvider. Set it tofalseto skip the automaticfetchRowsrefetch after a successfulonRowsCreateand apply the server response to the grid yourself, for example to keep a newly inserted row on the current page while the grid is sorted. #13563 - Added the
filterValueComparatoroption to set a custom order of the values in the Filters plugin's "Filter by value" list, per column or for the whole grid. #13585 - Added the
getCellDependentsandgetCellPrecedentsmethods to the Formulas plugin. #13594 - Added a
showFormulas()/hideFormulas()toggle to theFormulasplugin, so a formula cell can display its formula text instead of its calculated value, and aCtrl+`shortcut that toggles it. #13611 - Added a built-in XLSX engine, so
importFile: trueandexportFile: trueread and write.xlsxfiles without ExcelJS;engines: { xlsx: ExcelJS }keeps working. With no engine configured, the "To Excel" context menu item is shown,supportsExportFormat('xlsx')andsupportsImportFormat('xlsx')returntrue, and an XLSX export or import succeeds;engines: { xlsx: null }selects the built-in engine, and a per-callengine: nullkeeps the grid's engine. A non-finite number (NaN,Infinity) now exports as text. Fixed merged-cell meta left behind andcustomBordersthrowing after aloadData/updateDatathat shrank the grid,clearBorders()leaving a border's meta (and its export) behind while rows were sorted or filtered, an XLSX export freezing extra columns or rows when some were hidden, an empty checkbox exporting asFALSE, a clearednumericcell exporting as0, an XLSX export downloading[object Promise]under Zone.js (Angular), the Formulas plugin losing a validated write whenupdateSettings()or a sheet switch ran in the same task,removeCellMeta()throwing for an index past the grid's range (it now removes the key at that physical index, likesetCellMeta()), an XLSX export writing currency codes such as#,##0.00USDthat Excel repaired and other applications dropped, and dropping the leading zeros of a zero-padded format, an XLSX export of a right-to-left page writing a left-to-right sheet, a merged range with an empty first cell shifting its row in Apple's viewers, a border restored by undo under a filter or trim not being painted again, the export progress dialog showing empty for a grid inside an iframe, two overlapping imports applying in the order they finished instead of the order they started, an XLSX export withexportFormulaswriting a formula's error result (such as#DIV/0!) as text instead of an error cell, an XLSX export withexportFormulaswriting another row's formula into a cell when rows were sorted, moved, trimmed, or filtered, an XLSX export writing a currency symbol that imported back as another currency or as a plain number (it now writes the ISO 4217 code), an XLSX export writingLETandLAMBDAparameter names without Excel's_xlpm.prefix, custom borders staying on their old rows afterupdateSettings({ trimRows })or being lost bytrimRow()followed byloadData(), a progressivecustomBordersload landing on the wrong rows after a trim or a filter, and an XLSX export writing a date before 1900 or a date that does not exist as a wrong date serial (it now exports as text). #13634 - Added a console warning when the data source has rows but Handsontable cannot find any columns in it, because the first row of
datahas no fields and neithercolumnsnordataSchemais set. #13637 - Added the
availableConditionssetting to thefiltersoption, which chooses the operators that the Filter by condition lists offer, for the whole grid, per data type, or per column. #13661 - Added support for a number in the
textEllipsisoption, which clamps the text of a cell to that many lines and ends it with an ellipsis. #13724 - Added the
maxLengthoption that limits the number of characters in a cell, without a custom validator. If your app already stores a custommaxLengthkey in cell settings, the built-in limit now applies to those cells, so rename your key or see the migration guide. #13725 - Added the
beforePasteParsehook to theCopyPasteplugin. It fires before the clipboard content is sanitized and parsed, and passes a writable copy of the clipboard and the nativeClipboardEventto the callback, so you can clean pasted data without disabling the plugin. #13726 - Added the
fixedColumnsEndoption, which freezes the last columns at the inline end edge of the grid (the right edge in LTR, the left edge in RTL), and fixed theDragToScrollplugin reserving the row header width on the wrong side in RTL. #13730 - Added row selection checkboxes with a "select all" checkbox in the header (the
rowSelectionoption), with server-side and nested rows support, and a "check all" checkbox for checkbox columns (theheaderCheckboxcolumn option). Also,setSourceDataAtCell()now calls thevalueSetteronce per cell when anafterSetSourceDataAtCelllistener exists. #13735 - Added the
sourceLabeloption, which lets thevalueof a key/valuesourceentry in thedropdownandautocompletecell types be an object, labeled by a property path or a function. #13765 - Added the
freezeBarplugin, which lets users change the number of frozen rows and columns by dragging a bar on the freeze line or with the keyboard, together with thebeforeFreezeChangeandafterFreezeChangehooks and thegetFreezeCount()andsetFreezeCount()methods. #13766 - Added the
limitFixedToViewportoption, which draws only the frozen rows and columns that fit the grid and keeps the rest of it scrollable. #13771 - Added the
handsontable/themes/typesexport, so a theme preset re-exported without a type annotation no longer fails declaration emit with TS2742 or TS2883. #13866 - Added a native date input to the "Is equal to" and "Is not equal to" filter conditions on
dateandintl-datecolumns. #13878 - Added the
ViewStateplugin, whosegetViewState(),setViewState(), andvalidateViewState()methods capture the grid's view (sort, filters, hidden and resized rows and columns, frozen panes, pagination, selection, and scroll position) as plain JSON, check it, and restore it. #13912 - Added the
rowIdoption, thegetRowId(),getVisualRowById(),getPhysicalRowById(), and related row id methods, and theafterRowIdsRemovedandafterRowIdsResethooks, which give each row an id that stays with its record when you sort, filter, move, insert, or remove rows. #13914 - Added the AsyncValues plugin, which fills cells from promises, one cell at a time or in batches, with a pending and an error state per cell, cancellation of stale requests, a concurrency limit, retries, and an optional undo step per run, and an optional save of the resolved values through DataProvider. Also, an open editor now keeps what the user typed when setSourceDataAtCell() writes another cell, or when a beforeChange listener vetoes a change to another cell. #13916
- Added the getAvailableConditions() method to the Filters plugin, which lists the filter conditions a column offers. A view state now restores the other columns' filters and skips the filter of a column that cannot offer its condition. #13934
- Added
handsontable/settingsSchema: a JSON Schema of the grid, column, and cell settings, and avalidateSettings()function that checks a configuration before you apply it and lists each problem with a path, a code, and a message. #13955 - Added
handsontable.settings-schema.js, a CDN file that adds theHandsontableSettingsSchemaglobal withsettingsSchemaandvalidateSettings(), so a page that loads Handsontable from a CDN can validate its settings. #13965 - Added dynamic-array formulas, error cells, and defined names to the XLSX export and import. With
exportFormulas, the export writes the Formulas plugin's named expressions as defined names, the sheet-scoped ones included. The import keeps an array formula's spilled cells empty so it spills without#SPILL!, keeps the file's cached values where HyperFormula spills less, and registers the workbook's defined names in HyperFormula (built-in engine). The XLSX export now changes existing output too: with the Formulas plugin on, it writes each value with the type HyperFormula computed, even withoutexportFormulas, so a computed number orTRUE/FALSEis no longer written as text, and an error Excel has a code for is written as an Excel error instead of text. It also writes a formula entered with a decimal comma (decimalSeparator: ',') with a dot, so Excel reads1,5as 1.5. Fixed exported cell formulas being written one column off when columns were moved withmanualColumnMoveand hidden columns were left out withexportHiddenColumns: false. #14096 - Added license gating to the XLSX engine: with a license key that names a tier,
importFileandexportFileskip the XLSX features the tier leaves out; a key that names no tier keeps every feature.supportsExportFormat('xlsx')andsupportsImportFormat('xlsx')answerfalsewhen the tier leaves out the XLSX export or import. The console warning and thelicense:*entries in the import report name only the features the file or grid actually had and the caller asked to bring over, and without number formats a date or time exports as the text the grid shows. Added theprotectionoption to the XLSX export, so a sheet can be protected with a password of up to 255 characters. #14098 - Added the license check of plugins: a plugin that the tier of a license key leaves out stays off, and the console and the bar under the grid name the missing features. A plugin turned off with
disablePlugin()while its option is on now counts as off for exports, imports, row resizing, the Loading overlay, and the Undo, Redo, and "Copy with group headers" context menu items. #14104 - Added the
hidden_columns_hideandhidden_columns_showkeys to the column menu. List them in thedropdownMenuoption to show the items.dropdownMenu: trueis unchanged. A custom column menu item under one of these keys now uses the built-in action and visibility rule unless you set your own. TheMenuItemConfigandPredefinedMenuItemKeytypes are now also exported fromhandsontable. #14107 - Added the import of the errors Excel stores as rich values, such as #SPILL! and #CALC!, to the built-in XLSX engine. Such cells used to import as #VALUE!. A cell holding a linked data type, such as Stocks, is now reported in result.dropped. #14119
- Added a "Powered by Handsontable DataGrid" bar below the grid for trial license keys (including trials issued for external use) and keys with the
badgeflag. A license bar now stays within the grid's declaredheight. #14139 - Added the
batchEvaluationsetting of theformulasoption, which makes HyperFormula recalculate once for all changes made insidebatch(), and thebeforeSuspendExecution,afterSuspendExecution,beforeResumeExecution, andafterResumeExecutionhooks. #14268 - Added the
includeSummaryResultsoption of a column summary, which lets a summary count the results of other summaries inside its range. #14271 - Added license tiers: a license key can name the Standard or Professional tier, and the license key guide lists the features each tier includes. A key that names no tier keeps every feature. #14284
- Added an
emptyValueoption that sets what an emptied cell stores, and stopped a cell editor confirmed without any typing from overwriting the cell's value with an empty string. #3927 - Added the
AutoRowHeaderSizeplugin, which sizes the row header column to its longest label instead of clipping it. #7147 - React: Added a console warning when a Handsontable function renderer is passed to the
rendererprop ofHotTableorHotColumn, pointing to thehotRendererprop instead. #14010
Changed
- Breaking change: Changed
colToProp()andpropToCol()to returnnullwhen the column index or property names no column that exists and is visible, instead of returning the passed argument. Both TypeScript declarations widened to includenull. A property name your data does not use is still returned unchanged, and themodifyDatahook now receivesnullas its column argument for a numeric property that names no column, with its TypeScript declaration widened to match. #13330 - Breaking change: Changed
height: 'auto'to no longer clip the grid, so the page or the nearest scrolling ancestor scrolls it and its rows stay virtualized. See the migration guide for the otherwidthandheightchanges. #13381 - Breaking change: The
autocomplete,dropdown, andhandsontablecell types now defaulttextEllipsistotrue, so a long value stays on a single line and truncates with an ellipsis clear of the dropdown arrow, andautoRowSizesizes their rows to one line; settextEllipsis: falseon the column to restore wrapping. #13509 - Breaking change: Changed icons to render as
<i class="ht-icon ht-icon-<name>">elements driven by--ht-icon-<name>CSS variables, and extended the themeiconsoption to accept SVG strings, class lists (for icon fonts such as Tabler), or renderer callbacks (for Material Symbols ligatures). Pseudo-element icon selectors are removed and the Filters condition caption text moved into ahtUISelectCaptionLabelchild. Mirrored icons follow the grid'slayoutDirectioninstead of an ancestor'sdir, and a checkbox on a-no-iconsbundle shows the theme's box with no tick instead of a native checkbox. TheiconsMap()theme helper is deprecated in favor oficonStyles(); see the 19.0 migration guide. #13639 - Breaking change: Changed the TypeScript types of the
filtersoption. The object form now accepts onlysearchModeandfilterFixedRows, and a column'sfiltersaccepts only a boolean, so a misspelled key, a wrong value, or a per-column object no longer compiles. #13662 - Breaking change: Changed how undo and redo work: every action is now one undo step that restores the grid state it started from, so an undo puts values back on the right records after rows or columns were moved, sorted, filtered, or trimmed. Hiding, trimming, resizing, freezing, collapsing, custom borders, comments, cell meta, and the pagination page and page size are now undoable,
batch(),batchExecution(), and the newrunOperation()method group changes into one step, and the newundo: { maxHistory }option caps the history. Withundo: false, nothing is recorded anymore. #13672 - Breaking change: Changed the narrowest width a column can be resized to, in a grid whose headers render the dropdown menu button, from 20px to the icon size plus the cell padding on both sides (32px in Main, 40px in Horizon, 24px in Classic), so the menu button stays inside its own cell. A narrow header now hides the label text first, then the sort indicator, and keeps the menu button. See the migration guide. #13742
- Breaking change: Changed
manualColumnFreezeso that frozen columns can be dragged and columns can be dropped in front of them, as withfixedColumnsStart; to keep the old lock, returnfalsefrombeforeColumnMove, as shown in the migration guide. Added therestoreColumnPositionoption ofmanualColumnFreeze, afinalIndexargument to thebeforeColumnUnfreezeandafterColumnUnfreezehooks, and fixed the drop guideline being hidden under frozen columns and the selection staying on the old column after a freeze or unfreeze from the menu. #13755 - Breaking change: Changed
updateSettings()so that a newdataSchema, with nocolumnsoption set, re-initializes the index mappers and the column-to-property map when the columns it defines change. The grid now resolves the column count of the new schema, and sorting, filtering, and columns that users moved, hid, or resized start over. #13833 - Breaking change: Changed the
colWidthsarray and function to address columns by their physical index, so a column keeps its width when the user moves it, and when you insert or remove columns. Handsontable never changes the array you pass. SwitchingcolWidthsto or from an array, or passing a new array, clears the undo history. See the 18.1 to 19.0 migration guide to keep the old behavior. #13834 - Breaking change: Changed
setValue()on a custom editor that extendsBaseEditorso it receives the cell value instead of a string. A ReactuseHotEditororEditorComponent, and an AngularHotCellEditorComponent, receive that value too. When the editor needs a string, usevalue == null ? '' : String(value). #13896 - Breaking change: Declared the
enterCommits,filterSelectedItems,notification,maxSelections,valueParser,searchInput,sourceSortFunction,theme,injectCoreCss, andparsePastedValueoptions in theGridSettingsTypeScript type. A value of the wrong type, an unknownnotificationkey, or reading an option without a guard now fails to compile. #13964 - Breaking change: Changed
updateSettings()so that a hook set tonullremoves the callbacks the settings registered for it, and fixedcolWidths: nullkeeping columns at 50px instead of lettingAutoColumnSizesize them, and fixed a plugin turned on byupdateSettings()reading its previous settings. #14000 - Breaking change: Changed when plugins set up their initial state:
columnSorting,columnSummary,mergeCells,customBorders,pagination,emptyDataState,nestedRowsanddataProvidernow apply their settings before the first render, so columns under nested headers get their final width at once, and the grid renders once at init (twice whencustomBordersdeclares borders). The hooks that work fires (afterColumnSort,afterMergeCells, theafterChangeof merges and summaries,afterEmptyDataStateShow,beforeDataProviderFetchand the firstfetchRowscall) now run before theinithook and the first render, sogetCell()returnsnullinside them at init. The summaries of anupdateSettings()call are written after itsafterUpdateSettingslisteners, so a listener there reads the previous summaries and, when the call also passescolumns, a summary cell that is not read-only yet. CallingenablePlugin()on a running grid now applies the plugin's settings, and fordataProviderit fetches the data from the server. #14080 - Breaking change: Changed
loadData()to drop a change that still waits for its cell's validator, instead of writing it into the new data at the same coordinates, usually a different record. This also applies whenloadData()runs right aftersetDataAtCell()and when the new data holds the same records.afterChangedoesn't fire for a dropped change. The DataProvider plugin writes such an edit again into its own record after the refetch that follows a save. See the migration guide. #14109 - Breaking change: Changed the
rowHeightsandminRowHeightsarrays and functions to address rows by their physical index, so a row keeps its height when rows are collapsed with nested rows, filtered, trimmed, sorted, or moved, and aligned the nested rows collapse button with the row header label in rows with an exact height. Switching either option to or from an array, or passing a new array, clears the undo history. Also fixed a row inserted below another taking over that row's hidden state and manually resized height. See the 18.1 to 19.0 migration guide to keep the old behavior. #14221 - Breaking change: Vue: Changed the Vue 3 wrapper to type-check every
HotTableandHotColumnprop in a template, sovue-tscrejects a wrong value, a non-function hook prop, ordata: nullonHotTable. Also made thehandsontableprop of both components, and thegetValueprop ofHotTable, reach the grid settings, which they did not before. See the migration guide for what to change. #14059 - Changed how the
nestedRowsplugin treats collapsed rows when the data is replaced:updateData()now keeps the collapsed parents, matching them by their position in the tree, whileloadData()drops them, sogetCollapsedParents()no longer reports parents from the previous dataset. #13224 - Changed how a clipboard with rows of unequal length is pasted: it now pastes as wide as its widest row, a shorter row empties the cells it covers, content repeating into a larger selection repeats on that width, and a merged cell reaching past the last column is trimmed to fit. #13237
- Content shaped like an HTML tag, a markup declaration, or a character reference is now what routes cell and header text through the HTML write path. Ordinary text holding
&,;,<or>is written as plain text, which keeps it from stopping a grid from rendering under a Trusted Types policy. A character reference without its closing semicolon, such as© 2024, now renders literally. #13264 - When
manualColumnFreezeis enabled, the column (dropdown) menu now offers the "Freeze column" and "Unfreeze column" entries by default, and rebuilds its item list every time it opens. #13294 - Made a grid with a pixel
widthand noheightscroll its columns inside its own box while the page scrolls its rows, and fixed thepreventOverflow: 'horizontal'layout (the bottom frozen rows now scroll with the page, the vertical scroll hooks fire, and the workspace width follows the container). #13379 - Improved scrolling performance by removing a redundant re-render that ran whenever the grid was scrolled across its horizontal start. #13393
- On a grid with column headers, the header now owns the gridline below it at every scroll position, so the first body row no longer renders a pixel taller than the rest and the grid's height no longer changes when it is scrolled.
columnHeaderHeightresolves to the same border-box height at every scroll position as a result, and because that height includes the header's 1px top and bottom borders,columnHeaderHeight: 40leaves a 38px content box instead of 39px on an unscrolled grid. #13418 - Made a vertical scroll keep the row elements of the rows that stay rendered, so a
trmoves with its row instead of being repainted in place and a renderer that caches per element keeps its cache across the scroll. #13467 - Improved rendering performance when rows shrink after a column resize: the viewport refill now renders only the newly added rows instead of re-rendering every visible row on each refill pass, so cell renderers and the
beforeRendererandafterRendererhooks run once per cell for that draw. #13481 - Moved the drag behavior shared by the
manualRowResizeandmanualColumnResizeplugins into one internal module. Both plugins keep every documented method, option and hook. Their internal members are no longer part of the emitted TypeScript types, includingManualColumnResize#startX, which the API reference never listed but the type definitions did. #13525 - Made the frozen overlays' clone holders composited scroll containers, so a scroll frame no longer repaints the whole grid on grids with content-rich cells, and a touch pan over a frozen header now scrolls the grid instead of the page. #13539
- Changed how the
ColumnSortingandMultiColumnSortingplugins sort. Each sorted column is now read in one guarded bulk pass instead of cell by cell, and the sort reorders row positions rather than per-row tuples. A column that sorts with the default comparison (text, and any type without its own sort function, such asdropdownorautocomplete) also extracts each row's comparison key once instead of on every comparison. Together, this roughly halves the time a large grid takes to sort by a text column. A grid that uses theFormulasorNestedRowsplugin, adropdown,autocomplete, ormultiSelectcolumn, acolumns[].dataaccessor, or a column bound to a nested property path (such asdata: 'address.city') keeps the per-cell read. When you sort by two or more columns,modifyDataandmodifyRowDatalisteners andvalueGetterfunctions now run column by column instead of row by row. #13577 - Improved filtering performance on large datasets: the
Filtersplugin now reads each filtered column as plain lists of rows and values, and creates a row's cell meta inside the filter scan instead of building the whole column's data up front. #13579 - Improved the
updateSettings()performance with theformulasplugin enabled: a setting that changes the row count, such as togglingnestedRows, now rebuilds the formula sheet once, after the plugins update, instead of twice. A rebuild that fails now surfaces from the first read or render that needed it, and a listener that reads a cell fromafterUpdateSettingspays that rebuild inside the read. #13600 - Improved the performance of loading data and switching sheets on grids with the AutoColumnSize and Formulas plugins enabled, by running the full column measurement once per data load instead of twice. #13604
- Changed the date, time, and datetime editors to leave the native picker closed when the keyboard opens them, so Tab works after Enter in Chromium, and fixed the time and datetime editors not focusing their input in Firefox. #13821
- Changed the double-click fill (copy-down) to stop above the first value already in the filled column and at the first gap in the neighboring column, as spreadsheet applications do, instead of filling across gaps or not filling at all. #13906
- Changed auto-sizing so a column wider than the grid is measured at its content width again, as before 16.2.0, instead of being capped at the width of the grid. This also fixes auto-sized columns that kept a wrapped, narrow width after the grid's container collapsed and returned. #13907
- Changed touch taps inside cells when visual selection is off: buttons, file inputs, and links now respond to a single tap. Heads-up: a link in such a cell is now followed on the first tap, where before that tap did nothing. #13950
- Updated the logo in the trial license badge and the lock screen to the new Handsontable branding. #13980
- Changed how a hook callback registered more than once is counted: settings that pass a function first added with
addHook()stop the hook's earlier settings function, a callback added withaddHookOnce()and then registered again keeps running, and in the Angular wrapper a callback passed both in thesettingsinput and toaddHook()runs once, andremoveHook()removes it. #14047 - Changed the grid's scrollbars to run beside the scrollable area only, so they start after the headers and frozen rows or columns instead of running along the full edge of the grid, and kept the grid's border visible over them. #14069
- Changed the label of the "Filter by value" clear link from "Clear" to "Select none" in English, and to the counterpart of "Select all" in 19 other languages. Tests that match the old text need the new one. To keep the old text, override the
Filters:buttons.clearkey in a language dictionary. Fixed long labels of the two links above the list being clipped at the menu edge. #14075 - Changed the message for a missing license key: the console warning and the lock screen no longer suggest the
non-commercial-and-evaluationkey. #14138 - Changed updateSettings() to render the grid once when the new settings include data. The afterUpdateSettings hook now runs before that render, so getCell() there returns the previous render, and a React HotTable update no longer paints twice. #14203
- React: Changed
useHotEditorsovalueupdates in the same render assetValue, and mounted React editors inherit the grid themecolor-scheme. #13376 - React: Changed
@handsontable/react-wrapperto declarereactandreact-dom18.0.0 or later as peer dependencies, matching the documented React 18 minimum. #14009 - Angular: Changed the wrapper to build with Angular 22, which replaces the per-file type declarations with a single bundled types file, while the supported range stays Angular 16 to 22. #13835
Deprecated
- Deprecated writing past the last column of an object data source. A paste,
populateFromArray(), orsetDataAtCell()still adds a property named after the column index, which no column can display, and prints a one-time console warning; the write will be ignored in Handsontable 20.0.0. UsesetDataAtRowProp()to write a field the grid shows no column for. #13343 - Deprecated the
spliceCol()andspliceRow()methods. They still work but print a one-time console warning and will be removed in 20.0.0. UsepopulateFromArray()oralter()instead. #13599 - Added the
sr-Latn-RSlanguage code for Serbian (Latin) and deprecated thesr-SPcode, which will be removed in 20.0. #13782
Removed
- Breaking change: Removed the
non-commercial-and-evaluationlicense key. Handsontable now reads it, and its second form, as an invalid key, which locks the grid. Deprecated the Angular wrapper'sNON_COMMERCIAL_LICENSEconstant, which holds that key. It will be removed in 20.0. #14144 - Breaking change: Removed the APIs deprecated for removal in 19.0:
saveManualColumnWidths(),loadManualColumnWidths(),saveManualRowHeights(),loadManualRowHeights(),Handsontable.helper.sanitize(), thecolumnHeadersexport option (usecolHeaders), and theSettingsandDataProviderOptionstype aliases (useExportFileSettingsandDataProviderFetchOptions). Also fixed theCollapsibleColumnsplugin warning that nested headers were missing when a sheet of the SheetsBar plugin declares them. #14182 - Removed the unused
useHeaderskey from theAutoRowSizeplugin's default settings. Nothing read it, so row sizing is unchanged, butautoRowSize.getSetting()no longer returns that key. #13239
Fixed
373 entries, too many for a GitHub release. Only the 16 breaking changes are listed here. Read the rest in CHANGELOG.md or in the documentation.
- Breaking change: Fixed autocomplete, dropdown, and handsontable arrows wrapping onto a second line next to a long value. The
autoColumnSizeplugin now measures the arrow into the column width, so existing columns of those types can grow on upgrade. Pin a column withwidth, or the grid withcolWidths, to keep the previous size. #13532 - Breaking change: Fixed
getCopyableData()returning the raw cell value, such as a number, a boolean, ornull, instead of the string its documentation and TypeScript type describe.getCopyableSourceData()still returns the stored value, and its TypeScript return type is nowunknowninstead ofstringto match. #13559 - Breaking change: Fixed
editor: falsebeing ignored by a columntypeand by checkbox cells, and added thereadOnlyStylingoption for making a grid read-only without the dimmed styling. #13584 - Breaking change: Fixed a numeric cell not right-aligning or getting the htNumeric class when it holds a non-numeric value. #13615
- Breaking change: Fixed object data with a
dataSchemaof non-nullvalues and nocolumnsoption rendering those columns blank. Each such value now creates a column property, so the columns of a schema that mixesnulland non-nullvalues change their order. #13943 - Breaking change: Fixed the TypeScript type of
dataProvider.rowIdrejecting a function, which the plugin accepts. Code that readsdataProvider.rowIdback as a string now has to narrow it. #13969 - Breaking change: Fixed removing the Ctrl/Cmd+C, Ctrl/Cmd+X, and Ctrl/Cmd+V shortcuts through the ShortcutManager, which now stops the Ctrl/Cmd+C, Ctrl/Cmd+X, and Ctrl/Cmd+V keys from copying, cutting, and pasting. Other native clipboard keys, such as Ctrl+Shift+V and Shift+Insert, are not blocked. The
gridshortcut context now lists these three shortcuts by default, sohasShortcut()andgetShortcuts()report them, and an application that removed its own Ctrl/Cmd+V by keys to get the native paste back must now remove it by group. #14054 - Breaking change: Fixed the React, Vue, and Angular wrappers so that a hook callback stops running after you remove its prop or set it to a value that is not a callback, such as
null,undefined, orfalse. #14105 - Breaking change: Fixed spilled arrays turning into #SPILL! when a sheet is added to or removed from a HyperFormula engine that the Formulas plugin created, for example when a second grid connects to it (HyperFormula 3.1.1 or later). SHEET() and SHEETS() now also update after a sheet is renamed. After a middle sheet is removed, SHEET() returns the sheet's engine number instead of its position. #14123
- Breaking change: Fixed borders added from the context menu being invisible in dark color schemes: they now use the new
--ht-custom-borders-default-colortheme variable (black in light schemes). TheircoloringetBorders()andgetCellMeta().bordersis now the CSS valuevar(--ht-custom-borders-default-color, #000)instead of#000, so read it as a CSS value, not a hex string. #14129 - Breaking change: Fixed the Dialog plugin staying enabled after
loading: falseand ignoring a laterdialog: false. The Loading plugin now requires the Dialog plugin instead of writing thedialogoption, so the Dialog plugin is on whiledialogis set orloadingis on, and off when neither holds. If you use the Dialog plugin and set onlyloading, setdialog: true. #14224 - Breaking change: Fixed a row dragged into a gap that holds hidden rows landing on either side of the hidden rows, depending on where in the gap the pointer was released. Both halves of the gap now land the row after the hidden rows, and the
beforeRowMoveandafterRowMovehooks report the resolved drop index for the lower half. See the 19.0 migration guide. #14259 - Breaking change: Fixed a validated edit being saved into another row when the rows are sorted, moved, filtered, inserted, or removed before its validator answers. The
afterChangeandbeforeChangeRenderhooks now passAppliedCellChangechanges, whose row is the record's current visual row, ornullfor a record a filter or a trim took out of the visible rows, and the row ofmodifyDataandafterValidateisnumber | null. Added thegetPhysicalRowOfChange()method, which finds the record of such a change. See the 18.1 to 19.0 migration guide. #14278 - Breaking change: Fixed
rowHeightsbeing treated as a minimum height: a row now renders at exactly the height you set, even when it is shorter than the default row height, and content taller than the row is clipped instead of stretching it. UseminRowHeightsto keep the previous behavior, where the value is a floor the content can grow past. #4021 - Breaking change: Fixed the
autocomplete,dropdown,handsontable, andmultiselecteditors' lists being cut off by the grid's edge or by a scrolling parent – the lists now open against the browser window, so every choice that fits on screen is shown. See the migration guide for the other placement changes. #8688 - Breaking change: React: Fixed the React
HotColumnprops type so it no longer suggests hook callbacks such asafterChange, which only run fromHotTable. A hook passed toHotColumnnow fails with TS7006 undernoImplicitAny. #13783