jquery-migrate
Advanced tools
The jquery-migrate npm package is designed to help developers transition from older versions of jQuery to newer ones by providing backward compatibility. It restores deprecated features and behaviors, making it easier to upgrade jQuery without breaking existing code.
Restoring Deprecated Features
The jquery-migrate package restores deprecated features such as the .live() method, which was removed in jQuery 1.9. This allows older code to function correctly with newer versions of jQuery.
/* Include jQuery and jQuery Migrate */
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
<script src="https://code.jquery.com/jquery-migrate-3.3.2.min.js"></script>
/* Example of using a deprecated feature */
$(document).ready(function() {
$("#myElement").live("click", function() {
alert("This is a deprecated feature!");
});
});Logging Deprecated Features
The jquery-migrate package can log the use of deprecated features to the console, helping developers identify and update old code. Setting jQuery.migrateMute to false enables these logs.
/* Include jQuery and jQuery Migrate */
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
<script src="https://code.jquery.com/jquery-migrate-3.3.2.min.js"></script>
/* Enable logging of deprecated features */
jQuery.migrateMute = false;
$(document).ready(function() {
$("#myElement").live("click", function() {
alert("This is a deprecated feature!");
});
});Compatibility with Older jQuery Plugins
The jquery-migrate package ensures compatibility with older jQuery plugins that may rely on deprecated features or behaviors, allowing them to work seamlessly with newer versions of jQuery.
/* Include jQuery and jQuery Migrate */
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
<script src="https://code.jquery.com/jquery-migrate-3.3.2.min.js"></script>
/* Example of using an older jQuery plugin */
$(document).ready(function() {
$("#myElement").pluginName(); // Assuming pluginName is a deprecated plugin method
});The jquery-compat package is another tool designed to help developers transition between different versions of jQuery. It focuses on providing compatibility for older jQuery code, similar to jquery-migrate, but may have different coverage of deprecated features.
The jquery-legacy package aims to support legacy jQuery code by maintaining compatibility with older APIs and features. It serves a similar purpose to jquery-migrate but may offer different levels of support for various deprecated functionalities.
Upgrading libraries such as jQuery can be a lot of work, when breaking changes have been introduced. jQuery Migrate makes this easier, by restoring the APIs that were removed, and additionally shows warnings in the browser console (development version of jQuery Migrate only) when removed and/or deprecated APIs are used.
That way you can spot and fix what otherwise would have been errors, until you no longer need jQuery Migrate and can remove it.
The following table indicates which jQuery Migrate versions can be used with which jQuery versions:
| jQuery version | jQuery Migrate version |
|---|---|
| 1.x | 1.x |
| 2.x | 1.x |
| 3.x | 3.x / 4.x[1] |
| 4.x | 3.x / 4.x[1] |
[1] NOTE: jQuery Migrate 4.x only supports the same browser as jQuery 4.x does. If you need to support Edge Legacy, Internet Explorer 9-10 or iOS 7+ (and not just 3 latest versions), use jQuery Migrate 3.x.
In your web page, load this plugin after the script tag for jQuery, for example:
<script src="https://code.jquery.com/jquery-3.7.1.js"></script>
<script src="https://code.jquery.com/jquery-migrate-3.5.2.js"></script>
The production build is minified and does not generate console warnings. It will only generate a console log message upon loading, or if it detects an error such as an outdated version of jQuery that it does not support. Do not use this file for development or debugging, it will make your life miserable.
| Development | Production | |
|---|---|---|
| Debugging enabled | ✓ | |
| Minified | ✓ | |
| Latest release (may be hotlinked if desired) | jquery-migrate-3.5.2.js | jquery-migrate-3.5.2.min.js |
| * Latest work-in-progress build | jquery-migrate-git.js | jquery-migrate-git.min.js |
* Work-in-progress build: Although this file represents the most recent updates to the plugin, it may not have been thoroughly tested. We do not recommend using this file on production sites since it may be unstable; use the released production version instead.
The development version of the plugin displays warnings in the browser console. Older browsers such as IE9 doesn't support the console interface. No messages will be generated unless you include a debugging library such as Firebug Lite before including the jQuery Migrate plugin. Developers can also inspect the jQuery.migrateWarnings array to see what error messages have been generated.
All warnings generated by this plugin start with the string "JQMIGRATE". A list of the warnings you may see are in warnings.md.
This plugin adds some properties to the jQuery object that can be used to programmatically control and examine its behavior:
jQuery.migrateWarnings: This property is an array of string warning messages that have been generated by the code on the page, in the order they were generated. Messages appear in the array only once, even if the condition has occurred multiple times, unless jQuery.migrateReset() is called.
jQuery.migrateMute: Set this property to true to prevent console warnings from being generated in the development version. The jQuery.migrateWarnings array is still maintained when this property is set, which allows programmatic inspection without console output.
jQuery.migrateTrace: Set this property to false if you want warnings but do not want stack traces to appear on the console.
jQuery.migrateReset(): This method clears the jQuery.migrateWarnings array and "forgets" the list of messages that have been seen already.
jQuery.migrateVersion: This string property indicates the version of Migrate in use.
jQuery.migrateDeduplicateWarnings: By default, Migrate only gives a specific warning once. If you set this property to false it will give a warning for every occurrence each time it happens. Note that this can generate a lot of output, for example when a warning occurs in a loop.
jQuery.migrateDisablePatches: Disables patches by their codes. You can find a code for each patch in square brackets in warnings.md. A limited number of warnings doesn't have codes defined and cannot be disabled. These are mostly setup issues like using an incorrect version of jQuery or loading Migrate multiple times.
jQuery.migrateDisablePatches: Disables patches by their codes.
jQuery.migrateIsPatchEnabled: Returns true if a patch of a provided code is enabled and false otherwise.
jQuery.UNSAFE_restoreLegacyHtmlPrefilter: A deprecated alias of jQuery.migrateEnablePatches( "self-closed-tags" )
Bugs that only occur when the jQuery Migrate plugin is used should be reported in the jQuery Migrate Issue Tracker and should be accompanied by an executable test case that demonstrates the bug. The easiest way to do this is via an online test tool such as jsFiddle.net or jsbin.com. Use the development version when you are reporting bugs.
Bugs in jQuery itself should be reported on the jQuery Core bug tracker and again should be accompanied by a test case from jsFiddle.net or jsbin.com so that we can reproduce the issue.
For other questions about the plugin that aren't bugs, ask on the jQuery Forum.
npm commands$ git clone git://github.com/jquery/jquery-migrate.git
$ cd jquery-migrate
$ npm install
$ npm run build
$ npm test
$ npm run test:server
and open http://localhost:3000/test/ in your browser.
FAQs
Migrate older jQuery code to jQuery 3.0+
The npm package jquery-migrate receives a total of 153,603 weekly downloads. As such, jquery-migrate popularity was classified as popular.
We found that jquery-migrate demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.