Skip to content

fix: move v6 migration guide to Migration guides and fix examples - #1348

Merged
6pac merged 4 commits into
masterfrom
fix/examples-pages-and-migration-guide
Nov 14, 2026
Merged

6pac merged 4 commits into
masterfrom
fix/examples-pages-and-migration-guide

Conversation

@6pac-ai

@6pac-ai 6pac-ai commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator

Summary

Moves the v6 migration guide into a new Migration guides section of the docs and makes it the complete, authoritative list of breaking changes between 5.20.2 and 6.0.0. Also fixes the examples that are broken on GitHub Pages, including the Sparkline async post render cleanup example.

Why

  • The v6 guide sat under In-depth, and it missed many breaking changes and got several wrong (reported in Discussion Roadmap to version 6.0 #1297).
  • On https://6pac.github.io/SlickGrid/ every example that loads a script from ../lib/ fails, because the Pages workflow copies examples/ but not lib/. The Sparkline cleanup example throws $(...).empty(...).sparkline is not a function, and the charts stay at "wait...".
  • Every example's home link pointed at /examples/index.html, which is a 404 under /SlickGrid/.

Changes

  • Docs:
    • New docs/migration/ section, in the top nav and with its own sidebar. index.md lists all migration guides (v3 to v6), and v6.md is the v6 guide.
    • /in-depth/migration-v6 is kept as a stub page that redirects to /migration/v6, so existing links (release notes, README, discussions) keep working.
    • The v6 guide now covers everything breaking between 5.20.2 and 6.0.0:
      • packaging (ESM only, Node version, no dist/ on GitHub, removed exports)
      • pinning, hidden columns and mixinDefaults
      • rendering, events, clipboard and autosizing
      • removed deprecated APIs, plugins and controls, editors and accessibility
      • styling and themes, and protected members for subclasses
    • Fixed errors in the v6 guide:
      • the three --alpine-* SVG properties that keep their names
      • the full .ui-* → .slick-* mapping
      • the -columns-right band wrappers, which still exist
      • validateColumnFreeze(), which never existed
      • the removed clipboard options
      • the SortableJS instances that getSetupColumnReorder() actually returned
      • horizontal rendering, which was synchronous in 5.20.2
    • The pinning guide's migration table had the same validateColumnFreeze(), classes and trigger() errors; they are fixed.
    • Links to the guide (README, columns, CSP, plugins and pinning pages, and both migration skill files) point at the new location.
  • Examples:
    • docs.yml copies lib/ into the Pages site and rebuilds on lib/** changes.
    • The example10a-async-post-render-cleanup.html page loads Sparkline 2.1.2 with jQuery 3.7 again, which is what the page describes and demonstrates. Version 5.0 had replaced it with example 10's Sparkline 1.x + jquery-migrate block. Its title is fixed too.
    • The home link of all 96 examples is relative (./index.html).

Validation

  • In vitepress/: npm run links (626 internal links OK), npm run drift (0 undocumented) and DOCS_BASE=/SlickGrid/ npm run docs:build all pass.
  • Every in-page anchor that the guide and the other pages link to exists in the built HTML.
  • I served the built site under /SlickGrid/ and checked it in a browser:
    • the old URL redirects to /SlickGrid/migration/v6
    • the nav and sidebar show the new section
  • The breaking-change facts were checked against the 5.20.2 and 6.0.0 tags.
  • Example 10a, on a local build (npm run build), in the browser:
    • Sparkline 2.x loads, with no console errors
    • charts render
    • scrolling away cleans up 40 nodes, and the rows re-render when scrolled back
    • editing a value re-renders the chart
    • the home link resolves
  • The live Pages site was confirmed to 404 on lib/jquery.sparkline.min.js, lib/select2.js and lib/jquery.jsonp-2.4.min.js.
  • No Cypress spec references the home link or Sparkline.

Comments

  • docs/data/api.json was regenerated by the docs build. I left it out because the only changes were the timestamp and a local path.
  • The 6.0.0 release notes are updated separately with a condensed breaking-change list that links to this guide.

AI / LLM assistance

  • AI / LLM assistance used:
    • No
    • Yes
  • If Yes:
    • which tool/model: Claude Code (Claude Opus 5.5)
    • how was it used: compared the 5.20.2 and 6.0.0 sources, rewrote the guide, diagnosed and fixed the examples, and verified in a browser, at 6pac's request

Checklist

  • The changes are limited to only one scope (if not please explain why in the comments above).
  • Tests were added or updated where appropriate.
  • Documentation was updated where appropriate.

🤖 Generated with Claude Code

…ken examples

- Move the v6 guide from In-depth to a new Migration guides section
  (/migration/v6), with an overview of all migration guides. The old
  /in-depth/migration-v6 URL redirects to the new page.
- Make the guide the complete list of breaking changes between 5.20.2
  and 6.0.0, and fix its errors: the Alpine SVG properties that keep
  their names, the .ui-* class mapping, the -columns-right band
  wrappers, validateColumnFreeze() (never existed), the removed
  clipboard options, the SortableJS instances that were returned, and
  horizontal rendering (it was synchronous in 5.20.2).
- Fix the same errors in the pinning guide's migration table.
- Publish lib/ with the examples on GitHub Pages: the examples that load
  third-party scripts from ../lib (both Sparkline examples, Select2,
  JSONP, row reordering) failed there with a 404.
- Restore Sparkline 2.1.2 in the async post render cleanup example, which
  is what the page describes and demonstrates.
- Make the examples' home link relative, so it works under /SlickGrid/.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@codecov

codecov Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.41%. Comparing base (9cc7dd0) to head (2c45936).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1348   +/-   ##
=======================================
  Coverage   93.41%   93.41%           
=======================================
  Files          34       34           
  Lines       13519    13519           
  Branches     4091     4091           
=======================================
  Hits        12629    12629           
  Misses        686      686           
  Partials      204      204           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ghiscoding

ghiscoding commented Nov 11, 2026 •

Copy link
Copy Markdown
Collaborator

@6pac-ai I found another small problems with the docs, Vitepress seems to be converting the links to all lowercase and some of the function links are now wrong, for example v6 migration has a link to updateColumns and the link is https://6pac.github.io/SlickGrid/reference/grid#m-updatecolumns but the correct link is ...reference/grid#m-updateColumns... Also I don't understand why you mention 3 --alpine suggestions, the goal was to replace all variables, so these 3 exceptions should be fixed and no longer be an exception: "Three generated SVG icon properties keep their names: --alpine-group-expanded-icon-svg, --alpine-group-collapsed-icon-svg and `--alpine-percent-complete-picker-icon-svg``". so perhaps they were simply missed with the previous PR and should simply be fixed.

@6pac so I was curious, can I converse with @6pac-ai or do you need to approve it to get going?

@6pac

6pac commented Nov 11, 2026 •

Copy link
Copy Markdown
Owner

OK, will feed that back in. Regarding conversing with the AI, at the moment, I just tell it to read comments and react to them.

I've asked it, and it can set up a scheduled job that runs every minute or so, which would allow it to reply. But honestly, I'm not really okay with that: AI is still in its fairly early days, and I'm not sure how far prompt injection could go.
While it can't push or merge without my consent, I'd still be concerned that a malicious user could do some annoying things and/or use up a ton of my tokens.

Thinking about it more, I suppose I could just restrict it to comments on your account that it reacts to.

@ghiscoding

Copy link
Copy Markdown
Collaborator

I've asked it, and it can set up a scheduled job that runs every minute or so, which would allow it to reply. But honestly, I'm not really okay with that

indeed keep it as-is, it's not necessary and was exactly what I expected. There are things that I don't want AI to have to much control over (like my bank account) and that might be another one of them.

that a malicious user could do some annoying things and/or use up a ton of my tokens.

yeah exactly. I don't need any special privileges, we are mainly done with v6, it's released and anything is small little things here and there that can definitely wait a little longer... so keep it as it is, I'm totally fine with current behavior and just wanted to confirm ;)

6pac-ai and others added 2 commits November 11, 2026 12:18
VitePress 2 runs the #hash of every internal link through the heading
slugify, which lowercases it, so links such as /reference/grid#m-updateColumns
were rendered as #m-updatecolumns and missed the Reference ids, which are
the member names. Keep `prefix-memberName` hashes as written and slugify
everything else as before; every heading id on the site is unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…--slick-*

#1317 renamed every Alpine variable to the slick- prefix but missed the
three CSS properties generated by createSvgStyle():
--alpine-group-expanded-icon-svg, --alpine-group-collapsed-icon-svg and
--alpine-percent-complete-picker-icon-svg. They are now --slick-*, which
is also the name example-grouping.html already uses for its override.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@6pac-ai

6pac-ai commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator Author

@ghiscoding thanks, you're right on both points. I pushed a fix for each:

Lowercased reference links: 8b3e420. This wasn't limited to the migration guide. VitePress 2's link plugin runs the #hash of every internal link through the heading slugify, which lowercases it, so every /reference/...#m-updateColumns style link on the live site points at an id that doesn't exist. That covers the methods, options, columns and events, about 400 links. npm run links checks the Markdown source, which is why it didn't catch this.

The fix is a custom markdown.anchor.slugify in vitepress/.vitepress/config.mjs. It keeps prefix-memberName hashes exactly as written and slugifies everything else the default way. I diffed every id in the built site before and after: all 2,474 are identical. Only the link hrefs change, e.g. #m-updatecolumns → #m-updateColumns.

The three --alpine-* properties: 79960d2. Agreed, #1317 just missed them. They're generated by createSvgStyle() from string names in slick-alpine-theme.scss, so the variable rename didn't reach them. They are now --slick-group-expanded-icon-svg, --slick-group-collapsed-icon-svg and --slick-percent-complete-picker-icon-svg. example-grouping.html already uses --slick-group-expanded-icon-svg in its (commented-out) override example. I checked in the browser that this override takes effect now; in 6.0.0 it did nothing.

The guide no longer lists these three as an exception. It now notes that 6.0.0 itself still shipped them with the --alpine- prefix, since anyone already on 6.0.0 who overrides them will need the new name. The second commit is a fix(alpine) in a mostly docs PR. I'm happy to split it into its own PR if you'd prefer it separate for the changelog.

@ghiscoding

Copy link
Copy Markdown
Collaborator

@6pac I made a small change to the docs after Claude, I'm ok with the rest of the PR. Feel free to merge if you're happy with it too

@ghiscoding

Copy link
Copy Markdown
Collaborator

@6pac-ai can you rename the PR since I think it should be rename as a "fix" PR because it includes missed --alpine variables and possibly other fixes. I think we're ready to merge after that.

@6pac 6pac changed the title docs: move v6 migration guide to Migration guides and fix examples fix: move v6 migration guide to Migration guides and fix examples Nov 14, 2026
@6pac
6pac merged commit 2d92685 into master Nov 14, 2026
7 checks passed
@6pac
6pac deleted the fix/examples-pages-and-migration-guide branch November 14, 2026 04:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants