by jquery

jquery / jquery

jQuery JavaScript Library

54.1K Stars 19.6K Forks Last release: 6 months ago (3.5.0) MIT License 6.5K Commits 152 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

jQuery — New Wave JavaScript

FOSSA Status


Contribution Guides

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 Foundation Projects

Environments in which to use jQuery

  • Browser support
  • jQuery also supports Node, browser extensions, and other non-browser environments.

What you need to build your own jQuery

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 install git and Node.js.

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.

How to build your own jQuery

First, clone the jQuery git repo.

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

cd jquery && npm run build
The built version of jQuery will be put in the
subdirectory, along with the minified copy and associated map file.

If you want to create custom build or help with jQuery development, it would be better to install grunt command line interface as a global package:

npm install -g grunt-cli

Make sure you have

installed by testing:
grunt -V

Now by running the

command, in the jquery directory, you can build a full version of jQuery, just like with an
npm run build

There are many other tasks available for jQuery Core:

grunt -help


Special builds can be created that exclude subsets of jQuery functionality. This allows for smaller custom builds when the builder is certain that those parts of jQuery are not being used. For example, an app that only used JSONP for

and did not need to calculate offsets or positions of elements could exclude the offset and ajax/xhr modules.

Any module may be excluded except for

, and
. To exclude a module, pass its path relative to the
folder (without the

Some example modules that can be excluded are:

  • ajax: All AJAX functionality:
    , transports, and ajax event shorthands such as
  • ajax/xhr: The XMLHTTPRequest AJAX transport only.
  • ajax/script: The
     AJAX transport only; used to retrieve scripts.
  • ajax/jsonp: The JSONP AJAX transport only; depends on the ajax/script transport.
  • css: The
    method. Also removes all modules depending on css (including effects, dimensions, and offset).
  • css/showHide: Non-animated
    ; can be excluded if you use classes or explicit
    calls to set the
    property. Also removes the effects module.
  • deprecated: Methods documented as deprecated but not yet removed.
  • dimensions: The
    methods, including
  • effects: The
    method and its shorthands such as
  • event: The
    methods and all event functionality.
  • event/trigger: The
  • offset: The
    , and
  • wrap: The
    , and
  • core/ready: Exclude the ready module if you place your scripts at the end of the body. Any ready callbacks bound with
    will simply be called immediately. However,
    will not be a function and
    .on("ready", ...)
    or similar will not be triggered.
  • deferred: Exclude jQuery.Deferred. This also removes jQuery.Callbacks. Note that modules that depend on jQuery.Deferred(AJAX, effects, core/ready) will not be removed and will still expect jQuery.Deferred to be there. Include your own jQuery.Deferred implementation or exclude those modules as well (
    grunt custom:-deferred,-ajax,-effects,-core/ready
  • exports/global: Exclude the attachment of global jQuery variables ($ and jQuery) to the window.
  • exports/amd: Exclude the AMD definition.

The build process shows a message for each dependent module it excludes or includes.

AMD name

As an option, 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. Simply set the

grunt custom --amd="custom-name"

Or, to define anonymously, set the name to an empty string.

grunt custom --amd=""

Custom Build Examples

To create a custom build, first check out the version:

git pull; git checkout VERSION

Where VERSION is the version you want to customize. Then, make sure all Node dependencies are installed:

npm install

Create the custom build using the

grunt custom
option, listing the modules to be excluded.

Exclude all ajax functionality:

grunt custom:-ajax

Excluding css removes modules depending on CSS: effects, offset, dimensions.

grunt custom:-css

Exclude a bunch of modules:

grunt custom:-ajax/jsonp,-css,-deprecated,-dimensions,-effects,-offset,-wrap

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

grunt custom:slim

For questions or requests regarding custom builds, please start a thread on the Developing jQuery Core section of the forum. Due to the combinatorics and custom nature of these builds, they are not regularly tested in jQuery's unit test process.

Running the Unit Tests

Make sure you have the necessary dependencies:

npm install


grunt watch
npm start
to auto-build jQuery as you work:
grunt watch

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:

Building to a different directory

To copy the built jQuery files from

to another directory:
grunt && grunt dist:/path/to/special/location/

With this example, the output files would be:


To add a permanent copy destination, create a file in

called ".destination.json". Inside the file, paste and customize the following:
  "/Absolute/path/to/other/destination": true

Additionally, both methods can be combined.

Essential Git

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/master
git clean -fdx


For feature/topic branches, you should always use the

flag to
git 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.autosetuprebase local


man git-config
for more information)

Handling merge conflicts

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

QUnit Reference

Test methods

expect( numAssertions );

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.

Test assertions

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] );

Test Suite Convenience Methods Reference (See test/data/testinit.js)

Returns an array of elements with the given IDs

q( ... );


q("main", "foo", "bar");

=> [ div#main, span#foo, input#bar ]

Asserts that a selection matches the given IDs

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


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

Fires a native DOM event without going through jQuery

fireNative( node, eventType )


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

Add random number to url to stop caching

url( "some/url" );



=> "data/index.html?10538358428943"


=> "data/mock.php?foo=bar&10538358345554"

Run tests in an iframe

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

testIframe( testName, fileName,
  function testCallback(
      assert, jQuery, window, document,
      [ additional args ] ) {
  } );

This loads a page, constructing a url with fileName

"./data/" + fileName
. The iframed page determines when the callback occurs in the test by including the "/test/data/iframeTest.js" script and calling
startIframeTest( [ additional args ] )
when appropriate. Often this will be after either document ready or


receives the QUnit
object created by
for this test, followed by the global
, and
from the iframe. If the iframe code passes any arguments to
, they follow the


If you have any questions, please feel free to ask on the Developing jQuery Core forum or in #jquery on irc.freenode.net.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.