Skip to content
This repository was archived by the owner on Jan 16, 2020. It is now read-only.

Commit 348a349

Browse files
committed
Updated Readme, to warn of breaking changes following jQuery 1.5 changes to .data()
1 parent f2b13ff commit 348a349

File tree

1 file changed

+9
-17
lines changed

1 file changed

+9
-17
lines changed

README.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,17 @@ Documentation for the _jQuery Data Link_ plugin can be found on the jQuery docum
55

66
<p>
77
==================================== WARNING ====================================<br/>
8-
<b>Note:</b> <br/>
9-
10-
In jQuery 1.5 the behavior of the <i>$( somePlainObject ).data()</i> method has been changed.
11-
12-
This build of the <i>jQuery DataLink</i> plugin will work with both jQuery 1.5, and previous builds of jQuery.
13-
14-
It provides a new <i>$( somePlainObject ).setField()</i> method, which should be used instead of <i>.data()</i>,
15-
for modifying field values on plain objects and triggering data linking.
8+
<i><b>Breaking change:</b>
9+
<br />In jQuery 1.5, the behavior of $(plainObject).data() has been modified. In order to work against all versions of jQuery including jQuery 1.5,
10+
current builds of jquery-datalink have therefore been modified as follows:
11+
<ul>
12+
<li>The API to modify field values is now .setField( name, value ), rather than .data( name, value ). (Examples below).</li>
13+
<li>The events associated with the modified field are now "setField" and "changeField", rather than "setData" and changeData".</li>
14+
</ul></i>
15+
Note: This plugin currently depends on jQuery version 1.4.3.<br/>
1616
=================================================================================
1717
</p>
18+
</p>
1819

1920

2021
<h1>Introduction</h1>
@@ -216,12 +217,3 @@ $("#input1").link("#span1", {
216217
});
217218
$("#span1").parent().html("");
218219
</pre>
219-
220-
<h1>Revision History</h1>
221-
222-
* 7/23/2010 -- Completely revised the API based on feedback.<br />
223-
* 5/26/2010 -- Completely revised the API based on forum feedback.<br />
224-
* 5/01/2010 -- Corrected comments about restricted scope -- event is suppressed, not the change.<br />
225-
* 5/01/2010 -- Fixed glitches in comments and added info about restricted scope.<br />
226-
* 4/29/2010 -- Expanded on converter samples.<br />
227-
* 4/28/2010 -- Initial proposal published<br />

0 commit comments

Comments
 (0)