Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 372 lines (247 sloc) 12.907 kb
ebf2faca » xavierm02
2011-04-28 Javascript -> JavaScript except if it was intentional to avoid lettin…
1 [jQuery](http://jquery.com/) - New Wave JavaScript
d503845d » csnover
2011-01-17 Replace build system with a faster new one that uses Node and UglifyJ…
2 ==================================================
a1bb3ee4 » Michael Bensoussan
2009-11-03 from txt to markdown
3
65d3dc69 » rwaldron
2011-11-21 Landing pull request 611. Adds Contributing to jQuery Guidelines sect…
4 Contribution Guides
5 --------------------------------------
6
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:
b290b1fd » rwaldron
2011-12-11 Fix Contribution Guides list of links, hopefully easier to notice and…
8
e1a4329d » markelog
2013-12-31 Doc: Update links and simplify build instructions
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/)
65d3dc69 » rwaldron
2011-11-21 Landing pull request 611. Adds Contributing to jQuery Guidelines sect…
12
13
4d19306c » timmywil
2014-01-06 README: Add jQuery environment notes
14 Environments in which to use jQuery
15 --------------------------------------
16
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.
19
20
a1bb3ee4 » Michael Bensoussan
2009-11-03 from txt to markdown
21 What you need to build your own jQuery
d503845d » csnover
2011-01-17 Replace build system with a faster new one that uses Node and UglifyJ…
22 --------------------------------------
a1bb3ee4 » Michael Bensoussan
2009-11-03 from txt to markdown
23
359e3f57 » tricknotes
2013-01-14 Fix requirements and dependencies in README, close gh-1131.
24 In order to build jQuery, you need to have Node.js/npm latest and git 1.7 or later.
d503845d » csnover
2011-01-17 Replace build system with a faster new one that uses Node and UglifyJ…
25 (Earlier versions might work OK, but are not tested.)
a1bb3ee4 » Michael Bensoussan
2009-11-03 from txt to markdown
26
831a532c » markelog
2013-07-22 Change Windows install explanation
27 For Windows you have to download and install [git](http://git-scm.com/downloads) and [Node.js](http://nodejs.org/download/).
4e337f50 » dcneiner
2010-06-14 Updated README file with updated information for the Rake addtions
28
24571f4a » markelog
2013-07-22 Remove the Xcode note in readme
29 Mac OS users should install [Homebrew](http://mxcl.github.com/homebrew/). Once Homebrew is installed, run `brew install git` to install git,
d503845d » csnover
2011-01-17 Replace build system with a faster new one that uses Node and UglifyJ…
30 and `brew install node` to install Node.js.
4e337f50 » dcneiner
2010-06-14 Updated README file with updated information for the Rake addtions
31
359e3f57 » tricknotes
2013-01-14 Fix requirements and dependencies in README, close gh-1131.
32 Linux/BSD users should use their appropriate package managers to install git and Node.js, or build from source
d503845d » csnover
2011-01-17 Replace build system with a faster new one that uses Node and UglifyJ…
33 if you swing that way. Easy-peasy.
a1bb3ee4 » Michael Bensoussan
2009-11-03 from txt to markdown
34
35
d503845d » csnover
2011-01-17 Replace build system with a faster new one that uses Node and UglifyJ…
36 How to build your own jQuery
37 ----------------------------
a1bb3ee4 » Michael Bensoussan
2009-11-03 from txt to markdown
38
ac7ff97f » timmywil
2013-11-14 Use grunt and bower packages as local dependencies. Close gh-1433.
39 Clone a copy of the main jQuery git repo by running:
7c23b77a » rwaldron
2012-06-04 Strips IIFEs from modules; Always require built jQuery for tests.
40
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
41 ```bash
42 git clone git://github.com/jquery/jquery.git
43 ```
7c23b77a » rwaldron
2012-06-04 Strips IIFEs from modules; Always require built jQuery for tests.
44
ac7ff97f » timmywil
2013-11-14 Use grunt and bower packages as local dependencies. Close gh-1433.
45 Enter the jquery directory and run the build script:
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
46 ```bash
e1a4329d » markelog
2013-12-31 Doc: Update links and simplify build instructions
47 cd jquery && npm run build
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
48 ```
ac7ff97f » timmywil
2013-11-14 Use grunt and bower packages as local dependencies. Close gh-1433.
49 The built version of jQuery will be put in the `dist/` subdirectory, along with the minified copy and associated map file.
7c23b77a » rwaldron
2012-06-04 Strips IIFEs from modules; Always require built jQuery for tests.
50
e1a4329d » markelog
2013-12-31 Doc: Update links and simplify build instructions
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:
7c23b77a » rwaldron
2012-06-04 Strips IIFEs from modules; Always require built jQuery for tests.
52
bc4e9763 » timmywil
2013-07-10 Update README for bower usage
53 ```
ac7ff97f » timmywil
2013-11-14 Use grunt and bower packages as local dependencies. Close gh-1433.
54 npm install -g grunt-cli
55 ```
56 Make sure you have `grunt` installed by testing:
57 ```
58 grunt -v
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
59 ```
7c23b77a » rwaldron
2012-06-04 Strips IIFEs from modules; Always require built jQuery for tests.
60
e1a4329d » markelog
2013-12-31 Doc: Update links and simplify build instructions
61 Now by running `grunt` command, in the jquery directory, you could build full version of jQuery, just like with `npm run build` command:
ac7ff97f » timmywil
2013-11-14 Use grunt and bower packages as local dependencies. Close gh-1433.
62 ```
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
63 grunt
64 ```
950b5d64 » jeresig
2010-03-01 Added in integrated JSLint checking against the jQuery source. Just r…
65
84190105 » dmethvin
2013-12-18 Readme: Fix typo, thanks @tcort
66 There are many other tasks available for jQuery Core:
ac7ff97f » timmywil
2013-11-14 Use grunt and bower packages as local dependencies. Close gh-1433.
67 ```
68 grunt -help
69 ```
7c23b77a » rwaldron
2012-06-04 Strips IIFEs from modules; Always require built jQuery for tests.
70
054c6946 » dmethvin
2013-02-28 Update docs about custom builds, including unSizzled version.
71 ### Modules
c68ab270 » mikesherov
2012-06-07 Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. …
72
054c6946 » dmethvin
2013-02-28 Update docs about custom builds, including unSizzled version.
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.
6318ae6a » timmywil
2013-08-15 AMD-ify jQuery sourcegit s! Woo! Fixes #14113, #14163.
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.
76
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).
78
79 Some example modules that can be excluded are:
c68ab270 » mikesherov
2012-06-07 Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. …
80
054c6946 » dmethvin
2013-02-28 Update docs about custom builds, including unSizzled version.
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.
6318ae6a » timmywil
2013-08-15 AMD-ify jQuery sourcegit s! Woo! Fixes #14113, #14163.
85 - **css**: The `.css()` method plus non-animated `.show()`, `.hide()` and `.toggle()`. Also removes **all** modules depending on css (including **effects**, **dimensions**, and **offset**).
054c6946 » dmethvin
2013-02-28 Update docs about custom builds, including unSizzled version.
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.
806b0230 » markelog
2013-07-22 Install bower packages with npm install
88 - **effects**: The `.animate()` method and its shorthands such as `.slideUp()` or `.hide("slow")`.
6318ae6a » timmywil
2013-08-15 AMD-ify jQuery sourcegit s! Woo! Fixes #14113, #14163.
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()`.
054c6946 » dmethvin
2013-02-28 Update docs about custom builds, including unSizzled version.
91 - **offset**: The `.offset()`, `.position()`, `.offsetParent()`, `.scrollLeft()`, and `.scrollTop()` methods.
5031c9db » dmethvin
2013-04-05 Fix #13741. Make wrap/unwrap methods optional. Close gh-1222.
92 - **wrap**: The `.wrap()`, `.wrapAll()`, `.wrapInner()`, and `.unwrap()` methods.
cecb52ff » timmywil
2013-08-15 Specify support as a dependency wherever it is used. Optimize module …
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.
6318ae6a » timmywil
2013-08-15 AMD-ify jQuery sourcegit s! Woo! Fixes #14113, #14163.
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`).
7e8a91c2 » timmywil
2013-12-19 Build: add build option for setting the AMD name.
95 - **exports/global**: Exclude the attachment of global jQuery variables ($ and jQuery) to the window.
96 - **exports/amd**: Exclude the AMD definition.
6318ae6a » timmywil
2013-08-15 AMD-ify jQuery sourcegit s! Woo! Fixes #14113, #14163.
97
98 As a special case, you may also replace Sizzle by using a special flag `grunt custom:-sizzle`.
99
054c6946 » dmethvin
2013-02-28 Update docs about custom builds, including unSizzled version.
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.
c68ab270 » mikesherov
2012-06-07 Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. …
101
bbbdd947 » mzgol
2013-08-27 Fix #10814. Make support tests lazy and broken out to components.
102 *Note*: Excluding Sizzle will also exclude all jQuery selector extensions (such as `effects/animatedSelector` and `css/hiddenVisibleSelectors`).
6318ae6a » timmywil
2013-08-15 AMD-ify jQuery sourcegit s! Woo! Fixes #14113, #14163.
103
104 The build process shows a message for each dependent module it excludes or includes.
c68ab270 » mikesherov
2012-06-07 Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. …
105
7e8a91c2 » timmywil
2013-12-19 Build: add build option for setting the AMD name.
106 ##### AMD name
107
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:
109
110 ```bash
111 grunt custom --amd="custom-name"
112 ```
113
114 Or, to define anonymously, set the name to an empty string.
115
116 ```bash
117 grunt custom --amd=""
118 ```
119
120 #### Custom Build Examples
121
054c6946 » dmethvin
2013-02-28 Update docs about custom builds, including unSizzled version.
122 To create a custom build of the latest stable version, first check out the version:
6b9fde13 » mathiasbynens
2012-08-12 Add README info on how to create custom builds. Close gh-892.
123
124 ```bash
125 git pull; git checkout $(git describe --abbrev=0 --tags)
126 ```
127
b13d8229 » timmywil
2013-07-10 Include Sizzle and Qunit with bower. Fixes #14118.
128 Then, make sure all Node dependencies are installed:
6b9fde13 » mathiasbynens
2012-08-12 Add README info on how to create custom builds. Close gh-892.
129
130 ```bash
b13d8229 » timmywil
2013-07-10 Include Sizzle and Qunit with bower. Fixes #14118.
131 npm install
6b9fde13 » mathiasbynens
2012-08-12 Add README info on how to create custom builds. Close gh-892.
132 ```
133
7e8a91c2 » timmywil
2013-12-19 Build: add build option for setting the AMD name.
134 Create the custom build using the `grunt custom` option, listing the modules to be excluded.
c68ab270 » mikesherov
2012-06-07 Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. …
135
054c6946 » dmethvin
2013-02-28 Update docs about custom builds, including unSizzled version.
136 Exclude all **ajax** functionality:
50192771 » jaubourg
2012-06-12 Adds ajax to the list of optional modules.
137
138 ```bash
f13de6b3 » rwaldron
2012-06-12 Simplify the terminal command args syntax for custom builds. Update R…
139 grunt custom:-ajax
140 ```
141
6318ae6a » timmywil
2013-08-15 AMD-ify jQuery sourcegit s! Woo! Fixes #14113, #14163.
142 Excluding **css** removes modules depending on CSS: **effects**, **offset**, **dimensions**.
f13de6b3 » rwaldron
2012-06-12 Simplify the terminal command args syntax for custom builds. Update R…
143
144 ```bash
6318ae6a » timmywil
2013-08-15 AMD-ify jQuery sourcegit s! Woo! Fixes #14113, #14163.
145 grunt custom:-css
50192771 » jaubourg
2012-06-12 Adds ajax to the list of optional modules.
146 ```
147
6318ae6a » timmywil
2013-08-15 AMD-ify jQuery sourcegit s! Woo! Fixes #14113, #14163.
148 Exclude a bunch of modules:
a2758377 » rwaldron
2012-06-25 Adds src/deprecated.js, test/unit/deprecated.js; -deprecated flag; Mo…
149
150 ```bash
6318ae6a » timmywil
2013-08-15 AMD-ify jQuery sourcegit s! Woo! Fixes #14113, #14163.
151 grunt custom:-ajax,-css,-deprecated,-dimensions,-effects,-event/alias,-offset,-wrap
a2758377 » rwaldron
2012-06-25 Adds src/deprecated.js, test/unit/deprecated.js; -deprecated flag; Mo…
152 ```
153
054c6946 » dmethvin
2013-02-28 Update docs about custom builds, including unSizzled version.
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.
c68ab270 » mikesherov
2012-06-07 Modularize offset (exclude w/ grunt build:*:*:-offset). Closes #813. …
155
7c23b77a » rwaldron
2012-06-04 Strips IIFEs from modules; Always require built jQuery for tests.
156 Running the Unit Tests
157 --------------------------------------
158
bc4e9763 » timmywil
2013-07-10 Update README for bower usage
159 Make sure you have the necessary dependencies:
160
161 ```bash
ac7ff97f » timmywil
2013-11-14 Use grunt and bower packages as local dependencies. Close gh-1433.
162 npm install
bc4e9763 » timmywil
2013-07-10 Update README for bower usage
163 ```
164
ac7ff97f » timmywil
2013-11-14 Use grunt and bower packages as local dependencies. Close gh-1433.
165 Start `grunt watch` or `npm start` to auto-build jQuery as you work:
7c23b77a » rwaldron
2012-06-04 Strips IIFEs from modules; Always require built jQuery for tests.
166
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
167 ```bash
168 cd jquery && grunt watch
169 ```
7c23b77a » rwaldron
2012-06-04 Strips IIFEs from modules; Always require built jQuery for tests.
170
171
710962c8 » ksieburg
2013-02-21 Updated readme to have more info. Closes gh-1177
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:
7c23b77a » rwaldron
2012-06-04 Strips IIFEs from modules; Always require built jQuery for tests.
173
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/)
178
179
a1bb3ee4 » Michael Bensoussan
2009-11-03 from txt to markdown
180
4e337f50 » dcneiner
2010-06-14 Updated README file with updated information for the Rake addtions
181
182 Building to a different directory
d503845d » csnover
2011-01-17 Replace build system with a faster new one that uses Node and UglifyJ…
183 ---------------------------------
4e337f50 » dcneiner
2010-06-14 Updated README file with updated information for the Rake addtions
184
b0e40a4f » dmethvin
2013-01-02 Update README to include grunt-cli step.
185 To copy the built jQuery files from `/dist` to another directory:
a1bb3ee4 » Michael Bensoussan
2009-11-03 from txt to markdown
186
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
187 ```bash
188 grunt && grunt dist:/path/to/special/location/
189 ```
7c23b77a » rwaldron
2012-06-04 Strips IIFEs from modules; Always require built jQuery for tests.
190 With this example, the output files would be:
191
192 ```bash
9fb3c01c » rwaldron
2012-06-07 Make custom dist example less OSX specific
193 /path/to/special/location/jquery.js
194 /path/to/special/location/jquery.min.js
7c23b77a » rwaldron
2012-06-04 Strips IIFEs from modules; Always require built jQuery for tests.
195 ```
4e337f50 » dcneiner
2010-06-14 Updated README file with updated information for the Rake addtions
196
b0e40a4f » dmethvin
2013-01-02 Update README to include grunt-cli step.
197 To add a permanent copy destination, create a file in `dist/` called ".destination.json". Inside the file, paste and customize the following:
8265fa08 » rwaldron
2012-06-05 Allow users to store custom dist destinations in dist/.destination.json
198
199 ```json
200
201 {
202 "/Absolute/path/to/other/destination": true
203 }
204 ```
205
206 Additionally, both methods can be combined.
207
208
4e337f50 » dcneiner
2010-06-14 Updated README file with updated information for the Rake addtions
209
b0e40a4f » dmethvin
2013-01-02 Update README to include grunt-cli step.
210 Essential Git
211 -------------
5dde3eb4 » azatoth
2011-04-08 Git for dummies
212
44247b1c » dmethvin
2014-03-13 Readme: Fix subsection titles and grammar, thanks @robgraeber
213 As the source code is handled by the Git version control system, it's useful to know some features used.
5dde3eb4 » azatoth
2011-04-08 Git for dummies
214
44247b1c » dmethvin
2014-03-13 Readme: Fix subsection titles and grammar, thanks @robgraeber
215 ### Cleaning ###
5dde3eb4 » azatoth
2011-04-08 Git for dummies
216
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):
218
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
219 ```bash
220 git reset --hard upstream/master
221 git clean -fdx
222 ```
5dde3eb4 » azatoth
2011-04-08 Git for dummies
223
44247b1c » dmethvin
2014-03-13 Readme: Fix subsection titles and grammar, thanks @robgraeber
224 ### Rebasing ###
5dde3eb4 » azatoth
2011-04-08 Git for dummies
225
943dc6cf » datag
2013-10-11 No ticket: Correct typo in README section "rebasing". Close gh-1398.
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:
5dde3eb4 » azatoth
2011-04-08 Git for dummies
227
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
228 ```bash
229 git config branch.autosetuprebase local
230 ```
231 (see `man git-config` for more information)
5dde3eb4 » azatoth
2011-04-08 Git for dummies
232
44247b1c » dmethvin
2014-03-13 Readme: Fix subsection titles and grammar, thanks @robgraeber
233 ### Handling merge conflicts ###
5dde3eb4 » azatoth
2011-04-08 Git for dummies
234
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.
237
238 Following are some commands that can be used there:
239
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
7627b8b6 » mzgol
2013-08-12 correct a typo in README
243 * `u` - undo a merge
5dde3eb4 » azatoth
2011-04-08 Git for dummies
244 * `left mouse button` - mark a block to be the winner
245 * `middle mouse button` - mark a line to be the winner
246 * `Ctrl + S` - save
247 * `Ctrl + Q` - quit
4e337f50 » dcneiner
2010-06-14 Updated README file with updated information for the Rake addtions
248
594687ab » leobalter
2014-01-22 Readme: updating QUnit information
249 [QUnit](http://api.qunitjs.com) Reference
a8d9d053 » timmywil
2012-05-29 Add quick-start documentation for testing with QUnit and using jQuery…
250 -----------------
251
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
252 ### Test methods ###
253
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
254 ```js
255 expect( numAssertions );
256 stop();
257 start();
258 ```
259
260
44247b1c » dmethvin
2014-03-13 Readme: Fix subsection titles and grammar, thanks @robgraeber
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
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
262
263 ### Test assertions ###
264
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
265
266 ```js
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] );
0fcb0f68 » mzgol
2014-02-05 Docs: Change raises to throws in README test assertions
274 throws( block, [expected], [message] );
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
275 ```
276
a8d9d053 » timmywil
2012-05-29 Add quick-start documentation for testing with QUnit and using jQuery…
277
278 Test Suite Convenience Methods Reference (See [test/data/testinit.js](https://github.com/jquery/jquery/blob/master/test/data/testinit.js))
279 ------------------------------
280
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
281 ### Returns an array of elements with the given IDs ###
282
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
283 ```js
284 q( ... );
285 ```
286
287 Example:
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
288
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
289 ```js
290 q("main", "foo", "bar");
291
292 => [ div#main, span#foo, input#bar ]
293 ```
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
294
162ffe72 » timmywil
2012-05-29 Update README: IDs are without hashes in t()
295 ### Asserts that a selection matches the given IDs ###
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
296
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
297 ```js
298 t( testName, selector, [ "array", "of", "ids" ] );
299 ```
300
301 Example:
302
303 ```js
304 t("Check for something", "//[a]", ["foo", "baar"]);
305 ```
306
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
307
308
309 ### Fires a native DOM event without going through jQuery ###
310
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
311 ```js
312 fireNative( node, eventType )
313 ```
314
315 Example:
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
316
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
317 ```js
318 fireNative( jQuery("#elem")[0], "click" );
319 ```
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
320
321 ### Add random number to url to stop caching ###
322
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
323 ```js
324 url( "some/url.php" );
325 ```
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
326
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
327 Example:
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
328
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
329 ```js
330 url("data/test.html");
331
332 => "data/test.html?10538358428943"
333
334
335 url("data/test.php?foo=bar");
336
337 => "data/test.php?foo=bar&10538358345554"
338 ```
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
339
340
341 ### Load tests in an iframe ###
342
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.
346
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
347 ```js
348 testIframe( fileName, testName, callback );
349 ```
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
350
351 Callback arguments:
352
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
353 ```js
354 callback( jQueryFromIFrame, iFrameWindow, iFrameDocument );
355 ```
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
356
357 ### Load tests in an iframe (window.iframeCallback) ###
358
359 Loads a given page constructing a url with fileName: `"./data/" + fileName + ".html"`
44247b1c » dmethvin
2014-03-13 Readme: Fix subsection titles and grammar, thanks @robgraeber
360 The given callback is fired when window.iframeCallback is called by the page.
5660b6df » timmywil
2012-05-29 Update README to stylize docs on jQuery's test suite methods
361 The arguments passed to the callback are the same as the
362 arguments passed to window.iframeCallback, whatever that may be
363
3b2d2b02 » rwaldron
2012-06-07 Make readme code examples consistent; Update to use GH syntax fences
364 ```js
365 testIframeWithCallback( testName, fileName, callback );
366 ```
a8d9d053 » timmywil
2012-05-29 Add quick-start documentation for testing with QUnit and using jQuery…
367
4e337f50 » dcneiner
2010-06-14 Updated README file with updated information for the Rake addtions
368 Questions?
369 ----------
a1bb3ee4 » Michael Bensoussan
2009-11-03 from txt to markdown
370
d503845d » csnover
2011-01-17 Replace build system with a faster new one that uses Node and UglifyJ…
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.
Something went wrong with that request. Please try again.