Merge pull request gridstack#1192 from adumesny/develop

adumesny · web-flow · commit 04906fb7e45a · 2020-03-05T18:07:43.000-08:00
better doc for jquery conflict
diff --git a/README.md b/README.md
@@ -37,6 +37,7 @@ Join us on Slack: https://gridstackjs.troolee.com
   - [Custom columns CSS](#custom-columns-css)
   - [Override resizable/draggable options](#override-resizabledraggable-options)
   - [Touch devices support](#touch-devices-support)
+  - [Migrating to v0.6.x](#migrating-to-v06x)
   - [Migrating to v1.0.0](#migrating-to-v100)
 - [Changes](#changes)
 - [The Team](#the-team)
@@ -258,11 +259,15 @@ GridStack.init(options);
 If you're still experiencing issues on touch devices please check [#444](https://github.com/gridstack/gridstack.js/issues/444)
 
 
+## Migrating to v0.6.x
+
+starting in 0.6.x `change` event are no longer sent (for pretty much most nodes!) when an item is just added/deleted unless it also changes other nodes (was incorrect and causing inefficiencies). You may need to track `added|removed` [events](https://github.com/gridstack/gridstack.js/tree/develop/doc#events) if you didn't and relied on the old broken behavior.
+
 ## Migrating to v1.0.0
 
 v1.0.0 removed Jquery from the API and external dependencies, which will require some code changes. Here is a list of the changes:
 
-1. your code only needs to include `gridstack.all.js` and `gristack.css` (don't include other) and is recommended you do that as internal dependencies will change. Right now jquery+jquery-ui (trimmed versions) are still being used internally for a short while.
+1. your code only needs to include `gridstack.all.js` and `gristack.css` (don't include other JS) and is recommended you do that as internal dependencies will change over time. If you are jquery based, also see note below.
 
 2. code change:
 
@@ -273,7 +278,7 @@ $('.grid-stack').gridstack(opts?);
 var grid = $('.grid-stack').data('gridstack');
 
 // returned Jquery element
-grid.addWidget($('<div><div class="grid-stack-item-content"> test </div></div>'), {width: 2});
+grid.addWidget($('<div><div class="grid-stack-item-content"> test </div></div>'), undefined, undefined, 2, undefined, true);
 
 // jquery event handler
 $('.grid-stack').on('added', function(e, items) {/* items contains info */});
@@ -292,8 +297,9 @@ grid.addWidget('<div><div class="grid-stack-item-content"> test </div></div>', {
 grid.on('added', function(e, items) {/* items contains info */});
 
 ```
+ 3. see [Migrating to v0.6.x](#migrating-to-v06x) if you didn't already
 
-Other  vars/global changes
+Other vars/global changes
 ```
 `GridStackUI` --> `GridStack`
 `GridStackUI.GridStackEngine` --> `GridStack.Engine`
@@ -304,7 +310,9 @@ Other  vars/global changes
 
 Recommend looking at the [many samples](./demo) for more code examples.
 
-We're working on implementing support for other drag'n'drop libraries through the plugin system. Right now it is still jquery-ui based (but minimal build content)
+**NOTE: jQuery Applications** 
+
+We're working on implementing HTML5 drag'n'drop through the plugin system. Right now it is still jquery-ui based. Because of that we are still bundling `jquery` (3.4.1) + `jquery-ui` (1.12.1 minimal drag|drop|resize) internally in `gridstack.all.js`. IFF your app needs to bring it's own version instead, you should **instead** include `gridstack-poly.min.js` (optional IE support) + `gridstack.min.js` + `gridstack.jQueryUI.min.js` + after you import your libs.
 
 Changes
 =====
