Skip to content

Migration ​

This page lists changes compared to the previous (unreleased) version of the grid. It is only relevant if you have used the grid before.

Component ​

BeforeNow
@unitable="api => ..."@ready="api => ..." (unitable still works, it is emitted directly after mounting)
v-model:sortedColumns contained column uidscontains column ids ({ column: "name", asc: true }); uids are still accepted as input
v-model:columnFilter contained column uidscontains column ids
events prop with core callbacksstill supported; prefer the component events (@cell-click, @selection-change, …)
editor overlay was positioned over the gridthe editor is rendered inside the cell
styles imported automatically from the sourceimport @datagrid/vue-ui/style.css when using the published package

Core ​

BeforeNow
getValue(column, item, true) returned the formatted valuegetValue(column, item) returns the raw value, use getText(column, item) or getFormattedValue(value, column, item)
default locale "de"default locale "en", use options.locale: "de"
options.rowHeight was ignoredrowHeight sets a fixed row height; if it is not set, rows are measured (previous behavior)
row uids were strings ("0", "1")row uids of top level rows are numbers (0, 1) if no rowId is set, strings are still accepted by all API methods
column ids could be numberscolumn ids are always strings (numbers are converted)
filter column option: function (value, filterValue) => booleanunchanged, the function additionally receives the row as third parameter; typed filters are used if no function is set
sorting toggled asc → desc → none and kept other sorted columnsclicking a header sorts only this column, hold Shift for multi sort (configurable with multiSortKey)
valueSetter had to mutate the datait can additionally return false to signal that nothing changed
setGroup, expandAll, collapseAll only handled tree rowsalso handle group rows

Removed ​

  • VirtualList component and useVirtualScroll composable (moved to the example app, they were not part of the grid)
  • Search and Footer components (unused)
  • the IDatasource/ExternalDatasource classes (replaced by the dataGetter option)

Released under the ISC License.