v4.6.2

4.6.2 (2024-03-23)

Quick Info

This release upgrades multiple-select-vanilla package, that I also maintained, with a much more modern UI with the use of SVG icons. The SVG icons in that external lib are now also written in pure CSS which helps for Dark Mode (in that mode, the primary color for checked icon is a lighter version of the primary color). Note however that the SVG icons in Slickgrid-Universal are not yet pure CSS since that would introduce breaking changes in Slickgrid-Universal (a new major version will be pushed later on to address that).

⚠️ Custom Editor/Filter should not be newed

Please note that Custom Editor/Filter should never be newed even though the documentation previously said otherwise, this has been corrected in this release via an update on the Column interface, so if you have any of them instantiating that way then please fix them to avoid build errors.

// same goes for Custom Filter
editor: {
  // reference your custom editor class without instantiating it
-  model: new CustomInputEditor()
+  model: CustomInputEditor 
},

⚠️ internalColumnEditor is deprecated and no longer needed

Note that in the past, SlickGrid and Slickgrid-Universal/Slickgrid-React were using 2 different references for editor. The original SlickGrid was using editor as a Class to be later instantiated (e.g. Editors.longText) but that wasn't very convenient for the end users (you). For that reason I decided a long time ago to take this editor and reassign to another ref named internalEditor and then SlickGrid kept using editor (read from editor.model) and whenever the user wanted to read the SlickGrid editor after the grid was initialized, the user would have to get it from column.internalEditor (because after the initialization editor is SlickGrid's internal editor class not the one provided by the user), but that was so damn confusing... but now that Slickgrid-Universal is a standalone (no longer relying on 6pac/slickgrid) I decided to get rid of this confusion, so with this new release the editor remains the same to the user but the one used by SlickGrid just got renamed to editorClass. So in summary, editor is the same for the end user and editorClass is what is defined by model: Editors.longText and the internal ref swap that Slickgrid-Universal/Slickgrid-React was previously doing is no longer needed internally. Below is an example of when that would be in use

// previously, to add an item to the editor/filter collection 
this.columnDefinitions = [{ id: 'complexity', editor: { model: Editors.singleSelect, collection: [{ value: 1, label: 'Simple' }, /*...*/ ]; }];
// then adding an item would require to read `internalColumnEditor` 
// after grid init, our `editor` became `internalColumnEditor
- const complexityEditor = this.columnDefinitions[0].internalColumnEditor; 
// BUT with this new release, adding a new item to the collection is as simple as 
+ const complexityEditor = this.columnDefinitions[0].editor; 
complexityEditor.collection.push({ value: 9, label: 'Hard' });

// and if you want to read the SlickGrid editor, you would now use
this.columnDefinitions[0].editorClass; // which is the same as `editor.model`

Bug Fixes

• Filter model is now FilterConstructor and shouldn't be newed (#310) (5f3f765)
• hide Toggle Dark Mode from Grid Menu by default (#308) (074f07e)

Features

• rename SG editorClass & deprecate internalColumnEditor (#309) (47ffd2f)

Bug Fixes

• invalid types exports (5ea0e19)

v4.5.0 - Dark Mode

4.5.0 (2024-03-05)

Dark Mode ✨

This is probably a UX change that many users will be happy to start using, however there are a few important notes to be aware of as shown below.

• Dark Mode must be enabled via a darkMode grid option, it will not auto-detect the color scheme from the browser (you can however easily do it yourself). There are a couple of reasons as to why it was created as a grid option, it's mostly related to the fact that a few features in the lib require the creation of certain DOM Elements that are appended to the body (e.g. ColumnPicker, GridMenu, LongTextEditor, CompositeEditorModal, ...) and it requires extra code in place that SlickGrid will take care of it for you but can only work via a grid option, and for that reason it simply cannot be just simple CSS classes.
• SVG icon color are using a lighter gray by default, if you're using a Font family for the icons then that won't affect you however keep reading. As mentioned earlier, the SVG icons are using a light gray and that is because the same color must be used for both Light & Dark theme because at the moment the project will create the SVG with a fixed fillColor defined in SASS and once it is set, you cannot change it... you might ask, well can that be fixed in the future? The answer is Yes but... I did find that we can convert all SVG to pure CSS (using UnoCSS, by AntFu) approach but that will introduce some breaking changes and considering that I recently released a major version, I will wait couple more months to proceed with another major. Part of the breaking changes will be to drop support for Fonts and keep only SVGs internally in a future major release.
• the Dark Mode Theme was created using CSS variables, you might need to tweak some of these variables depending on your primary color, see Slickgrid-Universal CSS variables
• also note that I'm not a Designer, so if you feel that some colors are off then please contribute a PR
• for more info read the Dark Mode documentation
• you can see Dark Mode demo in Example 1, Example 24 and Example 30. All of these examples have a Toggle Light/Dark Mode button and the Example 1 also has the extra browser auto-detect Dark Mode on the 1st grid only.

Also worth knowing that I also improved multiple-select-vanilla by adding a new feature to replace tabIndex by arrow navigation highlight. This feature will let you use the keyboard (up/down arrows or mouse hover) to navigate the select options and choose any of them (via Enter key) and all of that without losing your current focus (which is a lot better than using tabIndex). This new feature should be a lot more UX friendly.

This is pretty much completing the roadmap of all the features that I wanted to add to this library, the first project started 7 years ago and I added a lot of new features over the years.

Bug Fixes

• add extra conditions to help strict mode (#302) (8b4d1f6)
• remove width style on grid container for CSP safe (#306) (529abab)

Features

• add Dark Mode grid option (#305) (d4bfdd1)

---

Installation

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

v4.4.1

4.4.1 (2024-02-13)

Quick Info (Excel Export)

this new release is mainly targeting @slickgrid-universal/excel-export 🚀

We are migrating from excel-builder.js to a new fork Excel-Builder-Vanilla, the approach is a very similar to what I have done previously with multiple-select-vanilla, which is to create new forks of the project, and it is all about modernizing the project. This migration brings a lot of goodies by using this new Excel-Builder-Vanilla, it was rewritten in TypeScript, dropped Q (replaced by regular Promise), dropped Lodash (now uses native code) and finally replaced JSZip with fflate which itself also has an ESM build giving us Tree Shaking and it is also giving us better perf by using Web Workers (when using CSP, you might need to adjust your CSP rules). Why the switch? The reason is mainly to be ESM ready because technologies are evolving and ESM is really the future (the next release of ViteJS is also expected to drop CJS (CommonJS) support). The switch has other benefits too, the most noticeable one being the large decrease of its build size (that is because we dropped Q and Lodash).

You might be wondering, why not switch to a more popular library like SheetJS or ExcelJS? Well, believe or not, all these projects are still written as CJS with no foreseeable support to ESM builds. For that reason you cannot take advantage of proper Tree Shaking which mean that whoever rely on these projects, are in fact downloading their entire (large) library and all their dependencies. We certainly don't need all of these features (ie: we only want to build an Excel, not read it), all we need is to export to Excel and this is exactly what Excel-Builder-Vanilla is giving us in an ESM build and it is also extremely small since it's only targeting Excel file creation. 🏗️

Below are the migrating advantages to Excel-Builder-Vanilla

• rewritten in TypeScript (providing us with TS Types (d.ts)
• dropped very old dependencies that are no longer necessary (Q and Lodash)
• switched from JSZip to fflate (has ESM support with Tree Shaking and also better perf by using Web Workers)

No breaking change, the changes required were all internal and are totally transparent to the developers because the API is exactly the same as before, the only difference will be your build size decrease ;)

For a very customized view of what you can do with Excel-Builder, take a look at the Slickgrid-Universal Example 2, try to group by any column and then Export to Excel to see the very customized Excel output.

Note that if you had a JSZip path defined in your tsconfig.json, you can now remove it. that is because we migrated to fflate and it doesn't require any special config.

{
  "compilerOptions": {
-    "paths": {
-      "jszip": [
-        "node_modules/jszip/dist/jszip.min.js"
-      ]
-    }
  }
}

Bug Fixes

• update to latest Slickgrid-Universal v4.4.1 (e06f669)
• demo: change trading demo full screen z-index lower than ms-select (7761265)

Features

• ExcelExport: migrate to Excel-Builder-Vanilla (ESM) (#297) (87226d0)

---

Installation

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

v4.3.1

4.3.1 (2024-01-27)

Performance Improvements

• decrease number of calls to translate all extensions only once (#290) (89ddb41)

v4.3.0

4.3.0 (2024-01-21)

Quick Info

This release brings some great new features, the most interesting one was contributed by @zewa666 which is a new Row Base Editing. The Row Based Edit plugin allows you to edit either a single or multiple specific rows at a time, while disabling the rest of the grid rows. See our new Example 35 and new Row Base Editing docs.

Another great but smaller feature is a new reorderable column option to help lock a column in place (for more info see Slickgrid-Universal PR which include a small animated gif of the feature). Note that this feature is better when used with column position as first or last columns in the grid.

⚠️ Warnings

I did add and set reorderable: false to the following 4 plugins, they can all be overriden when instantiating the plugin via their respective options

• Checkbox Selector Column (Row Selection)
• Row Detail
• Row Move Manager
• Row Base Editor

---

Features

• plugin: new Row Based Editing (#289) (ac3218d)

Performance Improvements

• resizer: autosizeColumns is called too many times on page load (#283) (329555f)

---

Installation

Please remember that all packages of @slickgrid-universal (v4.3.0) and Slickgrid-React (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.

v4.2.0

4.2.0 (2023-12-30)

Quick Info

This release brings some perf improvements and also completes the CSP Safe implementation, there was 1 last DataView function that was not yet converted to be CSP Safe and now it is (don't forget to use the new useCSPSafeFilter if you also use the DataView). There is also a new CSP Compliance documentation that you can read.
Lastly a few other small features and fixes were pushed, see below. Happy Holidays 🎁

---

Features

• update Slickgrid-Universal with perf improvements (#279) (a157905)

---

Installation

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

v4.1.0

4.1.0 (2023-12-21)

Bug Fixes

• publish src folder for source maps, fixes #273 (#274) (18a8909)

Features

• reimplement highlight row, node-extend & fix few issues (#275) (e29842a)

---

Installation

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

v4.0.2

4.0.2 (2023-12-16)

⚠️ BREAKING CHANGES

• migrate to Slickgrid-Universal v4.0 new major version (#269) (e3b71e7)

Quick Info

This new release is merging SlickGrid into the project and is dropping the previous external 6pac/slickgrid dependency. The aim of this release is to be standalone, improve best practices & move towards CSP compliance while also making the project leaner. Merging SlickGrid into the projects has a few benefits, the biggest are (easier to troubleshoot, drop unused code, deduplicate code like DOM utils, decrease external dependencies usage and finally a small decrease in build size).

Another great feature in conjunction with this release is a new Documentation website powered by GitBook. This should be more pleasing to read and also easier to receive documentation changes (note that because of the changes from Wiki to GitBook, some of the links might be invalid and if you find any then please submit a PR).

Read the Migration to 4.0 for all the changes

Bug Fixes

• deps: update all Slickgrid-Universal dependencies (0795026)
• regression from PR #262, read external resource when required (dcf01e4)

---

Installation

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

v3.6.5 - invalid version

3.6.5 (2023-12-15)

THIS IS AN INVALID VERSION - Release-it made a totally invalid bump recommendation and thought it was a minor version even though I had a BREAKING CHANGE PR.

Please ignore this version, it was supposed to be v4.0

v3.6.4 - deprecated Formatters

3.6.4 (2023-12-13)

Please note that multiple built-in Formatters are now deprecated and will be removed in the next major version (which is coming very soon). Below is the list of Formatters and their alternatives with code sample on what to change. Note that the CSS class may vary depending on which UI framework you use.

Formatter removed	cssClass equivalent	alternative
Formatters.bold	cssClass: 'text-bold' or fw-bold
Formatters.center	cssClass: 'text-center'
Formatters.italic	cssClass: 'text-italic' or fst-italic
Formatters.alignRight	cssClass: 'text-right' or text-end
Formatters.lowercase	cssClass: 'text-lowercase'
Formatters.uppercase	cssClass: 'text-uppercase'
Formatters.fakeHyperlink	cssClass: 'text-underline cursor'	cssClass: 'fake-hyperlink'
Formatters.checkbox	to be removed	use the Formatters.iconBoolean
Formatters.deleteIcon	to be removed	use the Formatters.icon (see below)
Formatters.editIcon	to be removed	use the Formatters.icon (see below)
Formatters.infoIcon	to be removed	use the Formatters.icon (see below)
Formatters.yesNo	to be removed	create a custom Formatter

The alternative is to use cssClass as shown below

this.columnDefinitions = [
  { 
    id: 'firstName', name: 'First Name', field: 'firstName',
-   formatter: Formatters.bold
+   cssClass: 'text-bold'
  },
  { 
    id: 'lastName', name: 'Last Name', field: 'lastName',
-   formatter: Formatters.multiple, params: { formatters: [Formatters.uppercase, Formatters.bold] },
+   cssClass: 'text-uppercase text-bold'
  },
  {
    id: 'deleteIcon', name: '', field: '',
-   formatter: Formatters.deleteIcon, 
    // NOTE: we previously accepted "icon" and "formatterIcon" property in the past but these props will be removed
+   formatter: Formatters.icon, params: { iconCssClass: 'fa fa-trash pointer' }
  },
];

---

Installation

Please remember that all packages of @slickgrid-universal (v3.7.2) and Slickgrid-React (v3.6.4) must be updated at the same time and they will always get bumped on the same day to avoid any upgrade issues.

please remember that Slickgrid-Universal monorepo 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 Slickgrid-React changelog (above)

Bug Fixes

• devMode can be false/object & use !important on text CSS utils (#270) (66576ee)