jQuery

The 3.x branch will now only receive critical updates. The 2.x and 1.x branches are no longer supported. We recommend that all users upgrade to the latest version of jQuery to ensure that they have the best performance, security, and features. In the spirit of open source software development, jQuery always encourages community code contribution. To help you get started and before you jump into writing code, be sure to read these important contribution guidelines thoroughly: 1. Getting Involved 2. Core Style Guide 3. Writing Code for jQuery Projects GitHub issues/PRs are usually referenced via gh-NUMBER , where NUMBER is the numerical ID of the issue/PR. You can find such an issue/PR under Environments in which to use jQuery Browser support jQuery also supports Node, browser extensions, and other non-browser environments. To build jQuery, you need to have the latest Node.js/npm and git 1.7 or later. Earlier versions might work, but are not supported. macOS users should install Homebrew. Once Homebrew is installed, run brew install git to install git, and brew install node to install Node.js. Linux/BSD users should use their appropriate package managers to install git and Node.js, or build from source if you swing that way. Easy-peasy. The built version of jQuery will be placed in the dist/ directory, along with a minified copy and associated map file. This will create all of the variants that jQuery includes in a release, including jquery.js , jquery.slim.js , jquery.module.js , and jquery.slim.module.js along their associated minified files and sourcemaps. jquery.module.js and jquery.slim.module.js are ECMAScript modules that export jQuery and $ as named exports are placed in the dist-module/ directory rather than the dist/ directory. The build script can be used to create a custom version of jQuery that includes only the modules you need. Any module may be excluded except for core . When excluding selector , it is not removed but replaced with a small wrapper around native querySelectorAll (see below for more information). To exclude a module, pass its path relative to the src folder (without the .js extension) to the --exclude option. When using the --include option, the default includes are dropped and a build is created with only those modules. Note : Excluding the full selector module will also exclude all jQuery selector extensions (such as effects/animatedSelector and css/hiddenVisibleSelectors ). You can set the module name for jQuery's AMD definition. By default, it is set to "jquery", which plays nicely with plugins and third-party libraries, but there may be cases where you'd like to change this. Pass it to the --amd parameter: The default name for the built jQuery file is jquery.js ; it is placed under the dist/ directory. It's possible to change the file name using --filename and the directory using --dir . --dir is relative to the project root. By default, jQuery generates a regular script JavaScript file. You can also generate an ECMAScript module exporting jQuery as the default export using the --esm parameter: By default, jQuery depends on a global window . For environments that don't have one, you can generate a factory build that exposes a function accepting window as a parameter that you can provide externally (see README of the published package for usage instructions). You can generate such a factory using the --factory parameter: Create a custom build using npm run build , listing the modules to be excluded. Excluding a top-level module also excludes its corresponding directory of modules. Non-official custom builds are not regularly tested. Use them at your own risk. As the source code is handled by the Git version control system, it's useful to know some features used. If you're getting merge conflicts when merging, instead of editing the conflicted files manually, you can use the feature git mergetool . Even though the default tool xxdiff looks awful/old, it's rather useful. So