6.0.0 (#810)

Glide Data Grid 6.0.0

## 🚨 Breaking Changes

### New dependency
 
- canvas-hypertxt bumped to 1.0.3
- @linaria/react now added as dep (extremely tiny)

### ✌️ Farewell create react app 4

CRA 4 is no longer officially supported. While it is definitely possible to make it work, it may require extra work. CRA 5 works fine.

### 🚢 Better exports

Exports for Glide Data Grid are now done in a more standard esm compliant manner. This should enable better tree shaking.

### 🧼 Cell API cleanup

Some cells have had minor tweaks to their API to bring them in line with standard conventions. The `ImageCell` and all the cells in the `cells` package now uses the standard `readonly` flag.

### 👋 Minimap removed

The minimap was awesome, and largely unused. It has been removed from this version of Glide Data Grid in the service of smaller packages and a more maintainable surface area. We appreciate your service 🫡

### 🎨 `drawCell` callback improved.

The drawCell callback now receives a callback argument which paints the standard cell. This allows dramatically more flexibility with custom under and overdrawing of cells. It is also now a void method eliminating a source of confusion.

```typescript
const drawCell: DrawCellCallback = React.useCallback(
    (args, draw) => {
      // Draw something below the cell drawing
      draw()
      // Draw something on top of the cell drawing
}, [])
```

## 🎉 New Features

### 💪 Kinetic super scroll on iOS

Are you the one person presenting data grids to your mobile users? This feature is for you. GDG will now artificially boost the framerate during kinetic scroll on iOS to maintain a smooth experience. This is still experimental, but if feedback goes well we intend to promote this to stable.

```tsx
    return (
        <DataEditor
            {...otherProps}
            experimental={{
                kineticScrollPerfHack: true,
            }}
        />
    );
```

### 🏁 Performance improvements when updating lots of data at once

Damage rendering now is 2x faster than the 5.0 series. This is enabled by reducing the amount of clipping during a damage pass. This improvement is what has made the DOOM easter egg on the main site possible. The easter egg may also be the reason for the improvement...

<img width="1151" alt="CleanShot 2024-01-10 at 22 43 12@2x" src="https://github.com/glideapps/glide-data-grid/assets/30443/33041725-7398-4c49-9ef1-c199482eb93c">

### 🌐 UriCell improvements

![CleanShot 2024-01-10 at 22 41 10@2x](https://github.com/glideapps/glide-data-grid/assets/30443/18df5dc5-5a93-46bd-8059-c0cdcb5cfe9c)

The URI cell supports drawing an underscore on hovering a URI value via the `hoverEffect` property. It also supports click events (e.g., to open the URL) via the `onUriClick` property and uses the `displayData` within the cell rendering. 

### ⚽️ Add support for rounding radius in the theme

![image](https://github.com/glideapps/glide-data-grid/assets/2852129/41205ff9-db9b-44ef-8a97-e59e826438bc)

Configure the rounding radii of checkboxes, bubbles, skeletons, images, buttons, and other rounded elements via the optional `roundingRadius` theming property. 

### 🤕 Header menu icons can now be configured

![image](https://github.com/glideapps/glide-data-grid/assets/2852129/974148aa-91e2-449d-9ed0-55a5940b60c4)

Customize the header menu icon via the `menuIcon` property in `GridColumn`. It supports `triangle` for the default menu icon, `dots` for the three-dots menu icon, or a key of one of the icons passed to the `headerIcons` prop.

### 📈 Sparkline cell now supports even more charts

<img width="473" alt="CleanShot 2024-01-10 at 22 37 25@2x" src="https://github.com/glideapps/glide-data-grid/assets/30443/f88fe87c-833d-450b-8468-be52faba605d">

The `line` graphKind got renamed to `area`. The new `line` chart now renders just a simple line chart. Additionally, the x-axis can be hidden via `hideAxis`.

### 🥶 Freeze trailing rows

<img width="600" alt="CleanShot 2024-01-10 at 22 36 58@2x" src="https://github.com/glideapps/glide-data-grid/assets/30443/58b2603c-9113-44b2-9ab1-c79135e50cb9">

Get going by specifying the number of freeze trailing rows you want.

```tsx
    return (
        <DataEditor
            {...otherProps}
            freezeTrailingRows={2}
        />
    );
```

### 💀 LoadingCell skeletons

<img width="510" alt="CleanShot 2024-01-10 at 22 34 25@2x" src="https://github.com/glideapps/glide-data-grid/assets/30443/aac2ed4b-f1f4-44e6-b758-f30caf871f5f">

The loading cell can be configured to show skeletons when `skeletonWidth` is set to a value > 0. The height can be configured via the optional `skeletonHeight` property, and it also supports a randomized variability applied to the width via `skeletonWidthVariability.` 

### ⌨️ Fully remappable keybindings

Keybindings can now be remapped instead of just turned off and on. More details [here](https://docs.grid.glideapps.com/api/dataeditor/input-interaction#keybindings).

### 🪤 Focus trapping

There is now a `trapFocus` prop that will cause the grid to prevent focus leaving the grid during caret browsing or pressing tab.

### 🙅‍♀️ Prevent column reordering

Reordering of columns can now be prevented as new column locations are proposed using the new `onColumnProposeMove` callback. This allows for greater control over where users are allowed to drag columns.

### 💾 Copy and paste methods now available

The copy and paste functionality of the data grid is now exposed for direct usage by developers.

### 🌲 Tree view cell 

<img width="213" alt="image" src="https://github.com/glideapps/glide-data-grid/assets/2852129/258aabf8-b7ee-4dfb-842d-01e257e4b84a">

This cell represents the basic building block required to make collapsable and groupable rows. We will continue to improve support for row grouping in the rest of the 6.0.0 series.

### ⬇️ Dropdown cell improvements

Allow specifying label and value independently in dropdown cell and some other visual improvements.

## 🚀 Improvements

### 💍 Improved drawing of highlight and selection rings

When the selection ring or a highlight ring is at the right or bottom edge of the grid it will no longer be clipped out.

### 🦏 Safari performance improvements

Safari now renders around 2 to 5 times faster on mobile devices. Less hitching, better grids, papa johns.

### 🔦 Large highlight region support

Prior to 6.0.0 large highlight regions could cause excessively slow drawing performance. This is no longer a problem.

### 🔍 Search no longer renders eagerly

Don't use the search? No problem. You no longer pay the penalty for something you don't need.

### 🏁 Mouse hover render reduction

Hovering with the mouse no longer results in excessive react rendering.

### 👓 Hover interactions now can discern blank spots of grid from outside of grid

More details here: #811

### ↔️ Resize column indicator

<img width="439" alt="image" src="https://github.com/glideapps/glide-data-grid/assets/2852129/b87ac8cb-9699-40f1-8816-d6c4e9bd0d17">

There is a new column resize indicator. It can be configured via the `resizeIndicatorColor` theme property. 

### ☕️ Fill handle improvements

- Controllable selection behavior
- FillPattern support
- Larger fill handle click region
- New visual representation

![CleanShot 2024-01-10 at 23 10 57@2x](https://github.com/glideapps/glide-data-grid/assets/30443/3b76efbc-d0c0-4bb2-aa27-880f4315f3df)

### 🔲 Get the bounds of the entire scroll area 

If `getBounds` get called with `col` and `row` as undefined, the bounding box of the entire data grid scroll area is returned.

## 🔚 Odds and ends

- GDG now prefixes most of the css classes it uses to avoid conflicting with commonly used names.
- Page up and down keybindings are now on by default

## 🐞 Bug Fixes

- `onDelete` now properly called when doing a cut operation.
- Fixed a crasher caused by attemping to draw negative radius arcs.
- Fix a bug where `getBounds` would compute for the wrong cell.
- Fixed multiple bugs where strict mode would be violated
- Horizontally center bubble cell editor to align with cell rendering.
- Fix copy escaping for array values. 
- Fix issues with paste logic.
- Fix text cell editor color in Safari.
- Fix jittering issue with grow columns.
- Use the configured padding for measuring of number, row-id, dropdown and date-picker cells.
- Fix sparkline chart error related to arrays with less than 3 values. 

Co-authored-by: Lukas Masuch <[email protected]>
Co-authored-by: luciacangarova <[email protected]>
Co-authored-by: Chris Cowan <[email protected]>
Co-authored-by: Brian Hung <[email protected]>

Author: 5 people

.github/workflows/beta.js.yml

@@ -16,9 +16,9 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v1
-            - uses: actions/setup-node@v1
+            - uses: actions/setup-node@v4
               with:
-                  node-version: 16
+                  node-version: 20.10.0
             - name: Build
               run: npm install && npm run build
               working-directory: .
@@ -35,9 +35,9 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v1
-            - uses: actions/setup-node@v1
+            - uses: actions/setup-node@v4
               with:
-                  node-version: 16
+                  node-version: 20.10.0
             - name: Build
               run: npm install && npm run build
               working-directory: .
@@ -56,7 +56,7 @@ jobs:
             - uses: actions/checkout@v1
             - uses: actions/setup-node@v1
               with:
-                  node-version: 16
+                  node-version: 20.10.0
             - name: Bootstrap
               run: npm install && npm run build
               working-directory: .

.github/workflows/node.js.yml

@@ -10,10 +10,10 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v2
-            - name: Use Node.js 16
-              uses: actions/setup-node@v1
+            - name: Use Node.js 20
+              uses: actions/setup-node@v4
               with:
-                  node-version: 16
+                  node-version: 20.10.0
             - run: npm install
             - run: npm run build
             - run: npm run test -- --coverage
@@ -30,8 +30,8 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v1
-            - uses: actions/setup-node@v1
+            - uses: actions/setup-node@v4
               with:
-                  node-version: 16
+                  node-version: 20.10.0
             - run: npm install
             - run: npm run test-18

.github/workflows/release.js.yml

@@ -17,9 +17,9 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v1
-            - uses: actions/setup-node@v1
+            - uses: actions/setup-node@v4
               with:
-                  node-version: 16
+                  node-version: 20.10.0
             - name: Bootstrap
               run: npm install && npm run build
               working-directory: .
@@ -35,9 +35,9 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v1
-            - uses: actions/setup-node@v1
+            - uses: actions/setup-node@v4
               with:
-                  node-version: 16
+                  node-version: 20.10.0
             - name: Bootstrap
               run: npm install && npm run build
               working-directory: .
@@ -53,9 +53,9 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v1
-            - uses: actions/setup-node@v1
+            - uses: actions/setup-node@v4
               with:
-                  node-version: 16
+                  node-version: 20.10.0
             - name: Bootstrap
               run: npm install && npm run build
               working-directory: .

.github/workflows/storybook.js.yml

@@ -11,9 +11,9 @@ jobs:
               uses: actions/[email protected]
               with:
                   persist-credentials: false
-            - uses: actions/setup-node@v1
+            - uses: actions/setup-node@v4
               with:
-                  node-version: 16
+                  node-version: 20.10.0
             - name: Install and Build 🔧
               run: |
                   npm install

.gitignore

@@ -7,4 +7,5 @@ node_modules*
 pubsub-debug.log
 storybook-build/
 coverage/
-*.tsbuildinfo
+*.tsbuildinfo
+gen-docs/

.nvmrc

@@ -1 +1 @@
-v16.16.0
+v20.10.0

.storybook/.babelrc.json

@@ -18,7 +18,7 @@
         ],
         "@babel/preset-react",
         "@babel/preset-typescript",
-        "@linaria/babel-preset"
+        "@linaria"
     ],
     "plugins": ["@babel/plugin-proposal-class-properties"]
 }

.storybook/main.js

@@ -1,14 +1,15 @@
+const { dirname, join } = require("path");
 const MiniCssExtractPlugin = require("mini-css-extract-plugin");
+const ResolveTypeScriptPlugin = require("resolve-typescript-plugin");
 
 module.exports = {
     stories: ["../**/src/**/*.stories.tsx"],
-    addons: ["@storybook/addon-storysource", "@storybook/addon-controls"],
-    core: {
-        builder: "webpack5",
-    },
+    addons: ["@storybook/addon-storysource", getAbsolutePath("@storybook/addon-controls")],
+
     typescript: {
         reactDocgen: false,
     },
+
     webpackFinal: async (config, { configType }) => {
         // `configType` has a value of 'DEVELOPMENT' or 'PRODUCTION'
         // You can change the configuration based on that.
@@ -32,7 +33,22 @@ module.exports = {
         });
 
         config.optimization.minimize = false;
+        config.devtool = "source-map";
+        config.resolve.plugins = [new ResolveTypeScriptPlugin()];
 
         return config;
     },
+
+    framework: {
+        name: getAbsolutePath("@storybook/react-webpack5"),
+        options: {},
+    },
+
+    docs: {
+        autodocs: false,
+    },
 };
+
+function getAbsolutePath(value) {
+    return dirname(require.resolve(join(value, "package.json")));
+}

.storybook/manager.js

@@ -1,5 +1,5 @@
 import { addons } from "@storybook/addons";
-import { themes, create } from "@storybook/theming";
+import { create } from "@storybook/theming";
 
 const glideTheme = create({
     base: "dark",

.storybook/preview.js

@@ -1,14 +1,14 @@
-import { addParameters } from "@storybook/react";
-
-addParameters({
-    options: {
-        showRoots: true,
-        storySort: (a, b) => {
-            return a[1].name.localeCompare(b[1].name, undefined, { numeric: true });
+const preview = {
+    parameters: {
+        layout: "fullscreen",
+        options: {
+            storySort: {
+                method: "alphabetical",
+                order: ["Glide-Data-Grid", "Extra Packages", "Subcomponents"],
+                locales: "en-US",
+            },
         },
     },
-});
-
-export const parameters = {
-    layout: "fullscreen",
 };
+
+export default preview;

.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "msedge",
+            "request": "launch",
+            "name": "Launch Glide Data Grid",
+            "url": "http://localhost:9009",
+            "webRoot": "${workspaceRoot}/",
+            "preLaunchTask": "npm: start",
+            "sourceMaps": true
+        }
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,30 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "npm: start",
+            "type": "npm",
+            "script": "start",
+            "isBackground": true,
+
+            "problemMatcher": {
+                "pattern": {
+                    "regexp": ".*"
+                },
+                "background": {
+                    "activeOnStart": true,
+                    "beginsPattern": "^.*Starting Storybook.*$", // Adjust if there's a more specific start message
+                    "endsPattern": "^.*Storybook \\d+.\\d+.\\d+ for react-webpack5 started.*$"
+                }
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "presentation": {
+                "reveal": "always",
+                "panel": "new"
+            }
+        }
+    ]
+}

babel.cjs.json

@@ -0,0 +1,48 @@
+run_in_parallel() {
+  local funcs=("$@")
+  local pids=()
+
+  # Start the functions in the background and store their PIDs
+  for func in "${funcs[@]}"; do
+    ($func) &
+    pids+=($!)
+  done
+
+  # Wait for all functions and exit if any of them fail
+  for pid in "${pids[@]}"; do
+    wait $pid || exit $?
+  done
+}
+
+generate_index_css() {
+  echo "/* Auto-generated file */" > dist/index.css
+  find dist/esm -name '*.css' -print | sed 's/^dist\/esm\//\@import ".\/esm\//' | sed 's/$/";/' >> dist/index.css
+}
+
+ensure_bash_4() {
+    if [ "${BASH_VERSINFO[0]}" -lt 4 ]; then
+        if [ -x "/opt/homebrew/bin/bash" ]; then
+            exec /opt/homebrew/bin/bash "$0" "$@"
+        elif [ -x "/usr/local/bin/bash" ]; then
+            exec /usr/local/bin/bash "$0" "$@"
+        else
+            echo "Bash 4 or higher is required."
+            exit 1
+        fi
+    fi
+}
+
+remove_all_css_imports() {
+    local directory=$1
+    local sed_cmd="sed -i"
+
+    # Check if sed is GNU sed or BSD sed
+    if sed --version 2>/dev/null | grep -q GNU; then
+        sed_cmd="sed -i"  # GNU sed
+    else
+        sed_cmd="sed -i ''"  # BSD sed
+    fi
+
+    find "$directory" -type f -name "*.js" -exec bash -c "$sed_cmd \"/require('.\/.*\.css');/d\" {}" \;
+    find "$directory" -type f -name "*.js" -exec bash -c "$sed_cmd \"/import \\\".*\.css\\\";/d\" {}" \;
+}

config/build-util.sh

@@ -0,0 +1,3 @@
+{
+    "classNameSlug": "gdg-[hash]"
+}