Skip to content

Deprecation policy

This page explains how Handsontable DataGrid handles deprecated APIs — including the grace period before removal and how you will be notified.

Deprecation occurs when better alternatives emerge that offer improved performance, security, or usability compared to existing implementations. It also helps maintain API consistency by removing redundant or inconsistent functions, creating a cleaner overall design. As web standards and the JavaScript ecosystem evolve, certain approaches become obsolete or suboptimal, requiring updates to stay current. Additionally, deprecation reduces maintenance complexity by phasing out rarely-used or problematic features, while addressing potential security vulnerabilities in older implementations. Rather than introducing breaking changes, deprecation provides a gradual migration path that gives developers time to adapt while clearly signaling the library’s future direction.

After a Handsontable feature, a framework wrapper or any other part of the API is marked deprecated, we commit to a grace period (at least 3 months) during which the deprecated feature still works. We will not remove the feature immediately in the next minor or patch release. Instead, removal is deferred until a future major release, in accordance with semantic versioning.

Support

During the deprecation period:

  • We will fix critical bugs and security vulnerabilities in the deprecated feature.
  • We will not add new enhancements for deprecated APIs.
  • Full stability and long-term support are guaranteed only within LTS releases.

Relation to LTS

Handsontable follows a Long-Term Support (LTS) model, where every even-numbered major release becomes an LTS release with ~30 months of support. For more details, please visit Long Term Support.

Deprecation notifications

We will announce deprecations and removals through release notes accompanied by blog posts. Additionally, deprecated features may show console warnings in development builds. Deprecated APIs will be clearly marked in our documentation with a recommended alternative (if possible).

For significant deprecations (especially those affecting many users), we will provide dedicated Migration Guides.

For more details about our versioning policy please visit Versioning policy

Removed in version 19.0

APIs

RemovedDeprecated inReplacementMigration guide
saveManualColumnWidths() and loadManualColumnWidths() (ManualColumnResize)18.0None. Both do nothing and log a deprecation warning. Persist widths in your application code, and restore them by passing an array to manualColumnResize.Migrate from 18.1 to 19.0 -> Removed deprecated APIs
saveManualRowHeights() and loadManualRowHeights() (ManualRowResize)18.0None. Both do nothing and log a deprecation warning. Persist heights in your application code, and restore them by passing an array to manualRowResize.Migrate from 18.1 to 19.0 -> Removed deprecated APIs
Handsontable.helper.sanitize()18.0The sanitizer option. The helper returned its input unchanged since 18.0.Migrate from 18.1 to 19.0 -> Removed deprecated APIs
columnHeaders (export options of the exportFile plugin)17.1colHeaders — rename the key; the value keeps its meaning.Migrate from 18.1 to 19.0 -> Removed deprecated APIs

TypeScript types

RemovedDeprecated inReplacementMigration guide
Settings (exported from handsontable/plugins/exportFile)18.0ExportFileSettingsMigrate from 18.1 to 19.0 -> Removed deprecated APIs
DataProviderOptions (exported from handsontable/plugins/dataProvider)18.0DataProviderFetchOptionsMigrate from 18.1 to 19.0 -> Removed deprecated APIs

Removed in version 18.0

Dependencies

The following dependencies were deprecated in version 17.0 and removed in version 18.0.

RemovedDescriptionMigration guide
numbro.jsHandled numeric data formatting. Replace with Intl.NumberFormat.Migrate from 17.1 to 18.0 -> Numeric formatting
PikadayDisplayed a date picker. The intl-date cell type now uses the native browser date picker.Migrate from 17.1 to 18.0 -> Date/Time
moment.jsParsed, validated, and displayed dates. The intl-date and intl-time cell types use the native Intl.DateTimeFormat API.Migrate from 17.1 to 18.0 -> Date/Time
DOMPurifyAn XSS sanitizer for HTML. Use the sanitizer option to provide your own sanitizer function.Migrate from 17.1 to 18.0 -> HTML sanitization

APIs

RemovedDeprecated inReplacementMigration guide
correctFormat and datePickerConfig options17.0valueParser and valueSetterMigrate from 17.1 to 18.0 -> correctFormat option
numericFormat.pattern and numericFormat.culture17.0Intl.NumberFormat options and the locale optionMigrate from 17.1 to 18.0 -> Numeric formatting
handsontable/common import subpath— (not in the API reference)handsontable, handsontable/base, or handsontable/settings, depending on the type. Four types are removedMigrate from 17.1 to 18.0 -> Imports

Removed in version 17.0

APIs

RemovedDeprecated inReplacementMigration guide
PersistentState plugin, its persistentState option, and the persistentStateSave, persistentStateLoad, and persistentStateReset hooks16.1Persist state in your application code. The saveManualColumnWidths(), loadManualColumnWidths(), saveManualRowHeights(), and loadManualRowHeights() methods that relied on the plugin were deprecated in 18.0 and removed in 19.0 (see Removed in version 19.0).Changelog 17.x
hot.undo(), hot.redo(), hot.clearUndo(), hot.isUndoAvailable(), hot.isRedoAvailable(), and hot.undoRedoBefore 16.0hot.getPlugin('undoRedo')Changelog 17.x

List of current deprecations

The following APIs and behaviors are deprecated. They keep working and print a one-time console warning. The Removal column names the version that drops each one.

Behaviors

DeprecatedDeprecated inRemovalReplacementMigration guide
Writing past the last column of an object data source, which adds a property named after the column index19.020.0setDataAtRowProp()Migrate from 18.1 to 19.0 -> Writing past the last column

Methods

DeprecatedDeprecated inRemovalReplacementMigration guide
registerShortcuts() (Formulas)19.020.0No-op. The Alt+Enter shortcut that opens a cell’s link is a core grid shortcut. Remove the call.Migrate from 18.1 to 19.0 -> Formulas shortcut methods
unregisterShortcuts() (Formulas)19.020.0No-op. The Alt+Enter shortcut that opens a cell’s link is a core grid shortcut. Remove the call.Migrate from 18.1 to 19.0 -> Formulas shortcut methods
spliceCol() (Core)19.020.0Read the column, splice it, and write it back with populateFromArray(); or use alter() for whole columns.Migrate from 18.1 to 19.0 -> spliceCol and spliceRow
spliceRow() (Core)19.020.0Read the row, splice it, and write it back with populateFromArray(); or use alter() for whole rows.Migrate from 18.1 to 19.0 -> spliceCol and spliceRow
getStartMostColumnIndex() (MergedCellsCollection)19.020.0None. The selection steps over merged cells by itself. Remove the call.Migrate from 18.1 to 19.0 -> MergedCellsCollection methods
getEndMostColumnIndex() (MergedCellsCollection)19.020.0None. The selection steps over merged cells by itself. Remove the call.Migrate from 18.1 to 19.0 -> MergedCellsCollection methods
getTopMostRowIndex() (MergedCellsCollection)19.020.0None. The selection steps over merged cells by itself. Remove the call.Migrate from 18.1 to 19.0 -> MergedCellsCollection methods
getBottomMostRowIndex() (MergedCellsCollection)19.020.0None. The selection steps over merged cells by itself. Remove the call.Migrate from 18.1 to 19.0 -> MergedCellsCollection methods
iconsMap() (handsontable/themes/static/variables/helpers/iconsMap)19.020.0iconStyles(icons, scopeSelector) from handsontable/themes/static/variables/helpers/iconStyles. iconsMap() already returns its output.Migrate from 18.1 to 19.0 -> Icons are rendered as <i> elements

Language codes

DeprecatedDeprecated inRemovalReplacementMigration guide
Language code sr-SP (sr-SP.js, srSP)19.020.0The sr-Latn-RS language code (sr-Latn-RS.js, srLatnRS). The phrases are the same.Language

Constants

A constant does not print a console warning. Your editor shows it as deprecated.

DeprecatedDeprecated inRemovalReplacementMigration guide
NON_COMMERCIAL_LICENSE (@handsontable/angular-wrapper)19.020.0Your own license key, passed as license in HOT_GLOBAL_CONFIG. The key the constant holds reads as invalid since 19.0.Migrate from 18.1 to 19.0 -> The non-commercial-and-evaluation license key