Repository files navigation

Meetings are currently held on thematrix.org platform.

Meeting minutes can be found atmeetings.jquery.org.

The latest version of jQuery is available athttps://jquery.com/download/.

Once 4.0.0 final is released, the 3.x branch will continue to receive updates for a limited time. The 2.x and 1.x branches are no longer supported.

Commercial support for inactive versions is available fromHeroDevs.

Learn more about ourversion support.

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 viagh-NUMBER, whereNUMBER is the numerical ID of the issue/PR. You can find such an issue/PR underhttps://github.com/jquery/jquery/issues/NUMBER.

jQuery has used a different bug tracker - based on Trac - in the past, available underbugs.jquery.com. It is being kept in read only mode so that referring to past discussions is possible. When jQuery source references one of those issues, it uses the patterntrac-NUMBER, whereNUMBER is the numerical ID of the issue. You can find such an issue underhttps://bugs.jquery.com/ticket/NUMBER.

• 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.

For Windows, you have to download and installgit andNode.js.

macOS users should installHomebrew. Once Homebrew is installed, runbrew install git to install git,andbrew install node to install Node.js.

Linux/BSD users should use their appropriate package managers to install git and Node.js, or build from sourceif you swing that way. Easy-peasy.

First,clone the jQuery git repo.

Then, enter the jquery directory, install dependencies, and run the build script:

cd jquerynpm installnpm run build

The built version of jQuery will be placed in thedist/ directory, along with a minified copy and associated map file.

To build all variants of jQuery, run the following command:

npm run build:all

This will create all of the variants that jQuery includes in a release, includingjquery.js,jquery.slim.js,jquery.module.js, andjquery.slim.module.js along their associated minified files and sourcemaps.

jquery.module.js andjquery.slim.module.js areECMAScript modules that exportjQuery and$ as named exports are placed in thedist-module/ directory rather than thedist/ 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 forcore. When excludingselector, it is not removed but replaced with a small wrapper around nativequerySelectorAll (see below for more information).

To see the full list of available options for the build script, run the following:

npm run build -- --help

To exclude a module, pass its path relative to thesrc 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.

Some example modules that can be excluded or included are:

• ajax: All AJAX functionality:$.ajax(),$.get(),$.post(),$.ajaxSetup(),.load(), transports, and ajax event shorthands such as.ajaxStart().

• ajax/xhr: The XMLHTTPRequest AJAX transport only.

• ajax/script: The<script> AJAX transport only; used to retrieve scripts.

• ajax/jsonp: The JSONP AJAX transport only; depends on the ajax/script transport.

• css: The.css() method. Also removesall modules depending on css (includingeffects,dimensions, andoffset).

• css/showHide: Non-animated.show(),.hide() and.toggle(); can be excluded if you use classes or explicit.css() calls to set thedisplay property. Also removes theeffects module.

• deprecated: Methods documented as deprecated but not yet removed.

• dimensions: The.width() and.height() methods, includinginner- andouter- variations.

• effects: The.animate() method and its shorthands such as.slideUp() or.hide("slow").

• event: The.on() and.off() methods and all event functionality.

• event/trigger: The.trigger() and.triggerHandler() methods.

• offset: The.offset(),.position(),.offsetParent(),.scrollLeft(), and.scrollTop() methods.

• wrap: The.wrap(),.wrapAll(),.wrapInner(), and.unwrap() methods.

• core/ready: Exclude the ready module if you place your scripts at the end of the body. Any ready callbacks bound withjQuery() will simply be called immediately. However,jQuery(document).ready() will not be a function and.on("ready", ...) or similar will not be triggered.

• deferred: Exclude jQuery.Deferred. This also excludes all modules that rely on Deferred, includingajax,effects, andqueue, but replacescore/ready withcore/ready-no-deferred.

• exports/global: Exclude the attachment of global jQuery variables ($ and jQuery) to the window.

• exports/amd: Exclude the AMD definition.

• selector: The full jQuery selector engine. When this module is excluded, it is replaced with a rudimentary selector engine based on the browser'squerySelectorAll method that does not support jQuery selector extensions or enhanced semantics. See theselector-native.js file for details.

Note: Excluding the fullselector module will also exclude all jQuery selector extensions (such aseffects/animatedSelector andcss/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:

npm run build -- --amd="custom-name"

Or, to define anonymously, leave the name blank.

npm run build -- --amd

The default name for the built jQuery file isjquery.js; it is placed under thedist/ directory. It's possible to change the file name using--filename and the directory using--dir.--dir is relative to the project root.

npm run build -- --slim --filename="jquery.slim.js" --dir="/tmp"

This would create a slim version of jQuery and place it undertmp/jquery.slim.js.

By default, jQuery generates a regular script JavaScript file. You can also generate an ECMAScript module exportingjQuery as the default export using the--esm parameter:

npm run build -- --filename=jquery.module.js --esm

By default, jQuery depends on a globalwindow. For environments that don't have one, you can generate a factory build that exposes a function acceptingwindow as a parameter that you can provide externally (seeREADME of the published package for usage instructions). You can generate such a factory using the--factory parameter:

npm run build -- --filename=jquery.factory.js --factory

This option can be mixed with others like--esm or--slim:

npm run build -- --filename=jquery.factory.slim.module.js --factory --esm --slim --dir="/dist-module"

Create a custom build usingnpm run build, listing the modules to be excluded. Excluding a top-level module also excludes its corresponding directory of modules.

Exclude allajax functionality:

npm run build -- --exclude=ajax

Excludingcss removes modules depending on CSS:effects,offset,dimensions.

npm run build -- --exclude=css

Exclude a bunch of modules (-e is an alias for--exclude):

npm run build -- -e ajax/jsonp -e css -e deprecated -e dimensions -e effects -e offset -e wrap

There is a special alias to generate a build with the same configuration as the official jQuery Slim build:

npm run build -- --filename=jquery.slim.js --slim

Or, to create the slim build as an esm module:

npm run build -- --filename=jquery.slim.module.js --slim --esm

Non-official custom builds are not regularly tested. Use them at your own risk.

Make sure you have the necessary dependencies:

npm install

Startnpm start to auto-build jQuery as you work:

npm start

Run the unit tests with a local server that supports PHP. Ensure that you run the site from the root directory, not the "test" directory. No database is required. Pre-configured php local servers are available for Windows and Mac. Here are some options:

• Windows:WAMP download
• Mac:MAMP download
• Linux:Setting up LAMP
• Mongoose (most platforms)

As the source code is handled by the Git version control system, it's useful to know some features used.

If you want to purge your working directory back to the status of upstream, the following commands can be used (remember everything you've worked on is gone after these):

git reset --hard upstream/maingit clean -fdx

For feature/topic branches, you should always use the--rebase flag togit pull, or if you are usually handling many temporary "to be in a github pull request" branches, run the following to automate this:

git config branch.autosetuprebaselocal

(seeman git-config for more information)

If you're getting merge conflicts when merging, instead of editing the conflicted files manually, you can use the featuregit mergetool. Even though the default toolxxdiff looks awful/old, it's rather useful.

The following are some commands that can be used there:

• Ctrl + Alt + M - automerge as much as possible
• b - jump to next merge conflict
• s - change the order of the conflicted lines
• u - undo a merge
• left mouse button - mark a block to be the winner
• middle mouse button - mark a line to be the winner
• Ctrl + S - save
• Ctrl + Q - quit

expect(numAssertions);stop();start();

Note: QUnit's eventual addition of an argument to stop/start is ignored in this test suite so that start and stop can be passed as callbacks without worrying about their parameters.

ok(value,[message]);equal(actual,expected,[message]);notEqual(actual,expected,[message]);deepEqual(actual,expected,[message]);notDeepEqual(actual,expected,[message]);strictEqual(actual,expected,[message]);notStrictEqual(actual,expected,[message]);throws(block,[expected],[message]);

Seetest/data/testinit.js.

q( ...);

Example:

q("main","foo","bar");=>[div#main,span#foo,input#bar]

t(testName,selector,["array","of","ids"]);

Example:

t("Check for something","//[a]",["foo","bar"]);

fireNative(node,eventType);

Example:

fireNative(jQuery("#elem")[0],"click");

url("some/url");

Example:

url("index.html");=>"data/index.html?10538358428943"url("mock.php?foo=bar");=>"data/mock.php?foo=bar&10538358345554"

Some tests may require a document other than the standard test fixture, andthese can be run in a separate iframe. The actual test code and assertionsremain in jQuery's main test files; only the minimal test fixture markupand setup code should be placed in the iframe file.

testIframe(testName,fileName,functiontestCallback(assert,jQuery,window,document,[additionalargs]){...});

This loads a page, constructing a url with fileName"./data/" + fileName.The iframed page determines when the callback occurs in the test byincluding the "/test/data/iframeTest.js" script and callingstartIframeTest( [ additional args ] ) when appropriate. Often thiswill be after either document ready orwindow.onload fires.

ThetestCallback receives the QUnitassert object created bytestIframefor this test, followed by the globaljQuery,window, anddocument fromthe iframe. If the iframe code passes any arguments tostartIframeTest,they follow thedocument argument.

If you have any questions, please feel free to ask on theDeveloping jQuery Core forum or in #jquery onlibera.