@themarioga/grid-editor 6.0.0 → 7.0.0

package/AUTO_SAVE.md

@@ -1,8 +1,8 @@
 ## Auto save and layout import/export
 
 The `example/autosave.html` demo shows how to add **auto save** and
-**import/export** on top of Grid Editor, using only the plugin's existing
-public API (`gridEditor('getHtml')` and `gridEditor('remove')`).
+**import/export** on top of Grid Editor, using only the editor's public API
+(`getHtml()` and `destroy()` on the `GridEditor` instance).
 
 ### Features
 

package/BUILDING.md

@@ -13,32 +13,43 @@ From then on out, you can build the files in the `dist` directory by running:
 
 During development, you can also run `npm run watch` to automatically rebuild on changes.
 
-The build emits the plugin as `dist/jquery.grideditor.js`, the stylesheet as
-`dist/grideditor.css`, each with a minified twin and a source map beside it,
-and the files in `src/js/locales/` and `src/js/plugins/` one by one under
-`dist/locales/` and `dist/plugins/`. Neither of those two directories is part
-of the main bundle: the `src/js/*.js` glob does not descend, so a page loads
-the languages and the container plugins it actually wants. See
-[docs/plugins.md](docs/plugins.md) for what a container plugin is.
-
-The text editor plugins - tinyMCE, CKEditor and summernote - are built to
-`dist/plugins/` like the others, and like them are not part of the main
-bundle. Up to 5.x the bundle carried a copy of each. Each one is built as
-`src/js/text/grideditor.text.js`, what every text editor shares, followed by
-the editor's own file: that shared file is never published on its own.
-
-One more file comes out of it: `dist/jquery.grideditor.bundle.min.js`, the
-minified editor concatenated with the copy of SortableJS in `node_modules`,
-for pages that would rather load one file than two. It carries both MIT
-notices, it is built after the minified editor because it is made of it, and a
-page loads it *or* the editor and SortableJS separately, never both. The
-version is pinned in `package.json`, so refreshing it is an `npm update
-sortablejs` and a rebuild.
-
-Locale files are deliberately not part of the main bundle: a page loads only the languages it
-offers. English is the exception and lives in the bundle, because it is the
-fallback every string lookup ends at. See `docs/locale-keys.md` for the keys,
-and `src/js/locales/grideditor.es.js` for what a locale file looks like.
+The sources are ES modules. `build/build.js` turns them into what `dist/`
+ships, with esbuild; Grunt runs the stylesheets and calls it, so `npm run
+build` is the one command either way. Every script comes out twice:
+
+| Output | What it is |
+| --- | --- |
+| `dist/grideditor.js`, `.min.js` + map | the editor as a classic script, defining `window.GridEditor` |
+| `dist/grideditor.esm.js` | the editor as an ES module, exporting `GridEditor` |
+| `dist/grideditor.bundle.min.js` | the minified editor with SortableJS in front of it |
+| `dist/grideditor.jquery.js`, `.min.js` + map | the jQuery adapter: the 6.x API for a page that loads jQuery 4 |
+| `dist/plugins/grideditor.<name>.js`, `.min.js`, `.esm.js` | each plugin, classic and as a module |
+| `dist/locales/grideditor.<code>.js`, `.min.js`, `.esm.js` | each locale, the same two ways |
+| `dist/grideditor.d.ts` | the public API's types, copied from `types/` |
+| `dist/grideditor.css`, `.min.css` + map | the stylesheet, from `src/less/` |
+
+A plugin or a locale never carries a copy of the editor. Its classic script
+finds the one the page loaded through `src/js/register.js`, which says so, in
+an error, when the editor has not been loaded yet; its module imports
+`../grideditor.esm.js`. `src/js/dom.js`, the editor's DOM helpers, is not
+public: the build puts a copy in each script that uses it.
+
+The text editor plugins - tinyMCE, CKEditor and summernote - each import
+`src/js/text/grideditor.text.js`, what every text editor shares, so each
+script carries it; however many a page loads, it is installed once. That
+shared file is never published on its own.
+
+The bundle is the minified editor concatenated with the copy of SortableJS in
+`node_modules`, for pages that would rather load one file than two. It carries
+both MIT notices, and a page loads it *or* the editor and SortableJS
+separately, never both. The version is pinned in `package.json`, so refreshing
+it is an `npm update sortablejs` and a rebuild.
+
+Locale files are deliberately not part of the editor: a page loads only the
+languages it offers. English is the exception and lives in the editor, because
+it is the fallback every string lookup ends at. See `docs/locale-keys.md` for
+the keys, and `src/js/locales/grideditor.es.js` for what a locale file looks
+like.
 
 Running the tests
 =================
@@ -50,7 +61,9 @@ so build first:
 * `npm run build`
 * `npm test`
 
-There is nothing extra to install: the tests use node and Chrome, and start
+`npm test` first checks the public API's types (`npm run test:types`, which
+compiles `test/types/usage.ts` against `types/grideditor.d.ts`), then runs the
+browser suites. There is nothing extra to install: the tests use node and Chrome, and start
 their own web server. `npm test` runs every suite in `test/` in one Chrome and
 prints one summary, and exits non-zero if anything failed. To run a single
 suite, pass part of its name:
@@ -59,8 +72,11 @@ suite, pass part of its name:
 
 A suite can also be run on its own with `node test/rte.js`.
 
-The fixture pages in `test/fixtures` load jQuery, SortableJS and Bootstrap from
-`test/vendor` rather than from a CDN, so most of the suite runs offline. The
+The fixture pages in `test/fixtures` load SortableJS and Bootstrap from
+`test/vendor` rather than from a CDN, so most of the suite runs offline.
+`grid.html`, which most suites run on, has no jQuery; `adapter.html` is the
+same page through the jQuery adapter, with the vendored jQuery 4, and
+`esm.html` imports the module build. The
 rich text editor suite is the exception: it loads tinyMCE, CKEditor and
 Summernote from their CDNs to test against the real editors, and the runner
 skips it, with a reason, when there is no network. `OFFLINE=1 npm test` forces

package/CHANGELOG.md

@@ -5,6 +5,53 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [7.0.0] - 2026-09-28
+grid-editor is plain DOM: no jQuery. See [UPGRADING.md](UPGRADING.md).
+
+### Added
+- `GridEditor`: `new GridEditor(target, options)`, `GridEditor.create` and
+  `GridEditor.get`. The methods are the instance's own, and the ones that do
+  something chain.
+- The module build: `dist/grideditor.esm.js`, and each plugin and locale as
+  a module that registers as it is imported. `package.json` has `module`,
+  `exports` and `types`.
+- `dist/grideditor.d.ts`: the public API's types.
+- `grideditor.jquery.js`, the adapter: the 6.x jQuery API, unchanged, for a
+  page that loads jQuery 4.
+- `GridEditor.Sortable` and `GridEditor.bootstrap`, for an app that imports
+  SortableJS and Bootstrap rather than loading them as globals.
+- `nodes` in `after-edit-html`'s payload: every element written.
+
+### Changed
+- Events are DOM events on the canvas, `CustomEvent`s with the payload as
+  their `detail`; they bubble. Payloads, `create*` results, the plugin handle
+  and every plugin hook give and take elements.
+- The classic scripts are `dist/grideditor.js`, `.min.js` and
+  `grideditor.bundle.min.js`; the `jquery.grideditor*` names are gone.
+- A `<script>` in html the editor writes is not run in the editor.
+- A listener that throws no longer stops the operation.
+- A second editor asked for on an element hands back the first, and warns.
+- Plugins register on `GridEditor.containers`, `.features`, `.utilities` and
+  `.texts`; the build is esbuild, from ES module sources.
+- `error.ckeditor_missing` no longer mentions a jQuery adapter, and
+  `error.summernote_missing` says summernote needs jQuery.
+
+### Removed
+- jQuery as a dependency. Only the summernote plugin uses it, since
+  summernote does.
+- `remove()`, the alias of `destroy()` deprecated since 3.1.
+- `$.fn.gridEditor.RTEs`, ignored since 6.0.
+- tinyMCE's `oninit` option, the name tinyMCE used before 6, kept until now: ignored, with a warning.
+
+### Fixed
+- `custom_filter` given as a function or an array of them runs.
+- `destroy()`, or `setLocale()`, with a Bootstrap modal open or on its way in
+  or out - the settings panel with `settings_panel: 'modal'`, or the delete
+  confirmation - threw from Bootstrap's transition and left the page's body
+  locked, with no scrolling. The modal is closed first now, and taken away
+  once Bootstrap has hidden it.
+
+
 ## [6.0.0] - 2026-09-28
 ### Removed
 - The *Add text* tool in each column's drawer, and its `tool.add_text` and