aurelia-slickgrid

Quick Summary

• This new version brings back the Slider Range Filter (see Example 23), that was dropped in 5.0.0 because of the jQueryUI removal and this new Filter got rewritten in pure JS.That required a lot of code change and while at it, I decided to improve the styling and also merge all Slider Filters into 1 class (compound, range & single) to help build size. I also decided to merge all other Compound & Regular Filters into their own single classes for the same reason. Also all options related Slider were moved inside filterOptions and/or editorOptions
• Some other great enhancements were done on the Custom Tooltip addon to help with Slider Filters/Editors, Tooltips will now receive the Slider value instantly while dragging the slider and with that you could even use the Slider without always showing the side numbers (see Example 23)
• Another great feature was to add Sorting in each group by column of Draggable Grouping (see Example 18)
• Lastly target elements were added to search events & Grid State allowing the user to know if a Compound Filter got updated by its compound operator dropdown or by its input value.

Bug Fixes

• deps: move i18next as regular dependencies to avoid fulll install (#875) (b064d81)
• deps: update dependency dompurify to ^2.4.1 (#891) (7833109)

Features

• common: add "targetSelector" to onFilterChanged & Grid State (#892) (306f247)
• core: expose EventPubSub Service on AureliaGridInstance (#879) (015bc5b)
• filters: add back Slider Range filter in pure JS (#886) (d3bff2d)
• plugins: sync column definitions to user after plugin adds column (#881) (e453905)

Installation

Please remember that all packages of @slickgrid-universal (v2.1.1) and Aurelia-Slickgrid (v5.1.1) must be updated at the same time and they will always get bumped on the same day to avoid any upgrade issues. You can also consult the Versions Compatibility Table - Wiki

please remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~90%), so most of the commits are now happening on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (above)

Quick Summary

Here is our new major (breaking change) version v5.0.0 release, it uses the new SlickGrid 3.0.0 and Slickgrid-Universal 2.0.0 which dropped jQueryUI requirement. Since we removed jQueryUI, we had to find replacement for the jQueryUI Autocomplete and settled on the Kraaden Autocomplete 3rd party lib and that is the biggest change to the developer in this new major version (it is a small code refactoring that can be done with search and replace). If you're not using the Autocomplete, then that will be an easy upgrade for you, but it is still recommended to read the migration guide below.

⚠️ Breaking Change - Follow the Migration 5.x Guide

Bug Fixes

• demo: edit outline should follow on filter/pagination changed (#857) (7a484d6)

Features

• core: BREAKING CHANGE replace jQueryUI by SortableJS (3c2f8e3)
• deps: BREAKING CHANGE upgrade aurelia-i18n to major v4 (#828) (d992286)

Installation

Please remember that all packages of @slickgrid-universal (v2.0.0) and Aurelia-Slickgrid (v5.0.0) must be updated at the same time and they will always get bumped on the same day to avoid any upgrade issues. You can also consult the Versions Compatibility Table - Wiki

please remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~90%), so most of the commits are now happening on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (above)

⚠️ Small Breaking Change (only if you use RequireJS)

Updating to latest jQueryUI to fix an XSS security issue identified in jQueryUI, see https://blog.jqueryui.com/

• in order for us to upgrade to latest jQueryUI version we had to remove the dependency of jquery-ui-dist, that package was used because it's an all-in-one dist minified build but was created by an external user and is not the official, neither maintained, by the jQueryUI team and is now falling behind in terms of their version and is missing out these important patched security fixes, so it is preferable to switch to the official package. There is however a small breaking change (for RequireJS users only) that you need to do which is a 1 line code change and is shown below (we no longer use jquery-ui-dist), so if you do use RequireJS then you need to update your dependencies array of jQueryUI in aurelia.json

"dependencies": [
  // ...
  {
    "name": "jquery-ui",
    "path": "../node_modules/jquery-ui",
    "main": "dist/jquery-ui",
    "deps": ["jquery"],
    "exports": "$"
  }
]

Bug Fixes

• collectionAsync: hidden column does not load edit field selection (#855) (d51b806)
• deps: switch from jquery-ui-dist to the official jquery-ui (#856) (4eebd14)

Installation

Please remember that all packages of @slickgrid-universal (v1.4.0) and Aurelia-Slickgrid (v4.3.0) must be updated at the same time and they will always get bumped on the same day to avoid any upgrade issues.

Changelog 📜

For a complete picture, you should take a look at both lib change logs

please remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~90%), so most of the commits are now happening on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

Small fixes applied into Slickgrid-Universal regarding item update & also add demo on how to update Tree Data items in Example 27

Bug Fixes

• version: update to latest Slickgrid-Universal versions (#850) (b9e2364)

Installation

Please remember that all packages of @slickgrid-universal (v1.3.7) and Aurelia-Slickgrid (v4.2.4) must be updated at the same time and they will always get bumped on the same day to avoid any upgrade issues.

Enjoying the lib?

Make sure to upvote ⭐ and/or Buy Me a Coffee ☕ ... and if you already have, well thank you 😺

Cheers and Happy Coding 👨‍💻

Changelog 📜

For a complete picture, you should take a look at both lib change logs

please remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~90%), so most of the commits are now happening on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

Features

• core: upgrade to jQuery 3.6 and jQuery-UI 1.13 (#824) (342ee33)

Bug Fixes

• core: throw error when gridOptions missing in View (#788) (f57aa2b)
• deps: loosen up RxJS min version to avoid interface out of sync (1637175)
• build: use patch version when releasing from slickgrid-universal (1637175)

This new version brings a few new features and contributions, the main ones are:

• Cell/Row Selection Auto-Scroll, a new live Slickgrid-Universal - Example 17 to demo the feature (not an Aurelia demo but the code logic is the same)
• Row Dragging Auto-Scroll, check Example 16 for a demo
• All-in-one Filters Modal, see a live demo on Slickgrid-Universal - Example 7
• OData new $select and $expand options & other OData fixes, see live demo Example 5 and consult updated OData Wiki
• new Example 34, which is now the default route to demo a Real-Time Trading Platform, it also shows how fast SlickGrid really is.

Big Thanks to Contributors

Huge thanks for the following contributions

• OData contributions by @jr01

Thanks a lot 🚀

Installation

Please remember that all packages of @slickgrid-universal (v1.2.x) and Aurelia-Slickgrid (v4.1.x) must be updated at the same time and they will always get bumped on the same day to avoid any upgrade issues.

Enjoying the lib?

Make sure to upvote ⭐ and/or Buy Me a Coffee ☕ ... and if you already have, well thank you 😺

Cheers and Happy Coding 👨‍💻

Changelog 📜

For a complete picture, you should take a look at both lib change logs

please remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~90%), so most of the commits are now happening on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

Features

• demo: add new Example 34 to demo Real-time Market Trading (#690) (6c76be9)
• demo: add new Example 34 to demo Realtime Trading (#698) (7820e39)
• OData: add $select and $expand query options (#697) (5ced150), closes #588

Bug Fixes

• graphql: fix range filtering with ".." (#701) (fd37034)
• odata: fix range filtering with ".." (#700) (f9a6ac7)
• deps: remove unnecessary npm dependency (d9c37da)

⚠ BREAKING CHANGES (Slickgrid-Universal 1.x)

Follow the Migration Guide 4.x

Breaking Changes

• Slickgrid-Universal 1.x major (and stable) release, it has some Breaking Changes but should be transparent for must developers that is if you are using the default CSS theme.

If however, you use a lot of SlickGrid SASS variables (all of them were renamed to now include a $slick- prefix). If you also use a lot of the SlickGrid CSS classes directly for any of the menu plugins then you will also be impacted. in any case please review the Migration Guide 4.x

Biggest Internal Change (full SlickGrid controls/plugins rewrite)

The biggest internal change made in the lib for this version was to rewrite all of the SlickGrid controls/plugins into Slickgrid-Universal and that took a few months. Prior to this release, all of these controls/plugins were using what we can call bridges or wrappers (e.g. we had gridMenuExtension.ts for the Grid Menu that was pointing to the 6pac/SlickGrid/controls/slick.gridmenu.js with a bridge so that the lib could add our custom list of commands like "Clear Filters, "Clear Sorting", etc... that didn't exist in the core repo) now with the rewrite we can say goodbye to the bridges and we now only have 1 file which got renamed to common/extensions/slickGridMenu.ts. So what I did was to move them all into the lib but also rewrite all the jQuery code as plain JavaScript (or I should say TypeScript) and add proper unit tests for all of that.

You might ask... Does that mean we can get rid of jQuery? The answer is unfortunately still No, but we are closer than before (I would say about 60% of SlickGrid is now in plain JS code, prior to this release it was probably around 30%). What is coded in plain JS at this point are: all Editors, Filters, Controls & Plugins (there are some exceptions like AutoComplete Editor & DraggableGrouping which require jQueryUI). SlickGrid itself (and its DataView) are also still written in jQuery and that will take a lot of effort to convert.

Also with the rewrite comes a full set of new unit test suites (over 500+ new tests) and a bunch of new E2E tests (Cypress). This will now be a lot easier to maintain and we won't need to wait for a new release in both SlickGrid repo and this repo to take advantage of plugin changes & extra features. Another great thing about the rewrite is that there were a lot of duplicate code in SlickGrid plugins because every plugins had to be written as standalone (e.g. CellMenu and ContextMenu are to a very high proportion the same 1000 lines of code with the only small difference of what event is triggered to open the menu, the rest is the same), but with the rewrite in here, I removed all the duplicate code and merged a lot of independent CSS classes (that is the change that might impact you if you're using the default theme, so keep reading).

Some of the main changes

• full controls/plugins rewrite in plain JS/TS with full unit test suites
  • reconciled a lot of duplicate code for all menu plugins
  • reconciled all the menu plugins CSS classes, (headerMenu, cellMenu, contextMenu, ...)
    • if you use SASS variables or CSS directly this might impact you
• I imagine that we probably also have a smaller bundle size (but untested, see for yourself)
• there are also styling & features improvements with all the rewrite
  • you can now use both HeaderMenu and HeaderButtons on the same grid, see Example 7

Installation

Please remember that all packages of @slickgrid-universal (v1.1.x) must be updated at the same time as Aurelia-Slickgrid (v4.0.0), they will always get bumped on the same day to avoid any upgrade issues.

Enjoying the lib?

Make sure to upvote ⭐ and/or Buy Me a Coffee ☕ ... and if you already have, well thank you 😺

Cheers and Happy Coding 👨‍💻

Changelog 📜

For a complete picture, you should take a look at both lib change logs

please remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~90%), so most of the commits are now happening on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

⚠ BREAKING CHANGES

• upgrade to Slickgrid-Universal official 1.x major version
• BREAKING CHANGE: upgrade to Slickgrid-Universal official 1.x major version (#689) (1caea1a), closes #689

new Custom Tooltip plugin

This new release brings a new Custom Tooltip plugin (opt-in), it can parse [title] attributes to create regular tooltip or create your own Custom Tooltip via a Custom Formatter. You can also create Custom Tooltip for Column Headers and Column Header-Row (filters).

• new Custom Tooltip - Wiki
• animated gif
• new live Example 33

new Row Move shadow item

When using the Row Move feature, we often forget which row we started the drag/move, so by adding a shadow item (it's simply a clone of the row you're dragging with absolute position that follows the mouse position) and this makes it easier to remind the user which row exactly is being moved. This is a new flag option hideRowMoveShadow that is enabled by default (if you want to use it, then change it to false).

• demo Example 16

A reminder to everyone, this is an Open Source project and everyone is welcome to contribute (even as small as fixing a typo in a Wiki is welcome). We all gain from contributions.

Installation

Please remember that all packages of @slickgrid-universal (v0.19.0) must be updated at the same time as Aurelia-Slickgrid (v3.12.0), they will always get bumped on the same day to avoid any upgrade issues.

Enjoying the lib?

Make sure to upvote ⭐ and/or Buy Me a Coffee ☕ ... and if you already have, well thank you 😺

Cheers and Happy Coding 👨‍💻

Changelog 📜

For a complete picture, you should take a look at both lib change logs

please remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~90%), so most of the commits are now happening on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

Features

• plugin: add example for new Custom Tooltip plugin (#663) (c61e3b0)
• plugin: add row move shadow item while moving/dragging row (#664) (d4dfff7)

Fixes

v3.12.1

• extensions: add missing DI in Grid Menu (#672) (96c15bd)

Tree Data improvements

Tree Data filtering will now include children when the parent item passes its filter criteria, please note that this is different compare to previous version where it would not include children and if you still want the same behavior as before then you can use the new flag excludeChildrenWhenFilteringTree.

2x new options (flags) were created

• excludeChildrenWhenFilteringTree
• autoApproveParentItemWhenTreeColumnIsValid (which only work with excludeChildrenWhenFilteringTree: false which is default)
• animated gif demo

See the update Tree Data - Wiki for these new options and Example 28 for a live demo of all options.

New Grid Option

new grid option ignoreAccentOnStringFilterAndSort to ignore text with accent (like any Latin language) while Filtering/Sorting, see Wiki

Resizer

auto-resize feature which can now optionally use the Resizer Observer instead of (or in addition to) the window resize. This auto-resize - Wiki section shows you how to use this technique.

A reminder to everyone, this is an Open Source project and everyone is welcome to contribute (even as small as fixing a typo in a Wiki is welcome). We all gain from contributions.

Installation

Please remember that all packages of @slickgrid-universal (v0.18.0) must be updated at the same time as Aurelia-Slickgrid (v3.11.0), they will always get bumped on the same day to avoid any upgrade issues.

Enjoying the lib?

Make sure to upvote ⭐ and/or Buy Me a Coffee ☕ ... and if you already have, well thank you 😺

Cheers and Happy Coding 👨‍💻

Changelog 📜

For a complete picture, you should take a look at both lib change logs

please remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~90%), so most of the commits are now happening on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

Features

• core: use Slickgrid-Universal Pagination reusable component (#656) (4af5ac5)
• tree: demo new excludeChildrenWhenFilteringTree (#657) (0a6c8f5)

Better Backend Error Handling for Filtering, Sorting & Pagination 🚀

As the title says, this new version brings better error handling of error thrown by backend, the biggest change is that if the backend server throws an error the grid will now rollback any changes in the grid (whether it's a Sort, Filter or Pagination change). So the lib now keep a reference of the last successful change and rollback that last status and the backend query string is also rolled back if any error is thrown, so you won't be left out with an unfinished activity.

• see Example 5 for a demo of that, the last column will always throw while Sorting/Filtering & there's also an extra button to test pagination error.

Cancellable Events for Filtering, Sorting & Pagination

Also in tandem with the previous paragraph, we now also have access to cancellable events (whether it's a Sort, Filter or Pagination change).
See the list below of all 3 possible events with their associated onBeforeX event:

• Filtering (onBeforeSearchChange)
• Sorting (onBeforeSort)
• Pagination (2 events are available depending on the grid type)
  • onBeforePaginationChange (with Backend Service API)
  • onBeforePagingInfoChanged (with Local In-Memory grid)

For example

<aurelia-slickgrid on-before-sort.delegate="handleOnBeforeSort($event)" ...></aurelia-slickgrid>

handleOnBeforeSort(e: Event) {
    e.preventDefault();
    return false;
}

Installation

Please remember that all packages of @slickgrid-universal (v0.17.0) must be updated at the same time as Aurelia-Slickgrid (v3.10.1), they will always get bumped on the same day to avoid any upgrade issues.

Enjoying the lib?

Make sure to upvote ⭐ and/or Buy Me a Coffee ☕ ... and if you already have, well thank you 😺

Cheers and Happy Coding

Changelog 📜

For a complete picture, you should take a look at both lib change logs

please remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~90%), so most of the commits are now happening on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

Features

• backend: rollback on error & add cancellable events (#647) (4b28424)
• tree: add dynamicallyToggledItemState method to toggle parent(s) (#649) (7a48d2a)

Bug Fixes

• composite: calling Edit change shouldn't affect Mass-Update (#648) (c35415c)
• footer: use getFilteredItemCount to show correct item count (#651) (e93354c)
• grid: invalidate grid after setItems to re-render grid (#650) (de5a906)
• grouping: Draggable Grouping should clear preheader when called (#652) (3b7a41a)

Small Release Intro

This new release adds CSS Variables (see Wiki) and few more fixes to get Angular-Slickgrid to finally use Slickgrid-Universal, so you now have the choice to use SASS and/or CSS Variables. There's a few more changes that you can see below, including aria-label for assistive screen reader (it's not perfect, it's just a start and if anyone want to contribute please do so).

Installation

Please remember that all packages of @slickgrid-universal (v0.16.2) must be updated at the same time as aurelia-slickgrid (v3.9.2), they will always get bumped on the same day to avoid any upgrade issues.

Enjoying the lib?

Make sure to upvote ⭐ and/or Buy Me a Coffee ☕ ... and if you already have, well thank you 😺

Cheers and Happy Coding

Changelog

For a complete picture, you should take a look at both change logs

also remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~90%), so most of the commits now happen on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

Bug Fixes

• pagination: should be able to toggle Pagination (#616) (77cf111)
• tree: same dataset length but w/different prop should refresh Tree (#612) (425aa03)
• aurelia-slickgrid: reference html explicitly (#617) (25a7218)

Tree Data

this new version adds the Tree Data into the Grid State & Presets (when enabled), so you could reload the grid by saving reapplying the same Grid State and Presets (toggled items) that it was before refreshing the page. There's also some more enhancements and fixes which you can see from the list below.

Others

in this version, we converted a few of the Filters/Editors from jQuery to native. That does not mean we can drop jQuery, but it's a start, SlickGrid uses jQuery heavily so I'm not even sure if it will ever be possible to drop jQuery completely (there's also a few external libs that are jQuery libs: multiple-select.js, jQueryUI autocomplete & slider range). On the other end, this conversion might bring better performance in some areas, at least I would imagine, on single/multiple Filter & Editors with large collection.

On an unrelated news, but still noteworthy, this new version of Slickgrid-Universal will be used in the next major version of Angular-Slickgrid which is in progress and will be released in the next couple weeks. At least it's good news for me since I will finally have 1 common place for all the SlickGrid code and easier to fix bugs & add new features (it was always the goal), it's progressing well :)

Installation

Please remember that all packages of @slickgrid-universal (v0.15.0) must be updated at the same time as aurelia-slickgrid (v3.8.0), they will always get bumped on the same day to avoid any upgrade issues.

Enjoying the lib?

Make sure to upvote ⭐ and/or Buy Me a Coffee ☕ ... and if you already have, well thank you 😺

Cheers and Happy Coding

Changelog

For a complete picture, you should take a look at both change logs

also remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~90%), so most of the commits now happen on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

Features

• footer: reuse Footer Component from Slickgrid-Universal (#609) (a9a6c21)
• tree: add Tree Data as Grid State/Presets (#596) (8670544)

Bug Fixes

• demo: we should be able to move row(s) and keep selections (#587) (ac36ed7)
• formatters: shouldn't auto-add editor formatter multiple times (#595) (695eac8)
• make sure dataset is array before getting his length (6466671)
• styling: upgrade dart-sass to latest (#590) (d2af93a)

This new version brings a lot of Tree Data Optimizations and Fixes. We now also have single column resize by content (enabled in all grids)

Tree Data

• refactor flat to tree structure and vice versa to optimize speed, it seems to be ~40-50x faster 😮🚀
  • yes it is incredibly faster, especially on first page load (previous implementation of converting from flat to tree structure was quite slow, there are specific npm libs that do a much better job at doing that than my own implementation), it wasn't working with 100k rows before but now it does 💯
• there's a lot of fixes and new features, you can see all features in the new Tree Data - Wiki and demos Example 27 / Example 28
• for a complete list of all features/enhancements (30+ changes), you can take a look at this PR #567 which have checklist of all the changes

Single Column Resize (double-click / header menu)

This new feature is enabled in all grids by default (and as any other feature of the lib, there's flag to disable it too). This new action is very similar to Excel column resize, it will read through the entire dataset (max at 5k rows) and calculate what width it requires to display all the text (it's not an autofit, it's really a resize by content calculation). The feature comes from a reuse of the code that was put in place to handle an entire Grid Resize by Content that was shipped in previous version except that now we also have a single column resize (the default grid resize will always be autofit in viewport).

• available via a double-click on the resize icon handle (between 2 columns), this is quite similar to how you can resize a column in Excel
• available via a new column header menu action ("Resize by Content")
• the single column resize uses the same options as the full grid resize by content, see all the available option below (just a hint, column resizeMaxWidthThreshold is an option I often use)
• a new Resize by Content - Wiki

Resize by Content Option - Small Breaking Change

Because there were many resize options ending up in the Grid Option, I moved all of them into a new ResizeByContentOption, you can see all info in the new Resize by Content - Wiki

Installation

Please remember that all @slickgrid-universal (v0.14.1) must be updated at the same time as aurelia-slickgrid (v3.7.1), they always get bumped in versions on the same day to avoid upgrade issues.

Switch GitHub demo to Bootstrap 5

Now that Bootstrap 5 is official, I think it's a good time to switch Aurelia-Slickgrid to Bootstrap 5 and just remove the Bootstrap 3 demo (it still work but there's no need to keep the BS3 demo any longer). You can also visit the Bootstrap 4 demo. Also remember that Aurelia-Slickgrid also has different Styling Themes (see Wiki) and you can also make your own theme via all the SASS variables (feel free to contribute your theme to the lib).

Enjoying the lib?

Make sure to upvote ⭐ and/or Buy Me a Coffee ☕ ... and if you already have, well thank you 😺

Cheers and Happy Coding

Changelog

For a complete picture, you should take a look at both change logs

also remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~80%), so most of the commits now happen on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

Features

• resizer: add resizeByContentOnlyOnFirstLoad grid option (#576) (424aea4)
• resizer: add single Column Resize by Content dblClick & headerMenu (#579) (631465a)

Bug Fixes

• backend: able to preset filters on hidden columns & all queried (#582) (9953dd9)
• grid: make sure dataset is an array before passing it to dataview (bfd8344)
• presets: loading columns presets should only be done once (#577) (91d0ea6), closes #341
• resizer: fix a regression bug caused by previous PR (#580) (95185f0)
• resizer: remove delay to call resize by content to avoid flickering (#578) (1661c7e)
• sorting: multi-column sort shouldn't work when option is disabled (#581) (e752b2c)
• tree: few issues and huge improvement found in Tree Data (#567) (0febdf0)
• build: target es2017 instead of es2018 to fix aurelia-cli/requireJS (7eeff02)

The biggest feature is this release is probably the Resize Columns by their Content (that is an opt-in feature since it requires cpu cycle to parse through the dataset to calculate width of each column).

• Example 32 - Resize by Content (toggle between the 2 buttons to see the resize differences)
• Resize by Content - Wiki

There's also Row Selection Count that is now showing in the Custom Footer (unless you already have left footer text, if so it won't override it). The grids with colspan were also not exporting correctly and now they do (that is related to reading the item metadata)... there's a few other things, just see the full list below. You can also now filter empty values on the single/multipleSelect Filter (see Wiki)

Installation

Please remember that all @slickgrid-universal (v0.13.0) must be updated at the same time as aurelia-slickgrid (v3.6.0), they always get bumped in version on the same day to avoid upgrade issues.

• For SystemJS users, you might need to update your dependencies section in your aurelia.json file. We are now using dequal lite version, so you might need to simply rename the package dequal to "name": "dequal-lite" and you should be good to go

Direct Link to Example Components

Also note, every Example now have a direct link to each Component TypeScript file, the link will be on the far right BS4+ (or beside the title in BS3). This will be much quicker to find the associated code of the Example ViewModel Component you're looking at.

Enjoying the lib?

Make sure to upvote ⭐ and/or Buy Me a Coffee ☕
... and if you already have, well thank you 😺

Cheers

Changelog

For a complete picture, you should take a look at both change logs

also remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~80%), so most of the commits now happen on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

Features

• footer: add row selection count to the footer component (#563) (dcf61f6)
• resize: add column resize by cell content (#560) (f5211c3)

Bug Fixes

• deps: remove unused npm packages reported as security risk (#562) (12e420a)

This new release brings a few nice new Features the most notable are the following

• add optional filterTypingDebounce for filters with keyup (mainly default Text Search Input and its Compound version), this will help users dealing with huge dataset, add a debounce/throttle should speed up the search since it will query only after user pauses typing
• add Pinning (frozen cols/rows) to the Grid State & Grid Presets
  • you can give it a try in the Example 15, you can freeze a column from the Header Menu and then refresh the Page and expect to see the Pinning remain after page reload
• a new optional Slickgrid-Universal RxJS-Observable package to optionally work with RxJS Observables (typically with a Backend Service like OData/GraphQL) instead of Promises.
  • take at the new Example 31 demonstrating this
• the tsc build is now also processed in TypeScript strict mode which might help in getting a smaller build
  • also to be clear, both libs (Aurelia-Slickgrid & Slickgrid-Universal) now have strict mode enabled
• and a few other things, check the list below...

Special Thanks

Contributions are always welcome, thanks to @ArnaudVanHerck for contributing to this release.

Enjoy it

Enjoying the lib? Make sure to upvote ⭐ and/or Buy Me a Coffee ☕
... and if you already have, well thank you 😺

Cheers

Changelog

For a complete picture, you should take a look at both change logs

also remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~80%), so most of the commits now happen on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

Features

• build: compile build with TSC strict mode enabled (#539) (483c4ba)
• filters: add optional filterTypingDebounce for filters w/keyup (#538) (66e7cfc)
• resources: add RxJS support via Slickgrid-Universal package (#541) (9c01edc)
• state: add Pinning (frozen) to Grid State & Presets (#543) (cbd07d2)

Bug Fixes

• metrics: use onRowCountChanged event to refresh metrics (#544) (2f16407)
• resizer: allow gridHeight/Width to be passed as string, fixes #284 (#535) (f324071)
• tests: add Cypress tests to cover grid presets (#542) (ec24aed)

As the title suggest, this new release brings a few improvements in terms of performance. especially in the following 3 areas

1. there was a contribution, in this PR, pushed on the SlickGrid (core) lib to improve batching (insert/edit/delete) and so I also made the changes in the Grid Service to take advantage of them in the following methods (addItems, updateItems and deleteItems)
   • the test done in SlickGrid (core) was executed by inserting 100k rows in a grid (before: 1100ms vs after: 200ms)
2. date sorting is now 2x times faster (check full test logs in the PR)
   • on 50k rows with sorting 1 date column, before 1981.27ms and after 903.99ms => 2.1x faster
3. date filtering is now between 4x to 6x times faster (check full test logs in the PR)
   • all type of filters might benefit but the date is the biggest perf boost
   • on 50k rows with filtering 1 single date column, before 1471.19ms and after 246.01ms => 6.1x faster
   • on 50k rows with filtering 1 date range column, before 2695.77ms and after 591.40ms => 4.4x faster

You first reaction might be... how did you gain so much perf boost?
It all started when I was looking at where MomentJS is used in the lib, then I noticed that the Date sorting is actually parsing to a MomentJS object twice (1x for validating the date and 1x for the actual date) but that could be improved to do it in 1 parsing execution (use the same moment object to call momentDate.isValid() and then just use it for the sorting diff)... so with that done, I decided to take a look at date filtering to also avoid double parsing, but what I ended up finding, was that were being double parsed and worst than that, it was re-parsing the search values on every single cell value comparison (in other words if we have 50k rows, it was double-parsing the date in the search value 50k times and double-parsing the cell value 50k as well... so when it was supposed to compare and parse 50k rows + 1 time parsing for search value, it was in fact parsing over 4 times that which was about 200k parsing instead of 50k + 1 row... hence the perf boost between 4-6x faster). You can try it yourself, go over the GitHub demo page on Example13 and/or Example 18 then click on "50k rows" and test it out for yourself. If you are dealing with couple thousand rows, you might not notice the difference but make that 25,000 or 50,000 rows and you will surely notice the boost 🚀

Enjoy it

Enjoying the lib? Make sure to upvote ⭐ and/or Buy Me a Coffee ☕
... and if you already have, well then thank you 😺
Cheers

Changelog

For a complete picture, you should take a look at both change logs

also remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~80%), so most of the commits now happen on that side.

1. review the Slickgrid-Universal changelog
2. and the Aurelia-Slickgrid changelog (below)

Features

• editors: add form/input reset to Composite Editor modal & fix touched value (#529) (9c17ba5)
• filters: add updateSingleFilter for a single external filter (#526) (9abf86d)

Bug Fixes

• backend: incorrect item count with GraphQL and useLocalFiltering (#524) (24f5a2e)
• deps: update typedoc to fix marked package security issue (3c7125b)
• deps: update typedoc to fix marked package security issue (#523) (2ac1780)
• examples: multiple grids in tab should show be resized (#525) (daa0ea4)
• plugin: recreate header menu when adding column dynamically (#522) (7e82343)

This new release brings a few fixes and most importantly an addition to the Composite Editor - Clone Item (which allows copying a row with possible edits before cloning). There's also a brand new Composite Editor - Wiki with full details on how to use Composite Editor (which now allows you to do the following 5 actions: create/clone/editor/mass-update/mass-selection)

Like the lib?

If you like the lib, please upvote ⭐ and/or Buy Me a Coffee ☕

Changelog

For a complete picture, you should take a look at both change logs

also remember that Slickgrid-Universal monorepo now contains the biggest portion of the code (~80%), so most of the commits now happen on that side.

1. the Slickgrid-Universal changelog
2. the Aurelia-Slickgrid changelog (see below)

Features

• editors: add Clone functionality to Composite Editor (#510) (6eb972b)
• formatters: add grid option to auto add custom editor formatter (#512) (7952a5e)

Bug Fixes

• comp: empty data warning should work with autoheight grid (#507) (9d31098)
• filters: Grid State filters should always include an operator (6c989c2)
• metrics: refresh metrics also when providing new data to DataView (#508) (2ce3bfc)
• metrics: use onRowsOrCountChanged to refresh metrics (#509) (9df5974)
• plugins: throw error when Tree Data used with Pagination (#506) (92789fc)
• components: Composite Editor Clone was sometime throwing error (#513) (c284799)

Main Changes

• a new collectionOverride for the Select Editor (single/multiple) and the AutoComplete Editor which allows to change the collection per cell clicked (see Collection Override - Wiki
• add Bootstrap 5 support and a new demo, Aurelia-Slickgrid-Demos - Bootstrap 5
• OData Service fixes to better handle filter ranges & decimals
• following the OData changes, these were also applied to the GraphQL Service
• a few Tree Shakable enhancements were made
  • external SlickGrid plugins are no longer imported via require(plugin), which was not Tree Shakable, they are now imported the more natural way via import(plugin) which is Tree Shakable
  • I also found out that all the Flatpickr Locales were being imported (also because of require(flatpickr/locale), you need to see the breaking change below.

Breaking Change (Flatpickr Localization)

As mentioned in previous paragraph, I found out that all the Flatpickr (date picker) Locales were all being imported (over 60 locales) and ended up in the bundle/build, so in order to fix that we now ask the developer (you) to import whichever Flatpickr Locale you need via your main.ts (after loading Aurelia-Slickgrid plugin), if you omit/forget to do this, it will display a console warning and revert to English. There's also a console warning to tell you when you forget to import the locale properly, worst case is that you'll see English being used instead of the expected locale.

• more info in this Wiki Flatpickr Localization

Final Note

If you like the lib, please upvote ⭐ and/or Buy Me a Coffee ☕

Features

• ci: replace CircleCI by GitHub Actions (#492) (c7600e0)
• editors: add Column Editor collectionOverride option (#228) (91421fc)
• styling: add support for Bootstrap 5 (#226) (e35f116)

Bug Fixes

• build: import Flatpickr Locale on demand via regular imports (#504) (78239b6)
• plugin: Row Detail loses html content when used with Row Selection (#503) (5e3d067)
• backend: GraphQL queries with input filter (#217) (ff7f1e5)
• backend: OData queries with input filter (#224) (fec1ce8)

This version adds Collection Watch for Autocomplete, SingleSelect & MultipleSelect Filters, this feature already existed in previous version and was the last missing feature from Aurelia-Slickgrid 2.x, more info can be found under the Select Filter - Collection Watch - Wiki. Other fixes were also done for RequireJS, it now properly auto-register all Slickgrid-Universal dependencies without any mapping in aurelia.json file. Also note that you won't see a huge list of changes here anymore since most changes happen in the Slickgrid-Universal library.

Wrapped just in time for the holidays 🎁🎄

If you like the lib, please upvote ⭐ and/or Buy Me a Coffee ☕

Cheers all

Features

• core: add Autocomplete/Select Filters collection watch (#488) (612fb68)

Bug Fixes

• core: use regular imports instead of require to load plugins (#489) (0f6ae07)

Hey guys, I made a mistake and ended up pushing version 3.0.0 when it was supposed to be a Beta, so it's pretty much released now haha. Please read the info that was provided in previous 3.0.0 Alpha for more info on the why and such

The biggest changes are the following

• it now uses a central monorepo library Slickgrid-Universal
• it should also have a smaller bundle size (because it uses a monorepo, you can now choose what to install and not install)
  • a few Services are now opt-in to make smaller builds (Excel Export, Text Export, OData and GraphQL)

There are new Features as well, the biggest and most useful Feature is

• Composite Editor which allows you to Create, Update, Mass Update & Apply Mass Changes on Selected Rows
  • Check out the new Example 30
• SlickGrid and DataView objects are now have full Typing specs
  • Make sure to use the new interfaces SlickGrid and SlickDataView whenever you deal with these objects (there's also SlickNamespace for the entire SlickGrid namespace that includes controls, plugins, dataview, ...)

To get started, make sure to follow the Migration Guide. Also note that not all Wikis have been updated yet (since this version was released by mistake) but will be in coming days (it should be updated now and if you spot any problems please let me know by opening an issue). For now, your best bet is to follow the migration and/or clone the Aurela-Slickgrid-Demos was is already updated

Migration Guide to 3.x

Minimum Requirement Changes

• TypeScript >= 4.1.2
• Aurelia-I18N >= 3.0.0
• Aurelia-CLI >= 2.0.0
• Bootstrap or any other UI framework like Bulma
  • for Bootstrap, it is recommended to use 4.5.x as I won't be supporting 3.x for much longer

Version 2.x is now partially out of support

Since I'm a team of 1 person (myself @ghiscoding), I won't be supporting the older version 2.x much longer unless there's are small bug fixes to do. I still have a 2.x branch which I can update but I would prefer to only do work on version 3.x.