1 [jQuery](http://jquery.com/) - New Wave JavaScript
2 ==================================================
5 --------------------------------------
7 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:
9 1. [Getting Involved](http://contribute.jquery.org/)
10 2. [Core Style Guide](http://contribute.jquery.org/style-guide/js/)
11 3. [Writing Code for jQuery Foundation Projects](http://contribute.jquery.org/code/)
14 Environments in which to use jQuery
15 --------------------------------------
17 - [Browser support](http://jquery.com/browser-support/) differs between the master (2.x) branch and the 1.x-master branch. Specifically, 2.x does not support legacy browsers such as IE6-8. The jQuery team continues to provide support for legacy browsers on the 1.x-master branch. Use the latest 1.x release if support for those browsers is required. See [browser support](http://jquery.com/browser-support/) for more info.
18 - To use jQuery in Node, browser extensions, and other non-browser environments, use only **2.x** releases. 1.x does not support these environments.
21 What you need to build your own jQuery
22 --------------------------------------
24 In order to build jQuery, you need to have Node.js/npm latest and git 1.7 or later.
25 (Earlier versions might work OK, but are not tested.)
27 For Windows you have to download and install [git](http://git-scm.com/downloads) and [Node.js](http://nodejs.org/download/).
29 Mac OS users should install [Homebrew](http://mxcl.github.com/homebrew/). Once Homebrew is installed, run `brew install git` to install git,
30 and `brew install node` to install Node.js.
32 Linux/BSD users should use their appropriate package managers to install git and Node.js, or build from source
33 if you swing that way. Easy-peasy.
36 How to build your own jQuery
37 ----------------------------
39 Clone a copy of the main jQuery git repo by running:
42 git clone git://github.com/jquery/jquery.git
45 Enter the jquery directory and run the build script:
47 cd jquery && npm run build
49 The built version of jQuery will be put in the `dist/` subdirectory, along with the minified copy and associated map file.
51 If you want create custom build or help with jQuery development, it would be better to install [grunt command line interface](https://github.com/gruntjs/grunt-cli) as a global package:
54 npm install -g grunt-cli
56 Make sure you have `grunt` installed by testing:
61 Now by running `grunt` command, in the jquery directory, you could build full version of jQuery, just like with `npm run build` command:
66 There are many other tasks available for jQuery Core:
73 Special builds can be created that exclude subsets of jQuery functionality.
74 This allows for smaller custom builds when the builder is certain that those parts of jQuery are not being used.
75 For example, an app that only used JSONP for `$.ajax()` and did not need to calculate offsets or positions of elements could exclude the offset and ajax/xhr modules.
77 Any module may be excluded except for `core`, and `selector`. To exclude a module, pass its path relative to the `src` folder (without the `.js` extension).
79 Some example modules that can be excluded are:
81 - **ajax**: All AJAX functionality: `$.ajax()`, `$.get()`, `$.post()`, `$.ajaxSetup()`, `.load()`, transports, and ajax event shorthands such as `.ajaxStart()`.
82 - **ajax/xhr**: The XMLHTTPRequest AJAX transport only.
83 - **ajax/script**: The `<script>` AJAX transport only; used to retrieve scripts.
84 - **ajax/jsonp**: The JSONP AJAX transport only; depends on the ajax/script transport.
85 - **css**: The `.css()` method plus non-animated `.show()`, `.hide()` and `.toggle()`. Also removes **all** modules depending on css (including **effects**, **dimensions**, and **offset**).
86 - **deprecated**: Methods documented as deprecated but not yet removed; currently only `.andSelf()`.
87 - **dimensions**: The `.width()` and `.height()` methods, including `inner-` and `outer-` variations.
88 - **effects**: The `.animate()` method and its shorthands such as `.slideUp()` or `.hide("slow")`.
89 - **event**: The `.on()` and `.off()` methods and all event functionality. Also removes `event/alias`.
90 - **event/alias**: All event attaching/triggering shorthands like `.click()` or `.mouseover()`.
91 - **offset**: The `.offset()`, `.position()`, `.offsetParent()`, `.scrollLeft()`, and `.scrollTop()` methods.
92 - **wrap**: The `.wrap()`, `.wrapAll()`, `.wrapInner()`, and `.unwrap()` methods.
93 - **core/ready**: Exclude the ready module if you place your scripts at the end of the body. Any ready callbacks bound with `jQuery()` will simply be called immediately. However, `jQuery(document).ready()` will not be a function and `.on("ready", ...)` or similar will not be triggered.
94 - **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`).
95 - **exports/global**: Exclude the attachment of global jQuery variables ($ and jQuery) to the window.
96 - **exports/amd**: Exclude the AMD definition.
98 As a special case, you may also replace Sizzle by using a special flag `grunt custom:-sizzle`.
100 - **sizzle**: The Sizzle selector engine. When this module is excluded, it is replaced by a rudimentary selector engine based on the browser's `querySelectorAll` method that does not support jQuery selector extensions or enhanced semantics. See the selector-native.js file for details.
102 *Note*: Excluding Sizzle will also exclude all jQuery selector extensions (such as `effects/animatedSelector` and `css/hiddenVisibleSelectors`).
104 The build process shows a message for each dependent module it excludes or includes.
108 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 `"amd"` option:
111 grunt custom --amd="custom-name"
114 Or, to define anonymously, set the name to an empty string.
117 grunt custom --amd=""
120 #### Custom Build Examples
122 To create a custom build of the latest stable version, first check out the version:
125 git pull; git checkout $(git describe --abbrev=0 --tags)
128 Then, make sure all Node dependencies are installed:
134 Create the custom build using the `grunt custom` option, listing the modules to be excluded.
136 Exclude all **ajax** functionality:
142 Excluding **css** removes modules depending on CSS: **effects**, **offset**, **dimensions**.
148 Exclude a bunch of modules:
151 grunt custom:-ajax,-css,-deprecated,-dimensions,-effects,-event/alias,-offset,-wrap
154 For questions or requests regarding custom builds, please start a thread on the [Developing jQuery Core](https://forum.jquery.com/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. The non-Sizzle selector engine currently does not pass unit tests because it is missing too much essential functionality.
156 Running the Unit Tests
157 --------------------------------------
159 Make sure you have the necessary dependencies:
165 Start `grunt watch` or `npm start` to auto-build jQuery as you work:
168 cd jquery && grunt watch
172 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:
174 - Windows: [WAMP download](http://www.wampserver.com/en/)
175 - Mac: [MAMP download](http://www.mamp.info/en/index.html)
176 - Linux: [Setting up LAMP](https://www.linux.com/learn/tutorials/288158-easy-lamp-server-installation)
177 - [Mongoose (most platforms)](http://code.google.com/p/mongoose/)
182 Building to a different directory
183 ---------------------------------
185 To copy the built jQuery files from `/dist` to another directory:
188 grunt && grunt dist:/path/to/special/location/
190 With this example, the output files would be:
193 /path/to/special/location/jquery.js
194 /path/to/special/location/jquery.min.js
197 To add a permanent copy destination, create a file in `dist/` called ".destination.json". Inside the file, paste and customize the following:
202 "/Absolute/path/to/other/destination": true
206 Additionally, both methods can be combined.
213 As the source code is handled by the version control system Git, it's useful to know some features used.
217 If you want to purge your working directory back to the status of upstream, following commands can be used (remember everything you've worked on is gone after these):
220 git reset --hard upstream/master
226 For feature/topic branches, you should always use the `--rebase` flag to `git pull`, or if you are usually handling many temporary "to be in a github pull request" branches, run following to automate this:
229 git config branch.autosetuprebase local
231 (see `man git-config` for more information)
233 ### handling merge conflicts ###
235 If you're getting merge conflicts when merging, instead of editing the conflicted files manually, you can use the feature
236 `git mergetool`. Even though the default tool `xxdiff` looks awful/old, it's rather useful.
238 Following are some commands that can be used there:
240 * `Ctrl + Alt + M` - automerge as much as possible
241 * `b` - jump to next merge conflict
242 * `s` - change the order of the conflicted lines
244 * `left mouse button` - mark a block to be the winner
245 * `middle mouse button` - mark a line to be the winner
249 [QUnit](http://docs.jquery.com/QUnit) Reference
255 expect( numAssertions );
261 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
263 ### Test assertions ###
267 ok( value, [message] );
268 equal( actual, expected, [message] );
269 notEqual( actual, expected, [message] );
270 deepEqual( actual, expected, [message] );
271 notDeepEqual( actual, expected, [message] );
272 strictEqual( actual, expected, [message] );
273 notStrictEqual( actual, expected, [message] );
274 raises( block, [expected], [message] );
278 Test Suite Convenience Methods Reference (See [test/data/testinit.js](https://github.com/jquery/jquery/blob/master/test/data/testinit.js))
279 ------------------------------
281 ### Returns an array of elements with the given IDs ###
290 q("main", "foo", "bar");
292 => [ div#main, span#foo, input#bar ]
295 ### Asserts that a selection matches the given IDs ###
298 t( testName, selector, [ "array", "of", "ids" ] );
304 t("Check for something", "//[a]", ["foo", "baar"]);
309 ### Fires a native DOM event without going through jQuery ###
312 fireNative( node, eventType )
318 fireNative( jQuery("#elem")[0], "click" );
321 ### Add random number to url to stop caching ###
324 url( "some/url.php" );
330 url("data/test.html");
332 => "data/test.html?10538358428943"
335 url("data/test.php?foo=bar");
337 => "data/test.php?foo=bar&10538358345554"
341 ### Load tests in an iframe ###
343 Loads a given page constructing a url with fileName: `"./data/" + fileName + ".html"`
344 and fires the given callback on jQuery ready (using the jQuery loading from that page)
345 and passes the iFrame's jQuery to the callback.
348 testIframe( fileName, testName, callback );
354 callback( jQueryFromIFrame, iFrameWindow, iFrameDocument );
357 ### Load tests in an iframe (window.iframeCallback) ###
359 Loads a given page constructing a url with fileName: `"./data/" + fileName + ".html"`
360 The given callback is fired when window.iframeCallback is called by the page
361 The arguments passed to the callback are the same as the
362 arguments passed to window.iframeCallback, whatever that may be
365 testIframeWithCallback( testName, fileName, callback );
371 If you have any questions, please feel free to ask on the
372 [Developing jQuery Core forum](http://forum.jquery.com/developing-jquery-core) or in #jquery on irc.freenode.net.