diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 000000000..8b808995d
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.js, *.xsl]
+indent_style = tab
diff --git a/.github/configs/hydra-config.json b/.github/configs/hydra-config.json
new file mode 100644
index 000000000..2173722b4
--- /dev/null
+++ b/.github/configs/hydra-config.json
@@ -0,0 +1,10 @@
+{
+ "//": [
+ "2023-05: twitter.com serves broken redirect-loop",
+ "2025-04: The oembed endpoint responds HTTP 429 Too Many Requests too often; perhaps because almost every page links to one"
+ ],
+ "exclude_scheme_prefixes": [
+ "https://twitter.com/",
+ "https://api.jquery.com/wp-json/oembed/1.0/embed"
+ ]
+}
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 000000000..aa2f74565
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,13 @@
+version: 2
+updates:
+ - package-ecosystem: github-actions
+ directory: "/"
+ schedule:
+ interval: monthly
+
+ # Group all dependabot version update PRs into one
+ groups:
+ github-actions:
+ applies-to: version-updates
+ patterns:
+ - "*"
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
new file mode 100644
index 000000000..26f673d8d
--- /dev/null
+++ b/.github/workflows/node.js.yml
@@ -0,0 +1,30 @@
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+ pull_request:
+ push:
+ branches-ignore: "dependabot/**"
+
+jobs:
+ build:
+
+ runs-on: ubuntu-latest
+
+ strategy:
+ matrix:
+ node-version: [18.x, 20.x]
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+ - name: Install xmllint
+ run: sudo apt-get install -y libxml2-utils
+ - name: Use Node.js ${{ matrix.node-version }}
+ uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+ with:
+ node-version: ${{ matrix.node-version }}
+ cache: 'npm'
+ - run: npm ci
+ - run: npm test
diff --git a/.github/workflows/spider-check.yaml b/.github/workflows/spider-check.yaml
new file mode 100644
index 000000000..95ea1ea24
--- /dev/null
+++ b/.github/workflows/spider-check.yaml
@@ -0,0 +1,32 @@
+name: spider-check
+on:
+ # Once a week on Friday at 00:00
+ schedule:
+ - cron: '0 0 * * 5'
+ # Or manually
+ workflow_dispatch:
+ # Or when developing this workflow
+ push:
+ paths:
+ - .github/workflows/spider-check.yaml
+ - .github/configs/hydra-config.json
+ pull_request:
+ paths:
+ - .github/workflows/spider-check.yaml
+ - .github/configs/hydra-config.json
+
+jobs:
+ spider-check:
+ if: ${{ github.repository_owner == 'jquery' }} # skip on forks
+ runs-on: ubuntu-latest
+ env:
+ # Site address to crawl
+ MY_SITE: https://api.jquery.com
+ steps:
+ - name: Checkout
+ uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+ - name: Run hydra-link-checker
+ run: |
+ curl -O https://raw.githubusercontent.com/jquery/hydra-link-checker/v2.0.0/hydra.py
+ python3 hydra.py "$MY_SITE" --config .github/configs/hydra-config.json
diff --git a/.github/workflows/typesense.yaml b/.github/workflows/typesense.yaml
new file mode 100644
index 000000000..de973410d
--- /dev/null
+++ b/.github/workflows/typesense.yaml
@@ -0,0 +1,30 @@
+name: typesense
+on:
+ # Once a day at 11:30 UTC <https://crontab.guru/>
+ schedule:
+ - cron: '30 11 * * *'
+ # Or after a deployment
+ push:
+ branches:
+ - main
+ # Or manually
+ workflow_dispatch:
+
+jobs:
+ typesense:
+ name: Update Typesense
+ if: ${{ github.repository_owner == 'jquery' }} # skip on forks
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+ - name: Docsearch Scraper
+ shell: bash
+ run: |
+ docker run \
+ -e TYPESENSE_API_KEY=${{ secrets.TYPESENSE_ADMIN_KEY }} \
+ -e TYPESENSE_HOST="${{ secrets.TYPESENSE_HOST }}" \
+ -e TYPESENSE_PORT="443" \
+ -e TYPESENSE_PROTOCOL="https" \
+ -e CONFIG="$(cat docsearch.config.json | jq -r tostring)" \
+ typesense/docsearch-scraper:0.9.1
diff --git a/.mailmap b/.mailmap
index 7f902dbd8..5f931fbce 100644
--- a/.mailmap
+++ b/.mailmap
@@ -1,2 +1,6 @@
Matic Potočnik <maticpotocnik@gmail.com> <hairyfotr@gmail.com>
Michał Gołębiowski-Owczarek <m.goleb@gmail.com>
+Timmy Willison <timmywil@users.noreply.github.com>
+Timmy Willison <timmywil@users.noreply.github.com> <4timmywil@gmail.com>
+Timmy Willison <timmywil@users.noreply.github.com> <timmywillisn@gmail.com>
+Timo Tijhof <krinkle@fastmail.com> <krinklemail@gmail.com>
diff --git a/.nvmrc b/.nvmrc
new file mode 100644
index 000000000..3c032078a
--- /dev/null
+++ b/.nvmrc
@@ -0,0 +1 @@
+18
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index 8b645e421..000000000
--- a/.travis.yml
+++ /dev/null
@@ -1,7 +0,0 @@
-language: node_js
-node_js:
- - "8"
-addons:
- apt:
- packages:
- - libxml2-utils
diff --git a/Gruntfile.js b/Gruntfile.js
index 05990732c..10aa18ab0 100644
--- a/Gruntfile.js
+++ b/Gruntfile.js
@@ -43,4 +43,6 @@ grunt.registerTask( "build", [
"build-xml-full"
]);
+grunt.registerTask( "deploy", [ "wordpress-deploy", "deploy-redirects" ] );
+
};
diff --git a/categories.xml b/categories.xml
index c02b93b32..8dc523ece 100644
--- a/categories.xml
+++ b/categories.xml
@@ -37,48 +37,80 @@
<category name="Deprecated" slug="deprecated">
<desc/>
<category name="Deprecated 1.3" slug="deprecated-1.3">
- <desc><![CDATA[All the aspects of the API that were deprecated in the corresponding version of jQuery.
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>This version is no longer supported. Read more about our <a href="https://jquery.com/support/">Version Support</a>.</span></div>
+ <p>All the aspects of the API that were deprecated in the corresponding version of jQuery.</p>
<p>For more information, see the <a href="https://blog.jquery.com/2009/01/14/jquery-1-3-released/">jQuery 1.3 Release Notes</a>.</p>
]]></desc>
</category>
<category name="Deprecated 1.4" slug="deprecated-1.4">
- <desc><![CDATA[All the aspects of the API that were deprecated in the corresponding version of jQuery.
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>This version is no longer supported. Read more about our <a href="https://jquery.com/support/">Version Support</a>.</span></div>
+ <p>All the aspects of the API that were deprecated in the corresponding version of jQuery.</p>
<p>For more information, see the <a href="https://web.archive.org/web/20150119205819/http://jquery14.com/day-01/jquery-14">jQuery 1.4 Release Notes</a></p>
]]></desc>
</category>
<category name="Deprecated 1.7" slug="deprecated-1.7">
- <desc><![CDATA[All the aspects of the API that were deprecated in the corresponding version of jQuery.
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>This version is no longer supported. Read more about our <a href="https://jquery.com/support/">Version Support</a>.</span></div>
+ <p>All the aspects of the API that were deprecated in the corresponding version of jQuery.</p>
<p>For more information, see the Release Notes/Changelog at <a href="https://blog.jquery.com/2011/11/03/jquery-1-7-released/">https://blog.jquery.com/2011/11/03/jquery-1-7-released/</a></p>
]]></desc>
</category>
<category name="Deprecated 1.8" slug="deprecated-1.8">
- <desc><![CDATA[All the aspects of the API that were deprecated in the corresponding version of jQuery.
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>This version is no longer supported. Read more about our <a href="https://jquery.com/support/">Version Support</a>.</span></div>
+ <p>All the aspects of the API that were deprecated in the corresponding version of jQuery.</p>
<p>For more information, see the Release Notes/Changelog at <a href="https://blog.jquery.com/2012/08/09/jquery-1-8-released/">https://blog.jquery.com/2012/08/09/jquery-1-8-released/</a></p>
]]></desc>
</category>
<category name="Deprecated 1.9" slug="deprecated-1.9">
- <desc><![CDATA[All the aspects of the API that were deprecated in the corresponding version of jQuery.
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>This version is no longer supported. Read more about our <a href="https://jquery.com/support/">Version Support</a>.</span></div>
+ <p>All the aspects of the API that were deprecated in the corresponding version of jQuery.</p>
<p>For more information, see the Release Notes/Changelog at <a href="https://blog.jquery.com/2013/01/15/jquery-1-9-final-jquery-2-0-beta-migrate-final-released/">https://blog.jquery.com/2013/01/15/jquery-1-9-final-jquery-2-0-beta-migrate-final-released/</a></p>
]]></desc>
</category>
- <category name="Deprecated 1.10" slug="deprecated-1.10">
- <desc><![CDATA[All the aspects of the API that were deprecated in the corresponding version of jQuery.
+ <category name="Deprecated 1.10 & 2.0" slug="deprecated-1.10-and-2.0">
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>These versions are no longer supported. Read more about our <a href="https://jquery.com/support/">Version Support</a>.</span></div>
+ <p>All the aspects of the API that were deprecated in the corresponding version of jQuery.</p>
<p>For more information, see the Release Notes/Changelog at <a href="https://blog.jquery.com/2013/05/24/jquery-1-10-0-and-2-0-1-released/">https://blog.jquery.com/2013/05/24/jquery-1-10-0-and-2-0-1-released/</a></p>
]]></desc>
</category>
<category name="Deprecated 3.0" slug="deprecated-3.0">
- <desc><![CDATA[All the aspects of the API that were deprecated in the corresponding version of jQuery.
+ <desc><![CDATA[
+ <p>All the aspects of the API that were deprecated in the corresponding version of jQuery.</p>
<p>For more information, see the Release Notes/Changelog at <a href="https://blog.jquery.com/2016/06/09/jquery-3-0-final-released/">https://blog.jquery.com/2016/06/09/jquery-3-0-final-released/</a></p>
]]></desc>
</category>
- <category name="Deprecated 3.3" slug="deprecated-3.3">
- <desc><![CDATA[All the aspects of the API that were deprecated in the corresponding version of jQuery.
+ <category name="Deprecated 3.2" slug="deprecated-3.2">
+ <desc><![CDATA[
+ <p>All the aspects of the API that were deprecated in the corresponding version of jQuery.</p>
+ <p>For more information, see the Release Notes/Changelog at <a href="https://blog.jquery.com/2017/03/16/jquery-3-2-0-is-out/">https://blog.jquery.com/2017/03/16/jquery-3-2-0-is-out/</a></p>
+ ]]></desc>
+ </category>
+ <category name="Deprecated 3.3" slug="deprecated-3.3">
+ <desc><![CDATA[
+ <p>All the aspects of the API that were deprecated in the corresponding version of jQuery.</p>
<p>For more information, see the Release Notes/Changelog at <a href="https://blog.jquery.com/2018/01/19/jquery-3-3-0-a-fragrant-bouquet-of-deprecations-and-is-that-a-new-feature/">https://blog.jquery.com/2018/01/19/jquery-3-3-0-a-fragrant-bouquet-of-deprecations-and-is-that-a-new-feature/</a></p>
]]></desc>
</category>
+ <category name="Deprecated 3.4" slug="deprecated-3.4">
+ <desc><![CDATA[
+ <p>All the aspects of the API that were deprecated in the corresponding version of jQuery.</p>
+ <p>For more information, see the Release Notes/Changelog at <a href="https://blog.jquery.com/2019/04/10/jquery-3-4-0-released/">https://blog.jquery.com/2019/04/10/jquery-3-4-0-released/</a></p>
+ ]]></desc>
+ </category>
+ <category name="Deprecated 3.5" slug="deprecated-3.5">
+ <desc><![CDATA[
+ <p>All the aspects of the API that were deprecated in the corresponding version of jQuery.</p>
+ <p>For more information, see the Release Notes/Changelog at <a href="https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/">https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/</a></p>
+ ]]></desc>
+ </category>
</category>
<category name="Dimensions" slug="dimensions">
- <desc><![CDATA[These methods are used to get and set the CSS dimensions for the various properties.]]></desc>
+ <desc><![CDATA[These methods are used to get and set the CSS dimensions for the various properties.]]></desc>
</category>
<category name="Effects" slug="effects">
<desc><![CDATA[The jQuery library provides several techniques for adding animation to a web page. These include simple, standard animations that are frequently used, and the ability to craft sophisticated custom effects.]]></desc>
@@ -175,15 +207,15 @@ var files = event.originalEvent.dataTransfer.files;
</category>
</category>
<category name="Forms" slug="forms">
- <desc><![CDATA[These methods and event handlers handle forms and their various elements.]]></desc>
+ <desc><![CDATA[These methods and event handlers handle forms and their various elements.]]></desc>
</category>
<category name="Internals" slug="internals">
<desc><![CDATA[Although this category is referred to as 'internal', any methods documented within the API site should be considered public and may be freely used. ]]></desc>
</category>
<category name="Manipulation" slug="manipulation">
<desc><![CDATA[All of the methods in this section manipulate the DOM in some manner. A few of them simply change one of the attributes of an element (also listed in the <a href="/https/github.com/category/attributes/">Attributes category</a>), while others set an element's style properties (also listed in the <a href="/https/github.com/category/css/">CSS category</a>). Still others modify entire elements (or groups of elements) themselves—inserting, copying, removing, and so on. All of these methods are referred to as "setters," as they change the values of properties.
- A few of these methods—such as <code>.attr()</code>, <code>.html()</code>, and <code>.val()</code>—also act as "getters," retrieving information from DOM elements for later use.
- ]]></desc>
+ A few of these methods—such as <code>.attr()</code>, <code>.html()</code>, and <code>.val()</code>—also act as "getters," retrieving information from DOM elements for later use.
+ ]]></desc>
<category name="Class Attribute" slug="class-attribute">
<desc><![CDATA[These methods inspect and manipulate the CSS classes assigned to elements.]]></desc>
</category>
@@ -311,138 +343,284 @@ var files = event.originalEvent.dataTransfer.files;
<category name="Version" slug="version">
<desc/>
<category name="Version 1.0" slug="1.0">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- <a href="https://blog.jquery.com/2006/08/26/jquery-10/">jQuery 1.0 Release Notes</a>.
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <a href="https://blog.jquery.com/2006/08/26/jquery-10/">jQuery 1.0 Release Notes</a>.
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.0.4" slug="1.0.4">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- Release Notes: <a href="https://blog.jquery.com/2006/08/31/jquery-101/">1.0.1</a>, <a href="https://blog.jquery.com/2006/10/09/jquery-102/">1.0.2</a>, <a href="https://blog.jquery.com/2006/10/27/jquery-103/">1.0.3</a>, <a href="https://blog.jquery.com/2006/12/12/jquery-104/">1.0.4</a>.
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ Release Notes: <a href="https://blog.jquery.com/2006/08/31/jquery-101/">1.0.1</a>, <a href="https://blog.jquery.com/2006/10/09/jquery-102/">1.0.2</a>, <a href="https://blog.jquery.com/2006/10/27/jquery-103/">1.0.3</a>, <a href="https://blog.jquery.com/2006/12/12/jquery-104/">1.0.4</a>.
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.1" slug="1.1">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- <a href="https://blog.jquery.com/2007/01/14/jquery-birthday-11-new-site-new-docs/">jQuery 1.1 Release Notes</a>.
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <a href="https://blog.jquery.com/2007/01/14/jquery-birthday-11-new-site-new-docs/">jQuery 1.1 Release Notes</a>.
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.1.2" slug="1.1.2">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- <a href="https://blog.jquery.com/2007/02/27/jquery-112/">jQuery 1.1.2 Release Notes</a>.
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <a href="https://blog.jquery.com/2007/02/27/jquery-112/">jQuery 1.1.2 Release Notes</a>.
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.1.3" slug="1.1.3">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- <a href="https://blog.jquery.com/2007/07/01/jquery-113-800-faster-still-20kb/">jQuery 1.1.3 Release Notes</a>
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <a href="https://blog.jquery.com/2007/07/01/jquery-113-800-faster-still-20kb/">jQuery 1.1.3 Release Notes</a>
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.1.4" slug="1.1.4">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- <a href="https://blog.jquery.com/2007/08/24/jquery-114-faster-more-tests-ready-for-12/">jQuery 1.1.4 Release Notes</a>.
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <a href="https://blog.jquery.com/2007/08/24/jquery-114-faster-more-tests-ready-for-12/">jQuery 1.1.4 Release Notes</a>.
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.2" slug="1.2">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- <a href="https://blog.jquery.com/2007/09/10/jquery-1-2-released/">jQuery 1.2 Release Notes</a>
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <a href="https://blog.jquery.com/2007/09/10/jquery-1-2-released/">jQuery 1.2 Release Notes</a>
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.2.3" slug="1.2.3">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- Release Notes: <a href="https://blog.jquery.com/2007/09/16/jquery-1-2-1-released/">1.2.1</a>, <a href="https://blog.jquery.com/2008/01/14/jquery-1-2-2-released/">1.2.2</a>, <a href="https://blog.jquery.com/2008/02/07/jquery-1-2-3-released/">1.2.3</a>.
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ Release Notes: <a href="https://blog.jquery.com/2007/09/16/jquery-1-2-1-released/">1.2.1</a>, <a href="https://blog.jquery.com/2008/01/14/jquery-1-2-2-released/">1.2.2</a>, <a href="https://blog.jquery.com/2008/02/07/jquery-1-2-3-released/">1.2.3</a>.
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.2.6" slug="1.2.6">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- <a href="https://blog.jquery.com/2008/05/24/jquery-1-2-6-released/">jQuery 1.2.6 Release Notes</a>.
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <a href="https://blog.jquery.com/2008/05/24/jquery-1-2-6-released/">jQuery 1.2.6 Release Notes</a>.
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.3" slug="1.3">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- Release Notes: <a href="https://blog.jquery.com/2009/01/14/jquery-1-3-released/">1.3</a>, <a href="https://blog.jquery.com/2009/01/21/jquery-131-released/">1.3.1</a>, <a href="https://blog.jquery.com/2009/02/20/jquery-1-3-2-released/">1.3.2</a>
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ Release Notes: <a href="https://blog.jquery.com/2009/01/14/jquery-1-3-released/">1.3</a>, <a href="https://blog.jquery.com/2009/01/21/jquery-131-released/">1.3.1</a>, <a href="https://blog.jquery.com/2009/02/20/jquery-1-3-2-released/">1.3.2</a>
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.4" slug="1.4">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- <a href="https://web.archive.org/web/20150119205819/http://jquery14.com/day-01/jquery-14">jQuery 1.4 Release Notes</a>.
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <a href="https://web.archive.org/web/20150119205819/http://jquery14.com/day-01/jquery-14">jQuery 1.4 Release Notes</a>.
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.4.1" slug="1.4.1">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- <a href="https://web.archive.org/web/20150213113058/http://jquery14.com/day-12/jquery-141-released">jQuery 1.4.1 Release Notes</a>.
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <a href="https://web.archive.org/web/20150213113058/http://jquery14.com/day-12/jquery-141-released">jQuery 1.4.1 Release Notes</a>.
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.4.2" slug="1.4.2">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- <a href="https://blog.jquery.com/2010/02/19/jquery-142-released/">jQuery 1.4.2 Release Notes</a>.
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <a href="https://blog.jquery.com/2010/02/19/jquery-142-released/">jQuery 1.4.2 Release Notes</a>.
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.4.3" slug="1.4.3">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.
- <a href="https://blog.jquery.com/2010/10/16/jquery-143-released/">jQuery 1.4.3 Release Notes</a>.
- ]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <a href="https://blog.jquery.com/2010/10/16/jquery-143-released/">jQuery 1.4.3 Release Notes</a>.
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.4.4" slug="1.4.4">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery. <a href="https://blog.jquery.com/2010/11/11/jquery-1-4-4-release-notes/">jQuery 1.4.4 Release Notes</a>.]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <a href="https://blog.jquery.com/2010/11/11/jquery-1-4-4-release-notes/">jQuery 1.4.4 Release Notes</a>.
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.5" slug="1.5">
<desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
<p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
- <p>jQuery 1.5 also includes a large rewrite of the Ajax module, which has a number of extensibility improvements. You can find out more about those improvements in the <a href="https://api.jquery.com/extending-ajax/">Extending Ajax</a> documentation.</p>
- <p>Additionally jQuery 1.5 includes a new Deferred callback management system you can learn more about in in the <a href="https://api.jquery.com/category/deferred-object/">Deferred Object</a> documentation.</p>
+ <p>jQuery 1.5 also includes a large rewrite of the Ajax module, which has a number of extensibility improvements. You can find out more about those improvements in the <a href="https://api.jquery.com/jQuery.ajax/#extending-ajax">Extending Ajax</a> documentation.</p>
+ <p>Additionally, jQuery 1.5 includes a new Deferred callback management system you can learn more about in the <a href="https://api.jquery.com/category/deferred-object/">Deferred Object</a> documentation.</p>
+ <hr/>
]]></desc>
</category>
<category name="Version 1.5.1" slug="1.5.1">
- <desc><![CDATA[Aspects of the API that were changed in the corresponding version of jQuery. API changes in jQuery 1.5.1 dealt primarily with jQuery.ajax settings and jQuery.support properties.]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>API changes in jQuery 1.5.1 dealt primarily with jQuery.ajax settings and jQuery.support properties.</p>
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.6" slug="1.6">
- <desc><![CDATA[All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.]]></desc>
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <hr/>
+ ]]></desc>
</category>
<category name="Version 1.7" slug="1.7">
<desc><![CDATA[
- <p>Aspects of the API that were changed in the corresponding version of jQuery. API changes in jQuery 1.7.0 dealt primarily with the new
- Event APIs: <code>.on()</code> and <code>.off()</code>
- Better Support for HTML5 in IE6/7/8
- <code>jQuery.Callbacks()</code>
- Toggling Animations Work Intuitively
- </p>
- <p>For more information, see the Release Notes/Changelog at <a href="https://blog.jquery.com/2011/11/03/jquery-1-7-released/">https://blog.jquery.com/2011/11/03/jquery-1-7-released/</a></p>
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>jQuery 1.7.0 included:</p>
+ <ul>
+ <li>New event APIs: <code>.on()</code> and <code>.off()</code></li>
+ <li>Better Support for HTML5 in IE6/7/8</li>
+ <li><code>jQuery.Callbacks()</code></li>
+ <li>Toggling Animations Work Intuitively</li>
+ </ul>
+ <p>For more information, see the <a href="https://blog.jquery.com/2011/11/03/jquery-1-7-released/">Release Notes/Changelog</a></p>
<hr/>
]]></desc>
</category>
<category name="Version 1.8" slug="1.8">
<desc><![CDATA[
- <p>Aspects of the API that were changed in the corresponding version of jQuery. API changes in jQuery 1.8.0 dealt primarily with animations and the removal of some methods such as <code>deferred.isResolved()</code>, <code>deferred.isRejected()</code>, <code>$.curCSS()</code>, <code>$.attrFn()</code>, and <code>$(element).closest(Array)</code> returning Array.
- </p>
- <p>For more information, see the Release Notes/Changelog at <a href="https://blog.jquery.com/2012/08/09/jquery-1-8-released/">https://blog.jquery.com/2012/08/09/jquery-1-8-released/</a></p>
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>API changes in jQuery 1.8.0 dealt primarily with animations and the removal of some methods such as <code>deferred.isResolved()</code>, <code>deferred.isRejected()</code>, <code>$.curCSS()</code>, <code>$.attrFn()</code>, and <code>$(element).closest(Array)</code> returning Array.</p>
+ <p>For more information, see the <a href="https://blog.jquery.com/2012/08/09/jquery-1-8-released/">Release Notes/Changelog</a></p>
<hr/>
]]></desc>
</category>
<category name="Version 1.9" slug="1.9">
<desc><![CDATA[
- <p>Aspects of the API that were changed in the corresponding version of jQuery. Changes in jQuery 1.9 dealt primarily with removal or modification of several APIs that behaved inconsistently or inefficiently in the past. A <a href="https://github.com/jquery/jquery-migrate">jQuery Migrate Plugin</a> was offered to help developers with a transitional upgrade path.
- </p>
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since this version was released. If using this version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>Changes in jQuery 1.9 dealt primarily with removal or modification of several APIs that behaved inconsistently or inefficiently in the past.</p>
+ <p>A <a href="https://github.com/jquery/jquery-migrate">jQuery Migrate Plugin</a> was offered to help developers with a transitional upgrade path.</p>
<p>For more information, see the <a href="https://jquery.com/upgrade-guide/1.9/">jQuery Core 1.9 Upgrade guide</a> and the <a href="https://blog.jquery.com/2013/01/15/jquery-1-9-final-jquery-2-0-beta-migrate-final-released/">Release Notes/Changelog</a></p>
<hr/>
]]></desc>
</category>
- <category name="Version 1.12 & 2.2" slug="1.12-2.2">
+ <category name="Version 1.10 & 2.0" slug="1.10-and-2.0">
<desc><![CDATA[
- <p>Aspects of the API that were changed in the corresponding versions of jQuery. Changes in jQuery 1.12 and 2.2 includes performance improvements of the selector engine, manipulation of class names for SVG elements, support for the Symbol type and iterators added in ES2015, and a new hook has been added for filtering HTML. A <a href="https://github.com/jquery/jquery-migrate">jQuery Migrate Plugin</a> was offered to help developers with a transitional upgrade path.
- </p>
- <p>For more information, see the <a href="https://blog.jquery.com/2016/01/08/jquery-2-2-and-1-12-released/">Release Notes/Changelog</a></p>
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since these versions were released. If using either version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>Changes in jQuery 1.10 and 2.0 include a new `wrap` module, relaxing HTML parsing, and aligning the 1.x & 2.x lines.</p>
+ <p>For more information, see the <a href="https://blog.jquery.com/2013/04/18/jquery-2-0-released/">2.0 Release Notes/Changelog</a> and <a href="https://blog.jquery.com/2013/05/24/jquery-1-10-0-and-2-0-1-released/">1.10.0/2.0.1 Release Notes/Changelog</a>.</p>
+ <hr/>
+ ]]></desc>
+ </category>
+ <category name="Version 1.11 & 2.1" slug="1.11-and-2.1">
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since these versions were released. If using either version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>Changes in jQuery 1.11 and 2.1 include lower startup overhead & fewer forced layouts; jQuery is now authored via AMD and published to npm & bower under the name <code>jquery</code>.</p>
+ <p>For more information, see the <a href="https://blog.jquery.com/2014/01/24/jquery-1-11-and-2-1-released/">Release Notes/Changelog</a>.</p>
+ <hr/>
+ ]]></desc>
+ </category>
+ <category name="Version 1.12 & 2.2" slug="1.12-and-2.2">
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>Some APIs may have changed since these versions were released. If using either version, find out about our <a href="https://jquery.com/support">version support</a>.</span></div>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>Changes in jQuery 1.12 and 2.2 include performance improvements of the selector engine, manipulation of class names for SVG elements, support for the Symbol type and iterators added in ES2015, and a new hook has been added for filtering HTML.</p>
+ <p>For more information, see the <a href="https://blog.jquery.com/2016/01/08/jquery-2-2-and-1-12-released/">Release Notes/Changelog</a>.</p>
<hr/>
]]></desc>
</category>
<category name="Version 3.0" slug="3.0">
<desc><![CDATA[
- <p>Aspects of the API that were changed in the corresponding version of jQuery. Changes in jQuery 3.0 dealt primarily with deferreds, data, show/hide and removal of some deprecated APIs. A <a href="https://github.com/jquery/jquery-migrate">jQuery Migrate Plugin</a> was offered to help developers with a transitional upgrade path.
- </p>
- <p>For more information, see the <a href="https://jquery.com/upgrade-guide/3.0/">jQuery Core 3.0 Upgrade guide</a> and the <a href="https://blog.jquery.com/2016/06/09/jquery-3-0-final-released/">Release Notes/Changelog</a></p>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>Changes in jQuery 3.0 dealt primarily with deferreds, data, show/hide and removal of some deprecated APIs. A <a href="https://github.com/jquery/jquery-migrate">jQuery Migrate Plugin</a> was offered to help developers with a transitional upgrade path.</p>
+ <p>For more information, see the <a href="https://jquery.com/upgrade-guide/3.0/">jQuery Core 3.0 Upgrade guide</a> and the <a href="https://blog.jquery.com/2016/06/09/jquery-3-0-final-released/">Release Notes/Changelog</a>.</p>
<hr/>
]]></desc>
</category>
<category name="Version 3.1" slug="3.1">
<desc><![CDATA[
- <p><a href="/https/github.com/jQuery.readyException">jQuery.readyException</a> was added.</p>
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>Version 3.1 added the <a href="/https/github.com/jQuery.readyException">jQuery.readyException</a> API.</p>
+ <p>For more information, see the <a href="https://blog.jquery.com/2016/07/07/jquery-3-1-0-released-no-more-silent-errors/">Release Notes/Changelog</a>.</p>
+ <hr/>
+ ]]></desc>
+ </category>
+ <category name="Version 3.2" slug="3.2">
+ <desc><![CDATA[
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>Version 3.2 added support for custom CSS properties, made <code>.contents()</code> work on the <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/template"><code><template></code> element</a> & made <code>.width()</code> & <code>.height()</code> ignore CSS transforms. A few APIs were deprecated. The deprecated module was added back to the slim build.</p>
+ <p>For more information, see the <a href="https://blog.jquery.com/2017/03/16/jquery-3-2-0-is-out/">Release Notes/Changelog</a>.</p>
+ <hr/>
+ ]]></desc>
+ </category>
+ <category name="Version 3.3" slug="3.3">
+ <desc><![CDATA[
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p><code>.addClass()</code>, <code>.removeClass()</code> & <code>.toggleClass()</code> now work on arrays of classes; a few APIs were deprecated.</p>
+ <p>For more information, see the <a href="https://blog.jquery.com/2018/01/19/jquery-3-3-0-a-fragrant-bouquet-of-deprecations-and-is-that-a-new-feature/">Release Notes/Changelog</a>.</p>
+ <hr/>
+ ]]></desc>
+ </category>
+ <category name="Version 3.4" slug="3.4">
+ <desc><![CDATA[
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p><code>nonce</code> & <code>nomodule</code> attributes are now preserved during script manipulation, layout thrashing was eliminated in some cases in <code>.width()</code> & <code>.height()</code> APIs. Radio elements state is now updated before event handlers run. Passing data now works when triggering all events, including <code>focus</code>. A minor security fix is also included.</p>
+ <p>For more information, see the <a href="https://blog.jquery.com/2019/04/10/jquery-3-4-0-released/">Release Notes/Changelog</a>.</p>
+ <hr/>
+ ]]></desc>
+ </category>
+ <category name="Version 3.5" slug="3.5">
+ <desc><![CDATA[
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>Security fixes, including a breaking change to <code>jQuery.htmlPrefilter</code>; new <code>.even()</code> & <code>.odd()</code> methods; <code>jQuery.globalEval</code> now accepts context; unsuccessful HTTP script responses are no longer evaluated; performance improvements. <code>jQuery.trim</code> is now deprecated. A <a href="https://github.com/jquery/jquery-migrate">jQuery Migrate Plugin</a> was offered to help developers with a transitional upgrade path.</p>
+ <p>For more information, see the <a href="https://jquery.com/upgrade-guide/3.5/">jQuery Core 3.5 Upgrade guide</a> and the <a href="https://blog.jquery.com/2020/04/10/jquery-3-5-0-released/">Release Notes/Changelog</a>.</p>
+ <hr/>
+ ]]></desc>
+ </category>
+ <category name="Version 3.6" slug="3.6">
+ <desc><![CDATA[
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>Returning JSON even for JSONP erroneous responses is working again, a few focus fixes.</p>
+ <p>For more information, see the <a href="https://blog.jquery.com/2021/03/02/jquery-3-6-0-released/">Release Notes/Changelog</a>.</p>
+ <hr/>
+ ]]></desc>
+ </category>
+ <category name="Version 3.7" slug="3.7">
+ <desc><![CDATA[
+ <p>All the aspects of the API that were added, or had a new signature added, in the corresponding version of jQuery.</p>
+ <p>New <code>.uniqueSort()</code> method performance improvements in manipulation, fixes for <code>.outerWidth( true )</code> & <code>.outerHeight( true )</code> with negative margins, focus fixes.</p>
+ <p>As of this release, jQuery no longer relies on Sizzle.</p>
+ <p>Native events for <code>focus</code> & <code>blur</code> changed in IE to - respectively - <code>focusin</code> and <code>focusout</code>.</p>
+ <p>For more information, see the <a href="https://blog.jquery.com/2023/05/11/jquery-3-7-0-released-staying-in-order/">Release Notes/Changelog</a>.</p>
+ <hr/>
+ ]]></desc>
+ </category>
+ <category name="Version 4.0" slug="4.0">
+ <desc><![CDATA[
+ <div id="version-support-warning" class="warning"><i class="icon-info-sign"></i> <span>This is a pre-release. Behavior may change before 4.0.0 final is released.</span></div>
+ <p>Aspects of the API that were changed in the corresponding version of jQuery.</p>
+ <p>Dropped support for IE <11 & Edge Legacy, removed deprecated APIs, added FormData support, improved support for CSP & Trusted Types. Automatic JSONP promotion removed. Special handling of boolean attributes removed.</p>
+ <p>Callbacks & Deferred modules are now excluded from the Slim build.</p>
+ <p>jQuery is now authored in ESM.</p>
+ <p>For more information, see the <a href="https://blog.jquery.com/2024/07/17/second-beta-of-jquery-4-0-0/">Release Notes/Changelog of jQuery 4.0.0-beta.2</a>.</p>
<hr/>
]]></desc>
</category>
diff --git a/config-sample.json b/config-sample.json
index b26cf9fce..2a56329c3 100644
--- a/config-sample.json
+++ b/config-sample.json
@@ -1,5 +1,5 @@
{
- "url": "vagrant.api.jquery.com",
- "username": "admin",
- "password": "secret"
+ "url": "http://local.api.jquery.com",
+ "username": "dev",
+ "password": "dev"
}
diff --git a/docsearch.config.json b/docsearch.config.json
new file mode 100644
index 000000000..f420af4af
--- /dev/null
+++ b/docsearch.config.json
@@ -0,0 +1,52 @@
+{
+ "index_name": "jquery_com",
+ "start_urls": [
+ { "url": "https://api.jquery.com", "selectors_key": "api", "page_rank": 20 },
+ { "url": "https://jquery.com", "page_rank": 10 }
+ ],
+ "stop_urls": [
+ ".com/category/"
+ ],
+ "selectors": {
+ "default": {
+ "lvl0": {
+ "selector": "#menu-top .menu-item.current > a",
+ "global": true,
+ "default_value": "Documentation"
+ },
+ "lvl1": "#content h1",
+ "lvl2": "#content h2",
+ "lvl3": "#content h3",
+ "lvl4": "#content h4",
+ "lvl5": "#content h5",
+ "text": "#content p, #content li, #content tr"
+ },
+ "api": {
+ "lvl0": {
+ "selector": "#categories .cat-item.current-cat > a",
+ "global": true,
+ "default_value": "API"
+ },
+ "lvl1": "#content h1",
+ "lvl2": "#content h2, #content h4.name",
+ "lvl3": "#content h3, #content h4:not(.name)",
+ "lvl4": "#content h5, #content strong:first-child",
+ "text": ".entry-content p, .entry-content li"
+ }
+ },
+ "custom_settings": {
+ "token_separators": ["_", "-", "."]
+ },
+ "selectors_exclude": [
+ "header ~ article",
+ ".returns",
+ ".version-details",
+ ".section-title",
+ ".icon-link.toc-link",
+ "[class^=toclevel]",
+ "#toctitle",
+ ".desc strong:first-child"
+ ],
+ "min_indexed_level": 2,
+ "scrape_start_urls": false
+}
diff --git a/entries/add.xml b/entries/add.xml
index 6f1d7870e..bb95b0f0b 100644
--- a/entries/add.xml
+++ b/entries/add.xml
@@ -20,7 +20,7 @@
</argument>
</signature>
<signature>
- <added>1.3.2</added>
+ <added>1.1</added>
<argument name="selection" type="jQuery">
<desc>An existing jQuery object to add to the set of matched elements.</desc>
</argument>
diff --git a/entries/addClass.xml b/entries/addClass.xml
index 5dd99ec56..39d6a0bf5 100644
--- a/entries/addClass.xml
+++ b/entries/addClass.xml
@@ -7,6 +7,12 @@
<desc>One or more space-separated classes to be added to the class attribute of each matched element.</desc>
</argument>
</signature>
+ <signature>
+ <added>3.3</added>
+ <argument name="classNames" type="Array">
+ <desc>An array of classes to be added to the class attribute of each matched element.</desc>
+ </argument>
+ </signature>
<signature>
<added>1.4</added>
<argument name="function" type="Function">
@@ -16,6 +22,16 @@
<return type="String"/>
</argument>
</signature>
+ <signature>
+ <added>3.3</added>
+ <argument name="function" type="Function">
+ <desc>A function returning one or more space-separated class names or an array of class names to be added to the existing class name(s). Receives the index position of the element in the set and the existing class name(s) as arguments. Within the function, <code>this</code> refers to the current element in the set.</desc>
+ <argument name="index" type="Integer" />
+ <argument name="currentClassName" type="String" />
+ <return type="String"/>
+ <return type="Array"/>
+ </argument>
+ </signature>
<desc>Adds the specified class(es) to each element in the set of matched elements.</desc>
<longdesc>
<p>It's important to note that this method does not replace a class. It simply adds the class, appending it to any which may already be assigned to the elements.</p>
@@ -64,7 +80,30 @@ $( "p" ).last().addClass( "selected" );
<example>
<desc>Add the classes "selected" and "highlight" to the matched elements.</desc>
<code><![CDATA[
-$( "p:last" ).addClass( "selected highlight" );
+$( "p" ).last().addClass( "selected highlight" );
+]]></code>
+ <css><![CDATA[
+ p {
+ margin: 8px;
+ font-size: 16px;
+ }
+ .selected {
+ color: red;
+ }
+ .highlight {
+ background: yellow;
+ }
+]]></css>
+ <html><![CDATA[
+<p>Hello</p>
+<p>and</p>
+<p>Goodbye</p>
+]]></html>
+ </example>
+ <example>
+ <desc>Add the classes "selected" and "highlight" to the matched elements (3.3+ syntax).</desc>
+ <code><![CDATA[
+$( "p" ).last().addClass( [ "selected", "highlight" ] );
]]></code>
<css><![CDATA[
p {
@@ -122,4 +161,6 @@ $( "div" ).addClass(function( index, currentClass ) {
<category slug="css"/>
<category slug="version/1.0"/>
<category slug="version/1.4"/>
+ <category slug="version/1.12-and-2.2"/>
+ <category slug="version/3.3"/>
</entry>
diff --git a/entries/after.xml b/entries/after.xml
index 210ad7c86..2ea48a9c5 100644
--- a/entries/after.xml
+++ b/entries/after.xml
@@ -34,7 +34,7 @@
</argument>
</signature>
<signature>
- <added>1.10</added>
+ <added>1.10-and-2.0</added>
<argument name="function-html" type="Function">
<desc>A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert after each element in the set of matched elements. Receives the index position of the element in the set and the old HTML value of the element as arguments. Within the function, <code>this</code> refers to the current element in the set.</desc>
<argument name="index" type="Integer" />
diff --git a/entries/ajaxComplete-shorthand.xml b/entries/ajaxComplete-shorthand.xml
new file mode 100644
index 000000000..3f44abc14
--- /dev/null
+++ b/entries/ajaxComplete-shorthand.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<entry type="method" name="ajaxComplete" return="jQuery" deprecated="3.5">
+ <title>.ajaxComplete()</title>
+ <desc>Register a handler to be called when Ajax requests complete. This is an <a href="/Ajax_Events/">AjaxEvent</a>.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>The function to be invoked.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated. Use <a href="/https/github.com/ajaxComplete/"><code>.on( "ajaxComplete", handler )</code></a> instead.</p>
+ </div>
+ </longdesc>
+ <category slug="ajax/global-ajax-event-handlers"/>
+ <category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.5"/>
+</entry>
diff --git a/entries/ajaxComplete.xml b/entries/ajaxComplete.xml
index f96dc4cfd..0c133516f 100644
--- a/entries/ajaxComplete.xml
+++ b/entries/ajaxComplete.xml
@@ -1,18 +1,24 @@
<?xml version="1.0"?>
-<entry type="method" name="ajaxComplete" return="jQuery">
- <title>.ajaxComplete()</title>
+<entry type="method" name="on" return="jQuery">
+ <title>ajaxComplete event</title>
+ <desc>Register a handler to be called when Ajax requests complete. This is an <a href="/Ajax_Events/">AjaxEvent</a>.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
+ <added>1.7</added>
+ <argument name=""ajaxComplete"" type="string">
+ <desc>The string <code>"ajaxComplete"</code>.</desc>
+ </argument>
+ <argument name="handler" type="Function">
<argument name="event" type="Event" />
<argument name="jqXHR" type="jqXHR" />
<argument name="ajaxOptions" type="PlainObject" />
<desc>The function to be invoked.</desc>
</argument>
</signature>
- <desc>Register a handler to be called when Ajax requests complete. This is an <a href="/Ajax_Events/">AjaxEvent</a>.</desc>
<longdesc>
- <p>Whenever an Ajax request completes, jQuery triggers the <code>ajaxComplete</code> event. Any and all handlers that have been registered with the <code>.ajaxComplete()</code> method are executed at this time.</p>
+ <div class="warning">
+ <p>This page describes the <code>ajaxComplete</code> event. For the deprecated <code>.ajaxComplete()</code> method, see <a href="/https/github.com/ajaxComplete-shorthand/"><code>.ajaxComplete()</code></a>.</p>
+ </div>
+ <p>Whenever an Ajax request completes, jQuery triggers the <code>ajaxComplete</code> event. Any and all registered <code>ajaxComplete</code> handlers are executed at this time.</p>
<p>To observe this method in action, set up a basic Ajax load request:</p>
<pre><code>
<div class="trigger">Trigger</div>
@@ -21,38 +27,39 @@
</code></pre>
<p>Attach the event handler to the document:</p>
<pre><code>
-$( document ).ajaxComplete(function() {
+$( document ).on( "ajaxComplete", function() {
$( ".log" ).text( "Triggered ajaxComplete handler." );
-});
+} );
</code></pre>
<p>Now, make an Ajax request using any jQuery method:</p>
<pre><code>
-$( ".trigger" ).click(function() {
+$( ".trigger" ).on( "click", function() {
$( ".result" ).load( "ajax/test.html" );
-});
+} );
</code></pre>
<p>When the user clicks the element with class <code>trigger</code> and the Ajax request completes, the log message is displayed.</p>
<p>All <code>ajaxComplete</code> handlers are invoked, regardless of what Ajax request was completed. If you must differentiate between the requests, use the parameters passed to the handler. Each time an <code>ajaxComplete</code> handler is executed, it is passed the event object, the <code>XMLHttpRequest</code> object, and the settings object that was used in the creation of the request. For example, you can restrict the callback to only handling events dealing with a particular URL:</p>
<pre><code>
-$( document ).ajaxComplete(function( event, xhr, settings ) {
+$( document ).on( "ajaxComplete", function( event, xhr, settings ) {
if ( settings.url === "ajax/test.html" ) {
$( ".log" ).text( "Triggered ajaxComplete handler. The result is " +
xhr.responseText );
}
-});
+} );
</code></pre>
<p><strong>Note:</strong> You can get the returned Ajax contents by looking at <code>xhr.responseText</code>.</p>
</longdesc>
- <note id="global-ajax-event" type="additional" data-title=".ajaxComplete()"/>
- <note id="ajax-global-false" type="additional" data-title=".ajaxComplete()"/>
+ <note id="global-ajax-event" type="additional" data-title="ajaxComplete"/>
+ <note id="ajax-global-false" type="additional" data-title="ajaxComplete"/>
<example>
<desc>Show a message when an Ajax request completes.</desc>
<code><![CDATA[
-$( document ).ajaxComplete(function( event, request, settings ) {
+$( document ).on( "ajaxComplete", function( event, request, settings ) {
$( "#msg" ).append( "<li>Request Complete.</li>" );
-});
+} );
]]></code>
</example>
<category slug="ajax/global-ajax-event-handlers"/>
<category slug="version/1.0"/>
+ <category slug="version/1.7"/>
</entry>
diff --git a/entries/ajaxError-shorthand.xml b/entries/ajaxError-shorthand.xml
new file mode 100644
index 000000000..f36ac54a8
--- /dev/null
+++ b/entries/ajaxError-shorthand.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<entry type="method" name="ajaxError" return="jQuery" deprecated="3.5">
+ <title>.ajaxError()</title>
+ <desc>Register a handler to be called when Ajax requests complete with an error. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>The function to be invoked.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated. Use <a href="/https/github.com/ajaxError/"><code>.on( "ajaxError", handler )</code></a> instead.</p>
+ </div>
+ </longdesc>
+ <category slug="ajax/global-ajax-event-handlers"/>
+ <category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.5"/>
+</entry>
diff --git a/entries/ajaxError.xml b/entries/ajaxError.xml
index 19abee09f..d18cf9775 100644
--- a/entries/ajaxError.xml
+++ b/entries/ajaxError.xml
@@ -1,8 +1,12 @@
<?xml version="1.0"?>
-<entry type="method" name="ajaxError" return="jQuery">
- <title>.ajaxError()</title>
+<entry type="method" name="on" return="jQuery">
+ <title>ajaxError event</title>
+ <desc>Register a handler to be called when Ajax requests complete with an error. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
<signature>
- <added>1.0</added>
+ <added>1.7</added>
+ <argument name=""ajaxError"" type="string">
+ <desc>The string <code>"ajaxError"</code>.</desc>
+ </argument>
<argument name="handler" type="Function">
<desc>The function to be invoked.</desc>
<argument name="event" type="Event" />
@@ -11,9 +15,11 @@
<argument name="thrownError" type="String" />
</argument>
</signature>
- <desc>Register a handler to be called when Ajax requests complete with an error. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
<longdesc>
- <p>Whenever an Ajax request completes with an error, jQuery triggers the <code>ajaxError</code> event. Any and all handlers that have been registered with the <code>.ajaxError()</code> method are executed at this time. <strong>Note:</strong> <em>This handler is not called for cross-domain script and cross-domain JSONP requests.</em></p>
+ <div class="warning">
+ <p>This page describes the <code>ajaxError</code> event. For the deprecated <code>.ajaxError()</code> method, see <a href="/https/github.com/ajaxError-shorthand/"><code>.ajaxError()</code></a>.</p>
+ </div>
+ <p>Whenever an Ajax request completes with an error, jQuery triggers the <code>ajaxError</code> event. Any and all registered <code>ajaxError</code> handlers are executed at this time. <strong>Note:</strong> <em>This handler is not called for cross-domain script and cross-domain JSONP requests.</em></p>
<p>To observe this method in action, set up a basic Ajax load request.</p>
<pre><code>
<button class="trigger">Trigger</button>
@@ -22,35 +28,37 @@
</code></pre>
<p>Attach the event handler to the document:</p>
<pre><code>
-$( document ).ajaxError(function() {
+$( document ).on( "ajaxError", function() {
$( ".log" ).text( "Triggered ajaxError handler." );
-});
+} );
</code></pre>
<p>Now, make an Ajax request using any jQuery method:</p>
<pre><code>
$( "button.trigger" ).on( "click", function() {
$( "div.result" ).load( "ajax/missing.html" );
-});
+} );
</code></pre>
<p>When the user clicks the button and the Ajax request fails, because the requested file is missing, the log message is displayed.</p>
<p>All <code>ajaxError</code> handlers are invoked, regardless of what Ajax request was completed. To differentiate between the requests, use the parameters passed to the handler. Each time an <code>ajaxError</code> handler is executed, it is passed the event object, the <code>jqXHR</code> object (prior to jQuery 1.5, the <code><abbr title="XMLHttpRequest">XHR</abbr></code> object), and the settings object that was used in the creation of the request. When an HTTP error occurs, the fourth argument (<code>thrownError</code>) receives the textual portion of the HTTP status, such as "Not Found" or "Internal Server Error." For example, to restrict the error callback to only handling events dealing with a particular URL:</p>
<pre><code>
-$( document ).ajaxError(function( event, jqxhr, settings, thrownError ) {
+$( document ).on( "ajaxError", function( event, jqxhr, settings, thrownError ) {
if ( settings.url == "ajax/missing.html" ) {
$( "div.log" ).text( "Triggered ajaxError handler." );
}
-});</code></pre>
+} );
+ </code></pre>
</longdesc>
- <note id="global-ajax-event" type="additional" data-title=".ajaxError()"/>
- <note id="ajax-global-false" type="additional" data-title=".ajaxError()"/>
+ <note id="global-ajax-event" type="additional" data-title="ajaxError"/>
+ <note id="ajax-global-false" type="additional" data-title="ajaxError"/>
<example>
<desc>Show a message when an Ajax request fails.</desc>
<code><![CDATA[
-$( document ).ajaxError(function( event, request, settings ) {
+$( document ).on( "ajaxError", function( event, request, settings ) {
$( "#msg" ).append( "<li>Error requesting page " + settings.url + "</li>" );
-});
+} );
]]></code>
</example>
<category slug="ajax/global-ajax-event-handlers"/>
<category slug="version/1.0"/>
+ <category slug="version/1.7"/>
</entry>
diff --git a/entries/ajaxSend-shorthand.xml b/entries/ajaxSend-shorthand.xml
new file mode 100644
index 000000000..a9ae031e7
--- /dev/null
+++ b/entries/ajaxSend-shorthand.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<entry type="method" name="ajaxSend" return="jQuery" deprecated="3.5">
+ <title>.ajaxSend()</title>
+ <desc>Attach a function to be executed before an Ajax request is sent. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>The function to be invoked.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated. Use <a href="/https/github.com/ajaxSend/"><code>.on( "ajaxSend", handler )</code></a> instead.</p>
+ </div>
+ </longdesc>
+ <category slug="ajax/global-ajax-event-handlers"/>
+ <category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.5"/>
+</entry>
diff --git a/entries/ajaxSend.xml b/entries/ajaxSend.xml
index db814fee1..cbd1641cd 100644
--- a/entries/ajaxSend.xml
+++ b/entries/ajaxSend.xml
@@ -1,8 +1,12 @@
<?xml version="1.0"?>
-<entry type="method" name="ajaxSend" return="jQuery">
- <title>.ajaxSend()</title>
+<entry type="method" name="on" return="jQuery">
+ <title>ajaxSend event</title>
+ <desc>Attach a function to be executed before an Ajax request is sent. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
<signature>
- <added>1.0</added>
+ <added>1.7</added>
+ <argument name=""ajaxSend"" type="string">
+ <desc>The string <code>"ajaxSend"</code>.</desc>
+ </argument>
<argument name="handler" type="Function">
<desc>The function to be invoked.</desc>
<argument name="event" type="Event" />
@@ -10,9 +14,11 @@
<argument name="ajaxOptions" type="PlainObject" />
</argument>
</signature>
- <desc>Attach a function to be executed before an Ajax request is sent. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
<longdesc>
- <p>Whenever an Ajax request is about to be sent, jQuery triggers the <code>ajaxSend</code> event. Any and all handlers that have been registered with the <code>.ajaxSend()</code> method are executed at this time.</p>
+ <div class="warning">
+ <p>This page describes the <code>ajaxSend</code> event. For the deprecated <code>.ajaxSend()</code> method, see <a href="/https/github.com/ajaxSend-shorthand/"><code>.ajaxSend()</code></a>.</p>
+ </div>
+ <p>Whenever an Ajax request is about to be sent, jQuery triggers the <code>ajaxSend</code> event. Any and all registerd <code>ajaxSend</code> handlers are executed at this time.</p>
<p>To observe this method in action, set up a basic Ajax load request:</p>
<pre><code>
<div class="trigger">Trigger</div>
@@ -21,36 +27,37 @@
</code></pre>
<p>Attach the event handler to the document:</p>
<pre><code>
-$( document ).ajaxSend(function() {
+$( document ).on( "ajaxSend", function() {
$( ".log" ).text( "Triggered ajaxSend handler." );
-});
+} );
</code></pre>
<p>Now, make an Ajax request using any jQuery method:</p>
<pre><code>
-$( ".trigger" ).click(function() {
+$( ".trigger" ).on( "click", function() {
$( ".result" ).load( "ajax/test.html" );
-});
+} );
</code></pre>
<p>When the user clicks the element with class <code>trigger</code> and the Ajax request is about to begin, the log message is displayed.</p>
<p>All <code>ajaxSend</code> handlers are invoked, regardless of what Ajax request is to be sent. If you must differentiate between the requests, use the parameters passed to the handler. Each time an <code>ajaxSend</code> handler is executed, it is passed the event object, the <code>jqXHR</code> object (in version 1.4, <code>XMLHttpRequest</code>object), and the <a href="/https/github.com/jQuery.ajax/">settings object</a> that was used in the creation of the Ajax request. For example, you can restrict the callback to only handling events dealing with a particular URL:</p>
<pre><code>
-$( document ).ajaxSend(function( event, jqxhr, settings ) {
+$( document ).on( "ajaxSend", function( event, jqxhr, settings ) {
if ( settings.url == "ajax/test.html" ) {
$( ".log" ).text( "Triggered ajaxSend handler." );
}
-});
+} );
</code></pre>
</longdesc>
- <note id="global-ajax-event" type="additional" data-title=".ajaxSend()"/>
- <note id="ajax-global-false" type="additional" data-title=".ajaxSend()"/>
+ <note id="global-ajax-event" type="additional" data-title="ajaxSend"/>
+ <note id="ajax-global-false" type="additional" data-title="ajaxSend"/>
<example>
<desc>Show a message before an Ajax request is sent.</desc>
<code><![CDATA[
-$( document ).ajaxSend(function( event, request, settings ) {
+$( document ).on( "ajaxSend", function( event, request, settings ) {
$( "#msg" ).append( "<li>Starting request at " + settings.url + "</li>" );
-});
+} );
]]></code>
</example>
<category slug="ajax/global-ajax-event-handlers"/>
<category slug="version/1.0"/>
+ <category slug="version/1.7"/>
</entry>
diff --git a/entries/ajaxStart-shorthand.xml b/entries/ajaxStart-shorthand.xml
new file mode 100644
index 000000000..51b2fc9e3
--- /dev/null
+++ b/entries/ajaxStart-shorthand.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<entry type="method" name="ajaxStart" return="jQuery" deprecated="3.5">
+ <title>.ajaxStart()</title>
+ <desc>Register a handler to be called when the first Ajax request begins. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>The function to be invoked.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated. Use <a href="/https/github.com/ajaxStart/"><code>.on( "ajaxStart", handler )</code></a> instead.</p>
+ </div>
+ </longdesc>
+ <category slug="ajax/global-ajax-event-handlers"/>
+ <category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.5"/>
+</entry>
diff --git a/entries/ajaxStart.xml b/entries/ajaxStart.xml
index bf7fc14a7..3d8f4df4f 100644
--- a/entries/ajaxStart.xml
+++ b/entries/ajaxStart.xml
@@ -1,15 +1,21 @@
<?xml version="1.0"?>
-<entry type="method" name="ajaxStart" return="jQuery">
- <title>.ajaxStart()</title>
+<entry type="method" name="on" return="jQuery">
+ <title>ajaxStart event</title>
+ <desc>Register a handler to be called when the first Ajax request begins. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
<signature>
- <added>1.0</added>
+ <added>1.7</added>
+ <argument name=""ajaxStart"" type="string">
+ <desc>The string <code>"ajaxStart"</code>.</desc>
+ </argument>
<argument name="handler" type="Function">
<desc>The function to be invoked.</desc>
</argument>
</signature>
- <desc>Register a handler to be called when the first Ajax request begins. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
<longdesc>
- <p>Whenever an Ajax request is about to be sent, jQuery checks whether there are any other outstanding Ajax requests. If none are in progress, jQuery triggers the <code>ajaxStart</code> event. Any and all handlers that have been registered with the <code>.ajaxStart()</code> method are executed at this time.</p>
+ <div class="warning">
+ <p>This page describes the <code>ajaxStart</code> event. For the deprecated <code>.ajaxStart()</code> method, see <a href="/https/github.com/ajaxStart-shorthand/"><code>.ajaxStart()</code></a>.</p>
+ </div>
+ <p>Whenever an Ajax request is about to be sent, jQuery checks whether there are any other outstanding Ajax requests. If none are in progress, jQuery triggers the <code>ajaxStart</code> event. Any and all handlers that have been registered with <code>.on( "ajaxStart", ... )</code> are executed at this time.</p>
<p>To observe this method in action, set up a basic Ajax load request:</p>
<pre><code>
<div class="trigger">Trigger</div>
@@ -18,28 +24,29 @@
</code></pre>
<p>Attach the event handler to any element:</p>
<pre><code>
-$( document ).ajaxStart(function() {
+$( document ).on( "ajaxStart", function() {
$( ".log" ).text( "Triggered ajaxStart handler." );
-});
+} );
</code></pre>
<p>Now, make an Ajax request using any jQuery method:</p>
<pre><code>
-$( ".trigger" ).click(function() {
+$( ".trigger" ).on( "click", function() {
$( ".result" ).load( "ajax/test.html" );
-});
+} );
</code></pre>
<p>When the user clicks the element with class <code>trigger</code> and the Ajax request is sent, the log message is displayed.</p>
</longdesc>
- <note id="global-ajax-event" type="additional" data-title=".ajaxStart()"/>
- <note id="ajax-global-false" type="additional" data-title=".ajaxStart()"/>
+ <note id="global-ajax-event" type="additional" data-title="ajaxStart"/>
+ <note id="ajax-global-false" type="additional" data-title="ajaxStart"/>
<example>
<desc>Show a loading message whenever an Ajax request starts (and none is already active).</desc>
<code><![CDATA[
-$( document ).ajaxStart(function() {
+$( document ).on( "ajaxStart", function() {
$( "#loading" ).show();
-});
+} );
]]></code>
</example>
<category slug="ajax/global-ajax-event-handlers"/>
<category slug="version/1.0"/>
+ <category slug="version/1.7"/>
</entry>
diff --git a/entries/ajaxStop-shorthand.xml b/entries/ajaxStop-shorthand.xml
new file mode 100644
index 000000000..781216575
--- /dev/null
+++ b/entries/ajaxStop-shorthand.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<entry type="method" name="ajaxStop" return="jQuery" deprecated="3.5">
+ <title>.ajaxStop()</title>
+ <desc>Register a handler to be called when all Ajax requests have completed. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>The function to be invoked.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated. Use <a href="/https/github.com/ajaxStop/"><code>.on( "ajaxStop", handler )</code></a> instead.</p>
+ </div>
+ </longdesc>
+ <category slug="ajax/global-ajax-event-handlers"/>
+ <category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.5"/>
+</entry>
diff --git a/entries/ajaxStop.xml b/entries/ajaxStop.xml
index 073dd208f..f42c74448 100644
--- a/entries/ajaxStop.xml
+++ b/entries/ajaxStop.xml
@@ -1,15 +1,21 @@
<?xml version="1.0"?>
-<entry type="method" name="ajaxStop" return="jQuery">
- <title>.ajaxStop()</title>
+<entry type="method" name="on" return="jQuery">
+ <title>ajaxStop event</title>
<desc>Register a handler to be called when all Ajax requests have completed. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
<signature>
- <added>1.0</added>
+ <added>1.7</added>
+ <argument name=""ajaxStop"" type="string">
+ <desc>The string <code>"ajaxStop"</code>.</desc>
+ </argument>
<argument name="handler" type="Function">
<desc>The function to be invoked.</desc>
</argument>
</signature>
<longdesc>
- <p>Whenever an Ajax request completes, jQuery checks whether there are any other outstanding Ajax requests. If none remain, jQuery triggers the <code>ajaxStop</code> event. Any and all handlers that have been registered with the <code>.ajaxStop()</code> method are executed at this time. The <code>ajaxStop</code> event is also triggered if the last outstanding Ajax request is cancelled by returning false within the <code>beforeSend</code> callback function. </p>
+ <div class="warning">
+ <p>This page describes the <code>ajaxStop</code> event. For the deprecated <code>.ajaxStop()</code> method, see <a href="/https/github.com/ajaxStop-shorthand/"><code>.ajaxStop()</code></a>.</p>
+ </div>
+ <p>Whenever an Ajax request completes, jQuery checks whether there are any other outstanding Ajax requests. If none remain, jQuery triggers the <code>ajaxStop</code> event. Any and all registered <code>ajaxStop</code> handlers are executed at this time. The <code>ajaxStop</code> event is also triggered if the last outstanding Ajax request is cancelled by returning false within the <code>beforeSend</code> callback function. </p>
<p>To observe this method in action, set up a basic Ajax load request:</p>
<pre><code>
<div class="trigger">Trigger</div>
@@ -18,28 +24,29 @@
</code></pre>
<p>Attach the event handler to the document:</p>
<pre><code>
-$( document ).ajaxStop(function() {
+$( document ).on( "ajaxStop", function() {
$( ".log" ).text( "Triggered ajaxStop handler." );
-});
+} );
</code></pre>
<p>Now, make an Ajax request using any jQuery method:</p>
<pre><code>
-$( ".trigger" ).click(function() {
+$( ".trigger" ).on( "click", function() {
$( ".result" ).load( "ajax/test.html" );
-});
+} );
</code></pre>
<p>When the user clicks the element with class <code>trigger</code> and the Ajax request completes, the log message is displayed.</p>
</longdesc>
- <note id="global-ajax-event" type="additional" data-title=".ajaxStop()"/>
- <note id="ajax-global-false" type="additional" data-title=".ajaxStop()"/>
+ <note id="global-ajax-event" type="additional" data-title="ajaxStop"/>
+ <note id="ajax-global-false" type="additional" data-title="ajaxStop"/>
<example>
<desc>Hide a loading message after all the Ajax requests have stopped.</desc>
<code><![CDATA[
-$( document ).ajaxStop(function() {
+$( document ).on( "ajaxStop", function() {
$( "#loading" ).hide();
-});
+} );
]]></code>
</example>
<category slug="ajax/global-ajax-event-handlers"/>
<category slug="version/1.0"/>
+ <category slug="version/1.7"/>
</entry>
diff --git a/entries/ajaxSuccess-shorthand.xml b/entries/ajaxSuccess-shorthand.xml
new file mode 100644
index 000000000..a9e543350
--- /dev/null
+++ b/entries/ajaxSuccess-shorthand.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<entry type="method" name="ajaxSuccess" return="jQuery" deprecated="3.5">
+ <title>.ajaxSuccess()</title>
+ <desc>Attach a function to be executed whenever an Ajax request completes successfully. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>The function to be invoked.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated. Use <a href="/https/github.com/ajaxSuccess/"><code>.on( "ajaxSuccess", handler )</code></a> instead.</p>
+ </div>
+ </longdesc>
+ <category slug="ajax/global-ajax-event-handlers"/>
+ <category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.5"/>
+</entry>
diff --git a/entries/ajaxSuccess.xml b/entries/ajaxSuccess.xml
index 840ec0287..8824a6212 100644
--- a/entries/ajaxSuccess.xml
+++ b/entries/ajaxSuccess.xml
@@ -1,8 +1,12 @@
<?xml version="1.0"?>
-<entry type="method" name="ajaxSuccess" return="jQuery">
- <title>.ajaxSuccess()</title>
+<entry type="method" name="on" return="jQuery">
+ <title>ajaxSuccess event</title>
+ <desc>Attach a function to be executed whenever an Ajax request completes successfully. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
<signature>
- <added>1.0</added>
+ <added>1.7</added>
+ <argument name=""ajaxSuccess"" type="string">
+ <desc>The string <code>"ajaxSuccess"</code>.</desc>
+ </argument>
<argument name="handler" type="Function">
<desc>The function to be invoked.</desc>
<argument name="event" type="Event" />
@@ -11,9 +15,11 @@
<argument name="data" type="PlainObject" />
</argument>
</signature>
- <desc>Attach a function to be executed whenever an Ajax request completes successfully. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
<longdesc>
- <p>Whenever an Ajax request completes successfully, jQuery triggers the <code>ajaxSuccess</code> event. Any and all handlers that have been registered with the <code>.ajaxSuccess()</code> method are executed at this time.</p>
+ <div class="warning">
+ <p>This page describes the <code>ajaxSuccess</code> event. For the deprecated <code>.ajaxSuccess()</code> method, see <a href="/https/github.com/ajaxSuccess-shorthand/"><code>.ajaxSuccess()</code></a>.</p>
+ </div>
+ <p>Whenever an Ajax request completes successfully, jQuery triggers the <code>ajaxSuccess</code> event. Any and all registered <code>ajaxSuccess</code> handlers are executed at this time.</p>
<p>To observe this method in action, set up a basic Ajax load request:</p>
<pre><code>
<div class="trigger">Trigger</div>
@@ -22,38 +28,39 @@
</code></pre>
<p>Attach the event handler to any element:</p>
<pre><code>
-$(document).ajaxSuccess(function() {
+$( document ).on( "ajaxSuccess", function() {
$( ".log" ).text( "Triggered ajaxSuccess handler." );
-});
+} );
</code></pre>
<p>Now, make an Ajax request using any jQuery method:</p>
<pre><code>
$( ".trigger" ).on( "click", function() {
$( ".result" ).load( "ajax/test.html" );
-});
+} );
</code></pre>
<p>When the user clicks the element with class <code>trigger</code> and the Ajax request completes successfully, the log message is displayed.</p>
<p>All <code>ajaxSuccess</code> handlers are invoked, regardless of what Ajax request was completed. If you must differentiate between the requests, you can use the parameters passed to the handler. Each time an <code>ajaxSuccess</code> handler is executed, it is passed the event object, the <code>XMLHttpRequest</code> object, and the settings object that was used in the creation of the request. For example, you can restrict the callback to only handling events dealing with a particular URL:</p>
<pre><code>
-$( document ).ajaxSuccess(function( event, xhr, settings ) {
+$( document ).on( "ajaxSuccess", function( event, xhr, settings ) {
if ( settings.url == "ajax/test.html" ) {
$( ".log" ).text( "Triggered ajaxSuccess handler. The Ajax response was: " +
xhr.responseText );
}
-});
+} );
</code></pre>
<p><strong>Note:</strong> You can get the returned Ajax contents by looking at <code>xhr.responseXML</code> or <code>xhr.responseText</code> for xml and html respectively.</p>
</longdesc>
- <note id="global-ajax-event" type="additional" data-title=".ajaxSuccess()"/>
- <note id="ajax-global-false" type="additional" data-title=".ajaxSuccess()"/>
+ <note id="global-ajax-event" type="additional" data-title="ajaxSuccess"/>
+ <note id="ajax-global-false" type="additional" data-title="ajaxSuccess"/>
<example>
<desc>Show a message when an Ajax request completes successfully.</desc>
<code><![CDATA[
-$( document ).ajaxSuccess(function( event, request, settings ) {
+$( document ).on( "ajaxSuccess", function( event, request, settings ) {
$( "#msg" ).append( "<li>Successful Request!</li>" );
-});
+} );
]]></code>
</example>
<category slug="ajax/global-ajax-event-handlers"/>
<category slug="version/1.0"/>
+ <category slug="version/1.7"/>
</entry>
diff --git a/entries/andSelf.xml b/entries/andSelf.xml
index 5adfd1aea..967c72ef5 100644
--- a/entries/andSelf.xml
+++ b/entries/andSelf.xml
@@ -6,72 +6,10 @@
</signature>
<desc>Add the previous set of elements on the stack to the current set.</desc>
<longdesc>
- <p><strong>Note:</strong> This function has been deprecated and is now an alias for <a href="/https/github.com/addBack/"><code>.addBack()</code></a>, which should be used with jQuery 1.8 and later.</p>
- <p>As described in the discussion for <code><a href="/https/github.com/end/">.end()</a></code>, jQuery objects maintain an internal stack that keeps track of changes to the matched set of elements. When one of the DOM traversal methods is called, the new set of elements is pushed onto the stack. If the previous set of elements is desired as well, <code>.andSelf()</code> can help.</p>
- <p>Consider a page with a simple list on it:</p>
- <pre><code>
-<ul>
- <li>list item 1</li>
- <li>list item 2</li>
- <li class="third-item">list item 3</li>
- <li>list item 4</li>
- <li>list item 5</li>
-</ul>
- </code></pre>
- <p>The result of the following code is a red background behind items 3, 4 and 5:</p>
- <pre><code>
-$( "li.third-item" ).nextAll().andSelf()
- .css( "background-color", "red" );
- </code></pre>
- <p>First, the initial selector locates item 3, initializing the stack with the set containing just this item. The call to <code>.nextAll()</code> then pushes the set of items 4 and 5 onto the stack. Finally, the <code>.andSelf()</code> invocation merges these two sets together, creating a jQuery object that points to all three items in document order: <code>[ <li.third-item>, <li>, <li> ]</code>.</p>
+ <div class="warning">
+ <p>Note: This API has been removed in jQuery 3.0; use <a href="/https/github.com/addBack/"><code>.addBack()</code></a> instead, which should work identically.</p>
+ </div>
</longdesc>
- <example>
- <desc>The <code>.andSelf()</code> method causes the previous set of DOM elements in the traversal stack to be added to the current set. In the first example, the top stack contains the set resulting from <code>.find("p")</code>. In the second example, <code>.andSelf()</code> adds the previous set of elements on the stack — in this case <code>$( "div.after-andself" )</code> — to the current set, selecting both the div and its enclosed paragraphs.</desc>
- <code><![CDATA[
-$( "div.left, div.right" ).find( "div, div > p" ).addClass( "border" );
-
-// First Example
-$( "div.before-andself" ).find( "p" ).addClass( "background" );
-
-// Second Example
-$( "div.after-andself" ).find( "p" ).andSelf().addClass( "background" );
-]]></code>
- <css><![CDATA[
- p, div {
- margin: 5px;
- padding: 5px;
- }
- .border {
- border: 2px solid red;
- }
- .background {
- background: yellow;
- }
- .left, .right {
- width: 45%;
- float: left;
- }
- .right {
- margin-left: 3%;
- }
-]]></css>
- <html><![CDATA[
-<div class="left">
- <p><strong>Before <code>andSelf()</code></strong></p>
- <div class="before-andself">
- <p>First Paragraph</p>
- <p>Second Paragraph</p>
- </div>
-</div>
-<div class="right">
- <p><strong>After <code>andSelf()</code></strong></p>
- <div class="after-andself">
- <p>First Paragraph</p>
- <p>Second Paragraph</p>
- </div>
-</div>
-]]></html>
- </example>
<category slug="traversing/miscellaneous-traversal"/>
<category slug="version/1.2"/>
<category slug="deprecated/deprecated-1.8"/>
diff --git a/entries/animate.xml b/entries/animate.xml
index 97cac6162..c4ac9e70f 100644
--- a/entries/animate.xml
+++ b/entries/animate.xml
@@ -45,7 +45,7 @@
</code></pre>
<p>To animate the opacity, left offset, and height of the image simultaneously:</p>
<pre><code>
-$( "#clickme" ).click(function() {
+$( "#clickme" ).on( "click", function() {
$( "#book" ).animate({
opacity: 0.25,
left: "+=50",
@@ -101,7 +101,7 @@ $( "li" ).animate({
<p>As of jQuery version 1.4, you can set per-property easing functions within a single <code>.animate()</code> call. In the first version of <code>.animate()</code>, each property can take an array as its value: The first member of the array is the CSS property and the second member is an easing function. If a per-property easing function is not defined for a particular property, it uses the value of the <code>.animate()</code> method's optional easing argument. If the easing argument is not defined, the default <code>swing</code> function is used.</p>
<p>For example, to simultaneously animate the width and height with the <code>swing</code> easing function and the opacity with the <code>linear</code> easing function:</p>
<pre><code>
-$( "#clickme" ).click(function() {
+$( "#clickme" ).on( "click", function() {
$( "#book" ).animate({
width: [ "toggle", "swing" ],
height: [ "toggle", "swing" ],
@@ -113,7 +113,7 @@ $( "#clickme" ).click(function() {
</code></pre>
<p>In the second version of <code>.animate()</code>, the options object can include the <code>specialEasing</code> property, which is itself an object of CSS properties and their corresponding easing functions. For example, to simultaneously animate the width using the <code>linear</code> easing function and the height using the <code>easeOutBounce</code> easing function:</p>
<pre><code>
-$( "#clickme" ).click(function() {
+$( "#clickme" ).on( "click", function() {
$( "#book" ).animate({
width: "toggle",
height: "toggle"
@@ -137,7 +137,7 @@ $( "#clickme" ).click(function() {
<code><![CDATA[
// Using multiple unit types within one animation.
-$( "#go" ).click(function() {
+$( "#go" ).on( "click", function() {
$( "#block" ).animate({
width: "70%",
opacity: 0.4,
@@ -162,11 +162,11 @@ $( "#go" ).click(function() {
<example>
<desc>Animates a div's left property with a relative value. Click several times on the buttons to see the relative animations queued up.</desc>
<code><![CDATA[
-$( "#right" ).click(function() {
+$( "#right" ).on( "click", function() {
$( ".block" ).animate({ "left": "+=50px" }, "slow" );
});
-$( "#left" ).click(function(){
+$( "#left" ).on( "click", function(){
$( ".block" ).animate({ "left": "-=50px" }, "slow" );
});
]]></code>
@@ -191,7 +191,7 @@ $( "#left" ).click(function(){
The second button starts a traditional chained animation, where each animation will start once the previous animation on the element has completed.</desc>
<code><![CDATA[
-$( "#go1" ).click(function() {
+$( "#go1" ).on( "click", function() {
$( "#block1" )
.animate({
width: "90%"
@@ -203,18 +203,18 @@ $( "#go1" ).click(function() {
.animate({ borderRightWidth: "15px" }, 1500 );
});
-$( "#go2" ).click(function() {
+$( "#go2" ).on( "click", function() {
$( "#block2" )
.animate({ width: "90%" }, 1000 )
.animate({ fontSize: "24px" }, 1000 )
.animate({ borderLeftWidth: "15px" }, 1000 );
});
-$( "#go3" ).click(function() {
- $( "#go1" ).add( "#go2" ).click();
+$( "#go3" ).on( "click", function() {
+ $( "#go1" ).add( "#go2" ).trigger( "click" );
});
-$( "#go4" ).click(function() {
+$( "#go4" ).on( "click", function() {
$( "div" ).css({
width: "",
fontSize: "",
@@ -248,13 +248,13 @@ $( "#go4" ).click(function() {
<example>
<desc>Animates the first div's left property and synchronizes the remaining divs, using the step function to set their left properties at each stage of the animation. </desc>
<code><![CDATA[
-$( "#go" ).click(function() {
- $( ".block:first" ).animate({
+$( "#go" ).on( "click", function() {
+ $( ".block" ).first().animate({
left: 100
}, {
duration: 1000,
step: function( now, fx ){
- $( ".block:gt(0)" ).css( "left", now );
+ $( ".block" ).slice( 1 ).css( "left", now );
}
});
});
diff --git a/entries/animated-selector.xml b/entries/animated-selector.xml
index 819fcff0c..9a68868e3 100644
--- a/entries/animated-selector.xml
+++ b/entries/animated-selector.xml
@@ -13,7 +13,7 @@
<example>
<desc>Change the color of any div that is animated.</desc>
<code><![CDATA[
-$( "#run" ).click(function() {
+$( "#run" ).on( "click", function() {
$( "div:animated" ).toggleClass( "colored" );
});
diff --git a/entries/appendTo.xml b/entries/appendTo.xml
index 931e70bba..7221b2e09 100644
--- a/entries/appendTo.xml
+++ b/entries/appendTo.xml
@@ -54,7 +54,7 @@ $( "h2" ).appendTo( $( ".container" ) );
</div>
</code></pre>
<p>If there is more than one target element, however, cloned copies of the inserted element will be created for each target except the last, and that new set (the original element plus clones) is returned.</p>
- <p><strong>Before jQuery 1.9,</strong> the append-to-single-element case did not create a new set, but instead returned the original set which made it difficult to use the <code>.end()</code> method reliably when being used with an unknown number of elements.</p>
+ <p><strong>Before jQuery 1.9,</strong> the append-to-single-element case did not create a new set, but instead returned the original set which made it difficult to use the <code>.end()</code> method reliably when being used with an unknown number of elements.</p>
</longdesc>
<note id="html-code-execution" type="additional"/>
<note id="svg-support" type="additional"/>
diff --git a/entries/attr.xml b/entries/attr.xml
index 2dc8a25e6..ac3e5a1bb 100644
--- a/entries/attr.xml
+++ b/entries/attr.xml
@@ -26,7 +26,7 @@
<h4>Attributes vs. Properties</h4>
<p>The difference between <em>attributes</em> and <em>properties</em> can be important in specific situations. <strong>Before jQuery 1.6</strong>, the <code>.attr()</code> method sometimes took property values into account when retrieving some attributes, which could cause inconsistent behavior. <strong>As of jQuery 1.6</strong>, the <code>.prop()</code> method provides a way to explicitly retrieve property values, while <code>.attr()</code> retrieves attributes.</p>
<p>For example, <code>selectedIndex</code>, <code>tagName</code>, <code>nodeName</code>, <code>nodeType</code>, <code>ownerDocument</code>, <code>defaultChecked</code>, and <code>defaultSelected</code> should be retrieved and set with the <code><a href="/https/github.com/prop/">.prop()</a></code> method. Prior to jQuery 1.6, these properties were retrievable with the <code>.attr()</code> method, but this was not within the scope of <code>attr</code>. These do not have corresponding attributes and are only properties.</p>
- <p>Concerning boolean attributes, consider a DOM element defined by the HTML markup <code><input type="checkbox" checked="checked" /></code>, and assume it is in a JavaScript variable named <code>elem</code>:</p>
+ <p>Concerning boolean attributes, consider a DOM element defined by the HTML markup <code><input type="checkbox" checked="" /></code>, and assume it is in a JavaScript variable named <code>elem</code>:</p>
<table>
<tr>
<th>
@@ -44,21 +44,21 @@
<th>
<code>elem.getAttribute( "checked" )</code>
</th>
- <td><code>"checked"</code> (String) Initial state of the checkbox; does not change</td>
+ <td><code>""</code> (String) Initial state of the checkbox; does not change</td>
</tr>
<tr>
<th>
<code>$( elem ).attr( "checked" )</code>
- <em>(1.6)</em>
+ <em>(4.0+)</em>
</th>
- <td><code>"checked"</code> (String) Initial state of the checkbox; does not change</td>
+ <td><code>""</code> (String) Initial state of the checkbox; does not change</td>
</tr>
<tr>
<th>
<code>$( elem ).attr( "checked" )</code>
- <em>(1.6.1+)</em>
+ <em>(1.6-3.x)</em>
</th>
- <td><code>"checked"</code> (String) Will change with checkbox state</td>
+ <td><code>"checked"</code> (String) Initial state of the checkbox; does not change</td>
</tr>
<tr>
<th>
@@ -89,13 +89,13 @@
<desc>Display the checked attribute and property of a checkbox as it changes.</desc>
<code><![CDATA[
$( "input" )
- .change(function() {
+ .on( "change", function() {
var $input = $( this );
$( "p" ).html( ".attr( 'checked' ): <b>" + $input.attr( "checked" ) + "</b><br>" +
".prop( 'checked' ): <b>" + $input.prop( "checked" ) + "</b><br>" +
".is( ':checked' ): <b>" + $input.is( ":checked" ) + "</b>" );
- })
- .change();
+ } )
+ .trigger( "change" );
]]></code>
<css><![CDATA[
p {
@@ -138,6 +138,7 @@ The title of the emphasis is:<div></div>
<category slug="version/1.0"/>
<category slug="version/1.1"/>
<category slug="version/1.6"/>
+ <category slug="version/4.0"/>
</entry>
<entry type="method" name="attr" return="jQuery">
<signature>
@@ -149,7 +150,8 @@ The title of the emphasis is:<div></div>
<type name="String"/>
<type name="Number"/>
<type name="Null"/>
- <desc>A value to set for the attribute. If <code>null</code>, the specified attribute will be removed (as in <a href="/https/github.com/removeAttr/"><code>.removeAttr()</code></a>).</desc>
+ <type name="Boolean"/>
+ <desc>A value to set for the attribute. If <code>null</code>, the specified attribute will be removed (as in <a href="/https/github.com/removeAttr/"><code>.removeAttr()</code></a>). Non-ARIA attributes can also be removed by passing <code>false</code>.</desc>
</argument>
</signature>
<signature>
@@ -169,7 +171,7 @@ The title of the emphasis is:<div></div>
<argument name="attr" type="String" />
<return>
<type name="String"/>
- <type name="Number"/>
+ <type name="Number"/>
</return>
</argument>
</signature>
@@ -195,6 +197,11 @@ $( "#greatphoto" ).attr({
});
</code></pre>
<p>When setting multiple attributes, the quotes around attribute names are optional.</p>
+ <h4 id="removing-attr">Removing an attribute</h4>
+ <p>To remove an attribute, either call <code>.attr( name, null )</code> or use <a href="/https/github.com/removeAttr/"><code>.removeAttr( name )</code></a>. For non-ARIA attributes, in jQuery 4.0+ you can also call <code>.attr( name, false )</code>.</p>
+ <div class="warning">
+ <p><strong>Note:</strong> Because <a href="https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA">ARIA</a> attributes frequently associate behavior with "false" values that differs from attribute absence, passing <code>false</code> as the value for an attribute whose name starts with <code>"aria-…"</code> will stringify that value to <code>"false"</code> rather than remove the attribute. To guarantee removal of an attribute, use the <code>.removeAttr()</code> method or provide <code>null</code> as the value to the <code>.attr()</code> setter.</p>
+ </div>
<p><strong>WARNING</strong>: When setting the 'class' attribute, you must always use quotes!</p>
<div class="warning">
<p><strong>Note:</strong> Attempting to change the <code>type</code> attribute on an <code>input</code> or <code>button</code> element created via <code>document.createElement()</code> will throw an exception on Internet Explorer 8 or older.</p>
@@ -280,5 +287,6 @@ $( "img" ).attr( "src", function() {
<category slug="version/1.0"/>
<category slug="version/1.1"/>
<category slug="version/1.6"/>
+ <category slug="version/4.0"/>
</entry>
</entries>
diff --git a/entries/before.xml b/entries/before.xml
index 1a1fcdeab..577f588b0 100644
--- a/entries/before.xml
+++ b/entries/before.xml
@@ -35,7 +35,7 @@
</argument>
</signature>
<signature>
- <added>1.10</added>
+ <added>1.10-and-2.0</added>
<argument name="function-html" type="Function">
<argument name="index" type="Integer" />
<argument name="html" type="String" />
diff --git a/entries/bind.xml b/entries/bind.xml
index 150c645ba..aa45c4551 100644
--- a/entries/bind.xml
+++ b/entries/bind.xml
@@ -37,7 +37,7 @@
<p>As of jQuery 3.0, <code>.bind()</code> has been deprecated. It was superseded by the <a href="/https/github.com/on/"><code>.on()</code></a> method for attaching event handlers to a document since jQuery 1.7, so its use was already discouraged. For earlier versions, the <code>.bind()</code> method is used for attaching an event handler directly to elements. Handlers are attached to the currently selected elements in the jQuery object, so those elements <em>must exist</em> at the point the call to <code>.bind()</code> occurs. For more flexible event binding, see the discussion of event delegation in <a href="/https/github.com/on/"><code>.on()</code></a>.</p>
<p>Any string is legal for <code>eventType</code>; if the string is not the name of a native DOM event, then the handler is bound to a custom event. These events are never called by the browser, but may be triggered manually from other JavaScript code using <code>.trigger()</code> or <code>.triggerHandler()</code>.</p>
<p>If the <code>eventType</code> string contains a period (<code>.</code>) character, then the event is namespaced. The period character separates the event from its namespace. For example, in the call <code>.bind( "click.name", handler )</code>, the string <code>click</code> is the event type, and the string <code>name</code> is the namespace. Namespacing allows us to unbind or trigger some events of a type without affecting others. See the discussion of <code>.unbind()</code> for more information.</p>
- <p>There are shorthand methods for some standard browser events such as <a href="/https/github.com/click/"><code>.click()</code></a> that can be used to attach or trigger event handlers. For a complete list of shorthand methods, see the <a href="/https/github.com/category/events/">events category</a>.</p>
+ <p>Some events have dedicated pages, describing specifics of their usage. For a complete list of those events, see the <a href="/https/github.com/category/events/">events category</a>.</p>
<p>When an event reaches an element, all handlers bound to that event type for the element are fired. If there are multiple handlers registered, they will always execute in the order in which they were bound. After all handlers have executed, the event continues along the normal event propagation path.</p>
<p>A basic usage of <code>.bind()</code> is:</p>
<pre><code>
@@ -221,7 +221,7 @@ $( "p" ).bind( "myCustomEvent", function( e, myName, myValue ) {
.fadeIn( 30 )
.fadeOut( 1000 );
});
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "p" ).trigger( "myCustomEvent", [ "John" ] );
});
]]></code>
diff --git a/entries/blur-shorthand.xml b/entries/blur-shorthand.xml
new file mode 100644
index 000000000..589a1cebb
--- /dev/null
+++ b/entries/blur-shorthand.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<entry type="method" name="blur" return="jQuery" deprecated="3.3">
+ <title>.blur()</title>
+ <desc>Bind an event handler to the "blur" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.blur( handler )</code> or <code>.blur( eventData, handler )</code>, use <a href="/https/github.com/blur/#on1"><code>.on( "blur", handler )</code></a> or <a href="/https/github.com/blur/#on1"><code>.on( "blur", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.blur()</code>, use <a href="/https/github.com/blur/#trigger2"><code>.trigger( "blur" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="forms"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/blur.xml b/entries/blur.xml
index 11afbd6ab..68636a0ce 100644
--- a/entries/blur.xml
+++ b/entries/blur.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="blur" return="jQuery">
- <title>.blur()</title>
- <desc>Bind an event handler to the "blur" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+
+<desc>Bind an event handler to the "blur" event, or trigger that event on an element.</desc>
+<entry type="method" name="on" return="jQuery">
+ <title>blur event</title>
+ <desc>Bind an event handler to the "blur" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""blur"" type="string">
+ <desc>The string <code>"blur"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "blur", handler )</code> in the first two variations, and <code>.trigger( "blur" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>blur</code> event. For the deprecated <code>.blur()</code> method, see <a href="/https/github.com/blur-shorthand/"><code>.blur()</code></a>.</p>
+ </div>
<p>The <code>blur</code> event is sent to an element when it loses focus. Originally, this event was only applicable to form elements, such as <code><input></code>. In recent browsers, the domain of the event has been extended to include all element types. An element can lose focus via keyboard commands, such as the Tab key, or by mouse clicks elsewhere on the page.</p>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -34,33 +32,55 @@
<div id="other">
Trigger the handler
</div>
-The event handler can be bound to the first input field:
-$( "#target" ).blur(function() {
- alert( "Handler for .blur() called." );
-});
+ </code></pre>
+ <p>The event handler can be bound to the first input field:</p>
+ <pre><code>
+$( "#target" ).on( "blur", function() {
+ alert( "Handler for `blur` called." );
+} );
</code></pre>
<p>Now if the first field has the focus, clicking elsewhere or tabbing away from it displays the alert:</p>
<p>
- <samp>Handler for .blur() called.</samp>
+ <samp>Handler for `blur` called.</samp>
</p>
- <p>To trigger the event programmatically, apply <code>.blur()</code> without an argument:</p>
+ <p>To trigger the event programmatically, call <code>.trigger( "blur" )</code>:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#target" ).blur();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "blur" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also alert the message.</p>
- <p>The <code>blur</code> event does not bubble in Internet Explorer. Therefore, scripts that rely on event delegation with the <code>blur</code> event will not work consistently across browsers. As of version 1.4.2, however, jQuery works around this limitation by mapping <code>blur</code> to the <code>focusout</code> event in its event delegation methods, <a href="/https/github.com/live/"><code>.live()</code></a> and <a href="/https/github.com/delegate/"><code>.delegate()</code></a>.</p>
+ <p>The <code>blur</code> event does not bubble. As of version 1.4.2, jQuery works around this limitation by mapping <code>blur</code> to the <code>focusout</code> event in its event delegation methods.</p>
+ <p>The native <code>blur</code> event is asynchronous in all versions of IE, contrary to other browsers. To avoid issues related to this discrepancy, as of jQuery 3.7.0, jQuery uses <code>focusout</code> as the native backing event for <code>blur</code> in IE.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="blur"/>
<example>
<desc>To trigger the blur event on all paragraphs:</desc>
<code><![CDATA[
-$( "p" ).blur();
+$( "p" ).trigger( "blur" );
]]></code>
</example>
<category slug="events/form-events"/>
<category slug="forms"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+ <category slug="version/3.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>blur event</title>
+ <desc>Trigger the "blur" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""blur"" type="string">
+ <desc>The string <code>"blur"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "blur", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="forms"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/button-selector.xml b/entries/button-selector.xml
index 858522e5c..12c8471cd 100644
--- a/entries/button-selector.xml
+++ b/entries/button-selector.xml
@@ -16,9 +16,9 @@
var input = $( ":button" ).addClass( "marked" );
$( "div" ).text( "For this type jQuery found " + input.length + "." );
// Prevent the form from submitting
-$( "form" ).submit(function( event ) {
+$( "form" ).on( "submit", function( event ) {
event.preventDefault();
-});
+} );
]]></code>
<css><![CDATA[
textarea {
diff --git a/entries/change-shorthand.xml b/entries/change-shorthand.xml
new file mode 100644
index 000000000..98d9509a2
--- /dev/null
+++ b/entries/change-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="change" return="jQuery" deprecated="3.3">
+ <title>.change()</title>
+ <desc>Bind an event handler to the "change" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.change( handler )</code> or <code>.change( eventData, handler )</code>, use <a href="/https/github.com/change/#on1"><code>.on( "change", handler )</code></a> or <a href="/https/github.com/change/#on1"><code>.on( "change", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.change()</code>, use <a href="/https/github.com/change/#trigger2"><code>.trigger( "change" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/change.xml b/entries/change.xml
index 67d521d93..e179c5061 100644
--- a/entries/change.xml
+++ b/entries/change.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="change" return="jQuery">
- <title>.change()</title>
- <desc>Bind an event handler to the "change" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+<desc>Bind an event handler to the "change" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>change event</title>
+ <desc>Bind an event handler to the "change" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""change"" type="string">
+ <desc>The string <code>"change"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "change", handler )</code> in the first two variations, and <code>.trigger( "change" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>change</code> event. For the deprecated <code>.change()</code> method, see <a href="/https/github.com/change-shorthand/"><code>.change()</code></a>.</p>
+ </div>
<p>The <code>change</code> event is sent to an element when its value changes. This event is limited to <code><input></code> elements, <code><textarea></code> boxes and <code><select></code> elements. For select boxes, checkboxes, and radio buttons, the event is fired immediately when the user makes a selection with the mouse, but for the other element types the event is deferred until the element loses focus.</p>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -40,35 +38,34 @@
</code></pre>
<p>The event handler can be bound to the text input and the select box:</p>
<pre><code>
-$( ".target" ).change(function() {
- alert( "Handler for .change() called." );
-});
+$( ".target" ).on( "change", function() {
+ alert( "Handler for `change` called." );
+} );
</code></pre>
- <p>Now when the second option is selected from the dropdown, the alert is displayed. It is also displayed if you change the text in the field and then click away. If the field loses focus without the contents having changed, though, the event is not triggered. To trigger the event manually, apply <code>.change()</code> without arguments:</p>
+ <p>Now when the second option is selected from the dropdown, the alert is displayed. It is also displayed if you change the text in the field and then click away. If the field loses focus without the contents having changed, though, the event is not triggered. To trigger the event manually, use <code>.trigger( "change" )</code>:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( ".target" ).change();
-});
+$( "#other" ).on( "click", function() {
+ $( ".target" ).trigger( "change" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also alert the message. The message will display twice, because the handler has been bound to the <code>change</code> event on both of the form elements.</p>
<p>As of jQuery 1.4, the <code>change</code> event bubbles in Internet Explorer, behaving consistently with the event in other modern browsers.</p>
<div class="warning">
- <p><strong>Note: </strong>Changing the value of an input element using JavaScript, using <a href="/https/github.com/val"><code>.val()</code></a> for example, won't fire the event.</p>
+ <p><strong>Note: </strong>Changing the value of an input element using JavaScript, using <a href="/https/github.com/val"><code>.val()</code></a> for example, won't fire the event.</p>
</div>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="change"/>
<example>
<desc>Attaches a change event to the select that gets the text for each selected option and writes them in the div. It then triggers the event for the initial text draw.</desc>
<code><![CDATA[
$( "select" )
- .change(function () {
+ .on( "change", function() {
var str = "";
- $( "select option:selected" ).each(function() {
+ $( "select option:selected" ).each( function() {
str += $( this ).text() + " ";
- });
+ } );
$( "div" ).text( str );
- })
- .change();
+ } )
+ .trigger( "change" );
]]></code>
<css><![CDATA[
div {
@@ -90,13 +87,31 @@ $( "select" )
<example>
<desc>To add a validity test to all text input elements:</desc>
<code><![CDATA[
-$( "input[type='text']" ).change(function() {
+$( "input[type='text']" ).on( "change", function() {
// Check input( $( this ).val() ) for validity here
-});
+} );
]]></code>
</example>
<category slug="events/form-events"/>
<category slug="forms"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>change event</title>
+ <desc>Trigger the "change" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""change"" type="string">
+ <desc>The string <code>"change"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "change", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/checkbox-selector.xml b/entries/checkbox-selector.xml
index 843cdaf77..ba0fd815d 100644
--- a/entries/checkbox-selector.xml
+++ b/entries/checkbox-selector.xml
@@ -26,9 +26,9 @@ $( "div" )
.css( "color", "red" );
// Prevent the form from submitting
-$( "form" ).submit(function( event ) {
+$( "form" ).on( "submit", function( event ) {
event.preventDefault();
-});
+} );
]]></code>
<css><![CDATA[
textarea {
diff --git a/entries/children.xml b/entries/children.xml
index 8437acc52..5880351b7 100644
--- a/entries/children.xml
+++ b/entries/children.xml
@@ -38,16 +38,16 @@
<example>
<desc>Find all children of the clicked element.</desc>
<code><![CDATA[
-$( "#container" ).click(function ( event ) {
+$( "#container" ).on( "click", function( event ) {
$( "*" ).removeClass( "hilite" );
var kids = $( event.target ).children();
var len = kids.addClass( "hilite" ).length;
- $( "#results span:first" ).text( len );
- $( "#results span:last" ).text( event.target.tagName );
+ $( "#results span" ).first().text( len );
+ $( "#results span" ).last().text( event.target.tagName );
event.preventDefault();
-});
+} );
]]></code>
<css><![CDATA[
body {
diff --git a/entries/clearQueue.xml b/entries/clearQueue.xml
index 85baeeb23..19c2f0088 100644
--- a/entries/clearQueue.xml
+++ b/entries/clearQueue.xml
@@ -14,7 +14,7 @@
<example>
<desc>Empty the queue.</desc>
<code><![CDATA[
-$( "#start" ).click(function() {
+$( "#start" ).on( "click", function() {
var myDiv = $( "div" );
myDiv.show( "slow" );
myDiv.animate({
@@ -38,7 +38,7 @@ $( "#start" ).click(function() {
myDiv.slideUp();
});
-$( "#stop" ).click(function() {
+$( "#stop" ).on( "click", function() {
var myDiv = $( "div" );
myDiv.clearQueue();
myDiv.stop();
diff --git a/entries/click-shorthand.xml b/entries/click-shorthand.xml
new file mode 100644
index 000000000..374e9f74b
--- /dev/null
+++ b/entries/click-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="click" return="jQuery" deprecated="3.3">
+ <title>.click()</title>
+ <desc>Bind an event handler to the "click" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.click( handler )</code> or <code>.click( eventData, handler )</code>, use <a href="/https/github.com/click/#on1"><code>.on( "click", handler )</code></a> or <a href="/https/github.com/click/#on1"><code>.on( "click", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.click()</code>, use <a href="/https/github.com/click/#trigger2"><code>.trigger( "click" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/click.xml b/entries/click.xml
index 56475da4f..c5f9deb2b 100644
--- a/entries/click.xml
+++ b/entries/click.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="click" return="jQuery">
- <title>.click()</title>
- <desc>Bind an event handler to the "click" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+
+<desc>Bind an event handler to the "click" event, or trigger that event on an element.</desc>
+<entry type="method" name="on" return="jQuery">
+ <title>click event</title>
+ <desc>Bind an event handler to the "click" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""click"" type="string">
+ <desc>The string <code>"click"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,12 +18,11 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "click", handler )</code> in the first two variations, and <code>.trigger( "click" )</code> in the third.
- The <code>click</code> event is sent to an element when the mouse pointer is over the element, and the mouse button is pressed and released. Any HTML element can receive this event.
+ <div class="warning">
+ <p>This page describes the <code>click</code> event. For the deprecated <code>.click()</code> method, see <a href="/https/github.com/click-shorthand/"><code>.click()</code></a>.</p>
+ </div>
+ <p>The <code>click</code> event is sent to an element when the mouse pointer is over the element, and the mouse button is pressed and released. Any HTML element can receive this event.
For example, consider the HTML:</p>
<pre><code>
<div id="target">
@@ -40,19 +38,19 @@
</figure>
<p>The event handler can be bound to any <code><div></code>:</p>
<pre><code>
-$( "#target" ).click(function() {
- alert( "Handler for .click() called." );
-});
+$( "#target" ).on( "click", function() {
+ alert( "Handler for `click` called." );
+} );
</code></pre>
<p>Now if we click on this element, the alert is displayed:</p>
<p>
- <samp>Handler for .click() called.</samp>
+ <samp>Handler for `click` called.</samp>
</p>
<p>We can also trigger the event when a different element is clicked:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#target" ).click();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "click" );
+} );
</code></pre>
<p>After this code executes, clicking on <samp>Trigger the handler</samp> will also alert the message.</p>
<p>The <code>click</code> event is only triggered after this exact series of events:</p>
@@ -62,13 +60,12 @@ $( "#other" ).click(function() {
</ul>
<p>This is usually the desired sequence before taking an action. If this is not required, the <code>mousedown</code> or <code>mouseup</code> event may be more suitable.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="click"/>
<example>
<desc>Hide paragraphs on a page when they are clicked:</desc>
<code><![CDATA[
-$( "p" ).click(function() {
+$( "p" ).on( "click", function() {
$( this ).slideUp();
-});
+} );
]]></code>
<css><![CDATA[
p {
@@ -87,12 +84,30 @@ $( "p" ).click(function() {
]]></html>
</example>
<example>
- <desc>Trigger the click event on all of the paragraphs on the page:</desc>
+ <desc>Trigger the click event on all the paragraphs on the page:</desc>
<code><![CDATA[
-$( "p" ).click();
+$( "p" ).trigger( "click" );
]]></code>
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>click event</title>
+ <desc>Trigger the "click" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""click"" type="string">
+ <desc>The string <code>"click"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "click", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/contains-selector.xml b/entries/contains-selector.xml
index e14882698..c471083f8 100644
--- a/entries/contains-selector.xml
+++ b/entries/contains-selector.xml
@@ -25,5 +25,6 @@ $( "div:contains('John')" ).css( "text-decoration", "underline" );
]]></html>
</example>
<category slug="selectors/content-filter-selector"/>
+ <category slug="selectors/jquery-selector-extensions"/>
<category slug="version/1.1.4"/>
</entry>
diff --git a/entries/contents.xml b/entries/contents.xml
index f4118e0c1..6cfa73bae 100644
--- a/entries/contents.xml
+++ b/entries/contents.xml
@@ -8,6 +8,7 @@
<longdesc>
<p>Given a jQuery object that represents a set of DOM elements, the <code>.contents()</code> method allows us to search through the immediate children of these elements in the DOM tree and construct a new jQuery object from the matching elements. The <code>.contents()</code> and <code>.children()</code> methods are similar, except that the former includes text nodes and comment nodes as well as HTML elements in the resulting jQuery object. Please note that most jQuery operations don't support text nodes and comment nodes. The few that do will have an explicit note on their API documentation page.</p>
<p>The <code>.contents()</code> method can also be used to get the content document of an iframe, if the iframe is on the same domain as the main page.</p>
+ <p><strong>As of jQuery 3.2</strong>, <code>.contents()</code> returns contents of <code><template></code> elements as well.</p>
<p>Consider a simple <code><div></code> with a number of text nodes, each of which is separated by two line break elements (<code><br></code>):</p>
<pre><code>
<div class="container">
@@ -33,7 +34,7 @@ $( ".container" )
.filter( "br" )
.remove();
</code></pre>
- <p>This code first retrieves the contents of <code><div class="container"></code> and then filters it for text nodes, which are wrapped in paragraph tags. This is accomplished by testing the <a href="https://developer.mozilla.org/docs/en/DOM/Node.nodeType"><code>.nodeType</code> property</a> of the element. This DOM property holds a numeric code indicating the node's type; text nodes use the code 3. The contents are again filtered, this time for <code><br /></code> elements, and these elements are removed.</p>
+ <p>This code first retrieves the contents of <code><div class="container"></code> and then filters it for text nodes, which are wrapped in paragraph tags. This is accomplished by testing the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeType"><code>.nodeType</code> property</a> of the element. This DOM property holds a numeric code indicating the node's type; text nodes use the code 3. The contents are again filtered, this time for <code><br /></code> elements, and these elements are removed.</p>
</longdesc>
<example>
<desc>Find all the text nodes inside a paragraph and wrap them with a bold tag.</desc>
@@ -60,4 +61,5 @@ $( "#frameDemo" ).contents().find( "a" ).css( "background-color", "#BADA55" );
</example>
<category slug="traversing/miscellaneous-traversal"/>
<category slug="version/1.2"/>
+ <category slug="version/3.2"/>
</entry>
diff --git a/entries/context.xml b/entries/context.xml
index 5fc5362a7..cd9c3cc41 100644
--- a/entries/context.xml
+++ b/entries/context.xml
@@ -1,12 +1,14 @@
<?xml version="1.0"?>
-<entry type="property" name="context" return="Element" deprecated="1.10" removed="3.0">
+<entry type="property" name="context" return="Element" deprecated="1.10-and-2.0" removed="3.0">
<title>.context</title>
<signature>
<added>1.3</added>
</signature>
<desc>The DOM node context originally passed to <code>jQuery()</code>; if none was passed then context will likely be the document.</desc>
<longdesc>
- <p>The <code>.context</code> property was deprecated in jQuery 1.10 and is only maintained to the extent needed for supporting <code>.live()</code> in the jQuery Migrate plugin. It may be removed without notice in a future version.</p>
+ <div class="warning">
+ <p>Note: This API has been removed in jQuery 3.0.</p>
+ </div>
<p>The <code>.live()</code> method for binding event handlers uses this property to determine the root element to use for its event delegation needs.</p>
<p>The value of this property is typically equal to <code>document</code>, as this is the default context for jQuery objects if none is supplied. The context may differ if, for example, the object was created by searching within an <code><iframe></code> or XML document.</p>
<p>Note that the context property may only apply to the elements originally selected by <code>jQuery()</code>, as it is possible for the user to add elements to the collection via methods such as <code>.add()</code> and these may have a different context.</p>
@@ -18,13 +20,10 @@ $( "ul" )
.append( "<li>" + $( "ul" ).context + "</li>" )
.append( "<li>" + $( "ul", document.body ).context.nodeName + "</li>" );
]]></code>
- <html><![CDATA[
-Context: <ul></ul>
-]]></html>
</example>
<category slug="internals"/>
<category slug="properties/jquery-object-instance-properties"/>
<category slug="version/1.3"/>
- <category slug="deprecated/deprecated-1.10"/>
+ <category slug="deprecated/deprecated-1.10-and-2.0"/>
<category slug="removed"/>
</entry>
diff --git a/entries/contextmenu-shorthand.xml b/entries/contextmenu-shorthand.xml
new file mode 100644
index 000000000..9b1f48736
--- /dev/null
+++ b/entries/contextmenu-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="contextmenu" return="jQuery" deprecated="3.3">
+ <title>.contextmenu()</title>
+ <desc>Bind an event handler to the "contextmenu" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.contextmenu( handler )</code> or <code>.contextmenu( eventData, handler )</code>, use <a href="/https/github.com/contextmenu/#on1"><code>.on( "contextmenu", handler )</code></a> or <a href="/https/github.com/contextmenu/#on1"><code>.on( "contextmenu", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.contextmenu()</code>, use <a href="/https/github.com/contextmenu/#trigger2"><code>.trigger( "contextmenu" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/contextmenu.xml b/entries/contextmenu.xml
index a3645ef70..63d9c179c 100644
--- a/entries/contextmenu.xml
+++ b/entries/contextmenu.xml
@@ -1,7 +1,10 @@
<?xml version="1.0"?>
-<entry type="method" name="contextmenu" return="jQuery">
- <title>.contextmenu()</title>
- <desc>Bind an event handler to the "contextmenu" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+<desc>Bind an event handler to the "contextmenu" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>contextmenu event</title>
+ <desc>Bind an event handler to the "contextmenu" event.</desc>
<signature>
<added>1.0</added>
<argument name="handler" type="Function">
@@ -19,12 +22,11 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "contextmenu", handler )</code> in the first two variations, and <code>.trigger( "contextmenu" )</code> in the third.
- The <code>contextmenu</code> event is sent to an element when the right button of the mouse is clicked on it, but before the context menu is displayed. In case the context menu key is pressed, the event is triggered on the <code>html</code> element or the currently focused element. Any HTML element can receive this event.
+ <div class="warning">
+ <p>This page describes the <code>contextmenu</code> event. For the deprecated <code>.contextmenu()</code> method, see <a href="/https/github.com/contextmenu-shorthand/"><code>.contextmenu()</code></a>.</p>
+ </div>
+ <p>The <code>contextmenu</code> event is sent to an element when the right button of the mouse is clicked on it, but before the context menu is displayed. In case the context menu key is pressed, the event is triggered on the <code>html</code> element or the currently focused element. Any HTML element can receive this event.
For example, consider the HTML:</p>
<pre><code>
<div id="target">
@@ -33,35 +35,34 @@
</code></pre>
<p>The event handler can be bound to the <code><div></code> as follows:</p>
<pre><code>
-$( "#target" ).contextmenu(function() {
- alert( "Handler for .contextmenu() called." );
-});
+$( "#target" ).on( "contextmenu", function() {
+ alert( "Handler for `contextmenu` called." );
+} );
</code></pre>
<p>Now right-clicking on this element displays the alert:</p>
<p>
- <samp>Handler for .contextmenu() called.</samp>
+ <samp>Handler for `contextmenu` called.</samp>
</p>
- <p>To trigger the event manually, call <code>.contextmenu()</code> without an argument:</p>
+ <p>To trigger the event manually, use <code>.trigger( "contextmenu" )</code>:</p>
<pre><code>
-$( "#target" ).contextmenu();
+$( "#target" ).trigger( "contextmenu" );
</code></pre>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="contextmenu"/>
<example>
<desc>To show a "Hello World!" alert box when the contextmenu event is triggered on a paragraph on the page:</desc>
<code><![CDATA[
-$( "p" ).contextmenu(function() {
+$( "p" ).on( "contextmenu", function() {
alert( "Hello World!" );
-});
+} );
]]></code>
</example>
<example>
<desc>Right click to toggle background color.</desc>
<code><![CDATA[
-var div = $( "div:first" );
-div.contextmenu(function() {
+var div = $( "div" ).first();
+div.on( "contextmenu", function() {
div.toggleClass( "contextmenu" );
-});
+} );
]]></code>
<css><![CDATA[
div {
@@ -82,5 +83,23 @@ div.contextmenu(function() {
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>contextmenu event</title>
+ <desc>Trigger the "contextmenu" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""contextmenu"" type="string">
+ <desc>The string <code>"contextmenu"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "contextmenu", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/css.xml b/entries/css.xml
index 34fc7237c..85a304e82 100644
--- a/entries/css.xml
+++ b/entries/css.xml
@@ -19,15 +19,16 @@
<longdesc>
<p>The <code>.css()</code> method is a convenient way to get a computed style property from the first matched element, especially in light of the different ways browsers access most of those properties (the <code>getComputedStyle()</code> method in standards-based browsers versus the <code>currentStyle</code> and <code>runtimeStyle</code> properties in Internet Explorer prior to version 9) and the different terms browsers use for certain properties. For example, Internet Explorer's DOM implementation refers to the <code>float</code> property as <code>styleFloat</code>, while W3C standards-compliant browsers refer to it as <code>cssFloat</code>. For consistency, you can simply use <code>"float"</code>, and jQuery will translate it to the correct value for each browser.</p>
<p>Also, jQuery can equally interpret the CSS and DOM formatting of multiple-word properties. For example, jQuery understands and returns the correct value for both <code>.css( "background-color" )</code> and <code>.css( "backgroundColor" )</code>. This means mixed case has a special meaning, <code>.css( "WiDtH" )</code> won't do the same as <code>.css( "width" )</code>, for example.</p>
- <p>Note that the <em>computed style</em> of an element may not be the same as the value specified for that element in a style sheet. For example, computed styles of dimensions are almost always pixels, but they can be specified as em, ex, px or % in a style sheet. Different browsers may return CSS color values that are logically but not textually equal, e.g., #FFF, #ffffff, and rgb(255,255,255).</p>
+ <p>Note that the <em>computed style</em> of an element may not be the same as the value specified for that element in a style sheet. For example, computed styles of dimensions are almost always pixels, but they can be specified as em, ex, px or % in a style sheet. Different browsers may return CSS color values that are logically but not textually equal, e.g., #FFF, #ffffff, and rgb(255,255,255).</p>
<p>Retrieval of shorthand CSS properties (e.g., <code>margin</code>, <code>background</code>, <code>border</code>), although functional with some browsers, is not guaranteed. For example, if you want to retrieve the rendered <code>border-width</code>, use: <code>$( elem ).css( "borderTopWidth" )</code>, <code>$( elem ).css( "borderBottomWidth" )</code>, and so on.</p>
<p>An element should be connected to the DOM when calling <code>.css()</code> on it. If it isn't, jQuery may throw an error.</p>
<p><strong>As of jQuery 1.9</strong>, passing an array of style properties to <code>.css()</code> will result in an object of property-value pairs. For example, to retrieve all four rendered <code>border-width</code> values, you could use <code>$( elem ).css([ "borderTopWidth", "borderRightWidth", "borderBottomWidth", "borderLeftWidth" ])</code>. </p>
+ <p><strong>As of jQuery 3.2</strong>, <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/--*">CSS Custom Properties</a> (also called CSS Variables) are supported: <code>$( "p" ).css( "--custom-property" )</code>. Note that you need to provide the property name as-is, camelCasing it won't work as it does for regular CSS properties.</p>
</longdesc>
<example>
<desc>Get the background color of a clicked div.</desc>
<code><![CDATA[
-$( "div" ).click(function() {
+$( "div" ).on( "click", function() {
var color = $( this ).css( "background-color" );
$( "#result" ).html( "That div is <span style='color:" +
color + ";'>" + color + "</span>." );
@@ -53,7 +54,7 @@ $( "div" ).click(function() {
<example>
<desc>Get the width, height, text color, and background color of a clicked div.</desc>
<code><![CDATA[
-$( "div" ).click(function() {
+$( "div" ).on( "click", function() {
var html = [ "The clicked div has the following styles:" ];
var styleProps = $( this ).css([
@@ -106,6 +107,8 @@ $( "div" ).click(function() {
<category slug="version/1.0"/>
<category slug="version/1.4"/>
<category slug="version/1.9"/>
+ <category slug="version/3.2"/>
+ <category slug="version/4.0"/>
</entry>
<entry type="method" name="css" return="jQuery">
<signature>
@@ -128,7 +131,7 @@ $( "div" ).click(function() {
<desc>A function returning the value to set. <code>this</code> is the current element. Receives the index position of the element in the set and the old value as arguments.</desc>
<argument name="index" type="Integer" />
<argument name="value" type="String" />
- <return>
+ <return>
<type name="String"/>
<type name="Number"/>
</return>
@@ -144,9 +147,17 @@ $( "div" ).click(function() {
<longdesc>
<p>As with the <code>.prop()</code> method, the <code>.css()</code> method makes setting properties of elements quick and easy. This method can take either a property name and value as separate parameters, or a single object of key-value pairs.</p>
<p>Also, jQuery can equally interpret the CSS and DOM formatting of multiple-word properties. For example, jQuery understands and returns the correct value for both <code>.css({ "background-color": "#ffe", "border-left": "5px solid #ccc" })</code> and <code>.css({backgroundColor: "#ffe", borderLeft: "5px solid #ccc" })</code>. Notice that with the DOM notation, quotation marks around the property names are optional, but with CSS notation they're required due to the hyphen in the name.</p>
- <p>When a number is passed as the value, jQuery will convert it to a string and add <code>px</code> to the end of that string. If the property requires units other than <code>px</code>, convert the value to a string and add the appropriate units before calling the method.</p>
+ <p>In jQuery 3.x or older, when a number is passed as the value, jQuery will convert it to a string and add <code>px</code> to the end of that string. However, there are exceptions. <code>px</code> is not added to keys of <a href="/https/github.com/jQuery.cssNumber/"><code>jQuery.cssNumber</code></a> If the property requires units other than <code>px</code>, convert the value to a string and add the appropriate units before calling the method.</p>
+ <p>In jQuery 4.0 or newer, when a number is passed as the value, jQuery will only convert it to a string and add <code>px</code> to the end of that string for a limited set of properties - mostly related to width, height, border, margin & padding; the full list:</p>
+ <ul>
+ <li>setting the element position: <code>top</code>, <code>right</code>, <code>bottom</code>, <code>left</code></li>
+ <li>setting the element dimensions: <code>width</code>, <code>height</code>, <code>min-width</code>, <code>min-height</code>, <code>max-width</code>, <code>max-height</code></li>
+ <li><code>padding-related</code>: <code>padding</code>, <code>padding-top</code>, <code>padding-right</code>, <code>padding-bottom</code>, <code>padding-left</code></li>
+ <li><code>margin</code>-related: <code>margin</code>, <code>margin-top</code>, <code>margin-right</code>, <code>margin-bottom</code>, <code>margin-left</code></li>
+ <li><code>border</code>-related: <code>border</code>, <code>border-width</code>, <code>border-top</code>, <code>border-top-width</code>, <code>border-right</code>, <code>border-right-width</code>, <code>border-bottom</code>, <code>border-bottom-width</code>, <code>border-left</code>, <code>border-left-width</code></li>
+ </ul>
<p>When using <code>.css()</code> as a setter, jQuery modifies the element's <code>style</code> property. For example, <code>$( "#mydiv" ).css( "color", "green" )</code> is equivalent to <code>document.getElementById( "mydiv" ).style.color = "green"</code>. Setting the value of a style property to an empty string — e.g. <code>$( "#mydiv" ).css( "color", "" )</code> — removes that property from an element if it has already been directly applied, whether in the HTML style attribute, through jQuery's <code>.css()</code> method, or through direct DOM manipulation of the <code>style</code> property. As a consequence, the element's style for that property will be restored to whatever value was applied. So, this method can be used to cancel any style modification you have previously performed. It does not, however, remove a style that has been applied with a CSS rule in a stylesheet or <code><style></code> element. <strong>Warning:</strong> one notable exception is that, for IE 8 and below, removing a shorthand property such as <code>border</code> or <code>background</code> will remove that style entirely from the element, regardless of what is set in a stylesheet or <code><style></code> element.</p>
- <p><strong>Note:</strong> <code>.css()</code> ignores <code>!important</code> declarations. So, the statement <code>$( "p" ).css( "color", "red !important" )</code> does not turn the color of all paragraphs in the page to red. It's strongly advised to use classes instead; otherwise use a jQuery plugin.</p>
+ <p><strong>Note:</strong> <code>.css()</code> doesn't support <code>!important</code> declarations. So, the statement <code>$( "p" ).css( "color", "red !important" )</code> does not turn the color of all paragraphs in the page to red as of jQuery 3.6.0. Do not depend on that <em>not working</em>, though, as a future version of jQuery may add support for such declarations. It's strongly advised to use classes instead; otherwise use a jQuery plugin.</p>
<p>As of jQuery 1.8, the <code>.css()</code> setter will automatically take care of prefixing the property name. For example, take <code>.css( "user-select", "none" )</code> in Chrome/Safari will set it as <code>-webkit-user-select</code>, Firefox will use <code>-moz-user-select</code>, and IE10 will use <code>-ms-user-select</code>.</p>
<p>As of jQuery 1.6, <code>.css()</code> accepts relative values similar to <code>.animate()</code>. Relative values are a string starting with <code>+=</code> or <code>-=</code> to increment or decrement the current value. For example, if an element's padding-left was 10px, <code>.css( "padding-left", "+=15" )</code> would result in a total padding-left of 25px.</p>
<p>As of jQuery 1.4, <code>.css()</code> allows us to pass a function as the property value:</p>
@@ -157,6 +168,7 @@ $( "div.example" ).css( "width", function( index ) {
</code></pre>
<p>This example sets the widths of the matched elements to incrementally larger values.</p>
<p><strong>Note: </strong>If nothing is returned in the setter function (ie. <code>function( index, style ){} )</code>, or if <code>undefined</code> is returned, the current value is not changed. This is useful for selectively setting values only when certain criteria are met.</p>
+ <p><strong>As of jQuery 3.2</strong>, <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/--*">CSS Custom Properties</a> (also called CSS Variables) are supported: <code>$( "p" ).css( "--custom-property", "value" )</code>. Note that you need to provide the property name as-is, camelCasing it won't work as it does for regular CSS properties.</p>
</longdesc>
<example>
<desc>Change the color of any paragraph to red on mouseover event.</desc>
@@ -282,5 +294,7 @@ $( "div" ).on( "click", function() {
<category slug="manipulation/style-properties"/>
<category slug="version/1.0"/>
<category slug="version/1.4"/>
+ <category slug="version/3.2"/>
+ <category slug="version/4.0"/>
</entry>
</entries>
diff --git a/entries/data.xml b/entries/data.xml
index 7e742da1b..d998d38c7 100644
--- a/entries/data.xml
+++ b/entries/data.xml
@@ -40,8 +40,8 @@ $( "body" ).data(); // { foo: 52, bar: { isManual: true }, baz: [ 1, 2, 3 ] }
<desc>Store then retrieve a value from the div element.</desc>
<code><![CDATA[
$( "div" ).data( "test", { first: 16, last: "pizza!" } );
-$( "span:first" ).text( $( "div" ).data( "test" ).first );
-$( "span:last" ).text( $( "div" ).data( "test" ).last );
+$( "span" ).first().text( $( "div" ).data( "test" ).first );
+$( "span" ).last().text( $( "div" ).data( "test" ).last );
]]></code>
<css><![CDATA[
div {
@@ -111,7 +111,7 @@ $( "div" ).data( "options" ).name === "John";
<example>
<desc>Get the data named "blah" stored at for an element.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
var value;
switch ( $( "button" ).index( this ) ) {
diff --git a/entries/dblclick-shorthand.xml b/entries/dblclick-shorthand.xml
new file mode 100644
index 000000000..ad4c1887b
--- /dev/null
+++ b/entries/dblclick-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="dblclick" return="jQuery" deprecated="3.3">
+ <title>.dblclick()</title>
+ <desc>Bind an event handler to the "dblclick" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.dblclick( handler )</code> or <code>.dblclick( eventData, handler )</code>, use <a href="/https/github.com/dblclick/#on1"><code>.on( "dblclick", handler )</code></a> or <a href="/https/github.com/dblclick/#on1"><code>.on( "dblclick", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.dblclick()</code>, use <a href="/https/github.com/dblclick/#trigger2"><code>.trigger( "dblclick" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/dblclick.xml b/entries/dblclick.xml
index c5ffe14b0..9c4cf59a0 100644
--- a/entries/dblclick.xml
+++ b/entries/dblclick.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="dblclick" return="jQuery">
- <title>.dblclick()</title>
- <desc>Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+
+<desc>Bind an event handler to the "dblclick" event, or trigger that event on an element.</desc>
+<entry type="method" name="on" return="jQuery">
+ <title>dblclick event</title>
+ <desc>Bind an event handler to the "dblclick" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""dblclick"" type="string">
+ <desc>The string <code>"dblclick"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,12 +18,11 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "dblclick", handler )</code> in the first two variations, and <code>.trigger( "dblclick" )</code> in the third.
- The <code>dblclick</code> event is sent to an element when the element is double-clicked. Any HTML element can receive this event.
+ <div class="warning">
+ <p>This page describes the <code>dblclick</code> event. For the deprecated <code>.dblclick()</code> method, see <a href="/https/github.com/dblclick-shorthand/"><code>.dblclick()</code></a>.</p>
+ </div>
+ <p>The <code>dblclick</code> event is sent to an element when the element is double-clicked. Any HTML element can receive this event.
For example, consider the HTML:</p>
<pre><code>
<div id="target">
@@ -40,19 +38,19 @@
</figure>
<p>The event handler can be bound to any <code><div></code>:</p>
<pre><code>
-$( "#target" ).dblclick(function() {
- alert( "Handler for .dblclick() called." );
-});
+$( "#target" ).on( "dblclick", function() {
+ alert( "Handler for `dblclick` called." );
+} );
</code></pre>
<p>Now double-clicking on this element displays the alert:</p>
<p>
- <samp>Handler for .dblclick() called.</samp>
+ <samp>Handler for `dblclick` called.</samp>
</p>
- <p>To trigger the event manually, call <code>.dblclick()</code> without an argument:</p>
+ <p>To trigger the event manually, call <code>.trigger( "dblclick" )</code>:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#target" ).dblclick();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "dblclick" );
+} );
</code></pre>
<p>After this code executes, (single) clicks on <samp>Trigger the handler</samp> will also alert the message.</p>
<p>The <code>dblclick</code> event is only triggered after this exact series of events:</p>
@@ -65,22 +63,21 @@ $( "#other" ).click(function() {
<p>It is inadvisable to bind handlers to both the <code>click</code> and <code>dblclick</code> events for the same element. The sequence of events triggered varies from browser to browser, with some receiving two <code>click</code> events before the <code>dblclick</code> and others only one. Double-click sensitivity (maximum time between clicks that is detected as a double click) can vary by operating system and browser, and is often user-configurable.
</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="dblclick"/>
<example>
<desc>To bind a "Hello World!" alert box to the dblclick event on every paragraph on the page:</desc>
<code><![CDATA[
-$( "p" ).dblclick(function() {
+$( "p" ).on( "dblclick", function() {
alert( "Hello World!" );
-});
+} );
]]></code>
</example>
<example>
<desc>Double click to toggle background color.</desc>
<code><![CDATA[
-var divdbl = $( "div:first" );
-divdbl.dblclick(function() {
+var divdbl = $( "div" ).first();
+divdbl.on( "dblclick", function() {
divdbl.toggleClass( "dbl" );
-});
+} );
]]></code>
<css><![CDATA[
div {
@@ -101,5 +98,23 @@ divdbl.dblclick(function() {
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>dblclick event</title>
+ <desc>Trigger the "dblclick" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""dblclick"" type="string">
+ <desc>The string <code>"dblclick"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "dblclick", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/deferred.isRejected.xml b/entries/deferred.isRejected.xml
index 5fdd1e953..a391f7795 100644
--- a/entries/deferred.isRejected.xml
+++ b/entries/deferred.isRejected.xml
@@ -6,8 +6,10 @@
</signature>
<desc> Determine whether a Deferred object has been rejected. </desc>
<longdesc>
- <p>As of jQuery 1.7 this API has been deprecated; please use <a href="/https/github.com/deferred.state/"><code>deferred.state()</code></a> instead.</p>
- <p>Returns <code>true</code> if the Deferred object is in the rejected state, meaning that either <a href="h/deferred.reject/"><code>deferred.reject()</code></a> or <a href="/https/github.com/deferred.rejectWith/"><code>deferred.rejectWith()</code></a> has been called for the object and the failCallbacks have been called (or are in the process of being called).</p>
+ <div class="warning">
+ <p>Note: This API has been removed in jQuery 1.8; please use <a href="/https/github.com/deferred.state/"><code>deferred.state()</code></a> instead.</p>
+ </div>
+ <p>Returns <code>true</code> if the Deferred object is in the rejected state, meaning that either <a href="/https/github.com/deferred.reject/"><code>deferred.reject()</code></a> or <a href="/https/github.com/deferred.rejectWith/"><code>deferred.rejectWith()</code></a> has been called for the object and the failCallbacks have been called (or are in the process of being called).</p>
<p>Note that a Deferred object can be in one of three states: pending, resolved, or rejected; use <a href="/https/github.com/deferred.isResolved/"><code>deferred.isResolved()</code></a> to determine whether the Deferred object is in the resolved state. These methods are primarily useful for debugging, for example to determine whether a Deferred has already been resolved even though you are inside code that intended to reject it.</p>
</longdesc>
<category slug="deferred-object"/>
diff --git a/entries/deferred.isResolved.xml b/entries/deferred.isResolved.xml
index b59413220..9c046e5ae 100644
--- a/entries/deferred.isResolved.xml
+++ b/entries/deferred.isResolved.xml
@@ -6,7 +6,9 @@
</signature>
<desc> Determine whether a Deferred object has been resolved. </desc>
<longdesc>
- <p>This API is <code>deprecated</code> as of jQuery 1.7 and <code>removed</code> as of jQuery 1.8; please use <a href="/https/github.com/deferred.state/"><code>deferred.state()</code></a> instead.</p>
+ <div class="warning">
+ <p>Note: This API has been removed in jQuery 1.8; please use <a href="/https/github.com/deferred.state/"><code>deferred.state()</code></a> instead.</p>
+ </div>
<p>Returns <code>true</code> if the Deferred object is in the resolved state, meaning that either <a href="/https/github.com/deferred.resolve/"><code>deferred.resolve()</code></a> or <a href="/https/github.com/deferred.resolveWith/"><code>deferred.resolveWith()</code></a> has been called for the object and the doneCallbacks have been called (or are in the process of being called).</p>
<p>Note that a Deferred object can be in one of three states: pending, resolved, or rejected; use <a href="/https/github.com/deferred.isRejected/"><code>deferred.isRejected()</code></a> to determine whether the Deferred object is in the rejected state. These methods are primarily useful for debugging, for example to determine whether a Deferred has already been resolved even though you are inside code that intended to reject it.</p>
</longdesc>
diff --git a/entries/deferred.pipe.xml b/entries/deferred.pipe.xml
index 66eda149d..a74f9dac6 100644
--- a/entries/deferred.pipe.xml
+++ b/entries/deferred.pipe.xml
@@ -34,7 +34,9 @@
</signature>
<desc> Utility method to filter and/or chain Deferreds. </desc>
<longdesc>
- <p><strong>Deprecation Notice:</strong>As of jQuery 1.8, the deferred.pipe() method is deprecated. The <code>deferred.then()</code> method, which replaces it, should be used instead.</p>
+ <div class="warning">
+ <p><strong>Deprecation Notice:</strong>As of jQuery 1.8, the deferred.pipe() method is deprecated. The <code>deferred.then()</code> method, which replaces it, should be used instead.</p>
+ </div>
<p>The <code>deferred.pipe()</code> method returns a new promise that filters the status and values of a deferred through a function. The <code>doneFilter</code> and <code>failFilter</code> functions filter the original deferred's resolved / rejected status and values. <strong>As of jQuery 1.7</strong>, the method also accepts a <code>progressFilter</code> function to filter any calls to the original deferred's <code>notify</code> or <code>notifyWith</code> methods. These filter functions can return a new value to be passed along to the piped promise's <code>done()</code> or <code>fail()</code> callbacks, or they can return another observable object (Deferred, Promise, etc) which will pass its resolved / rejected status and values to the piped promise's callbacks. If the filter function used is <code>null</code>, or not specified, the piped promise will be resolved or rejected with the same values as the original.</p>
</longdesc>
<example>
diff --git a/entries/delay.xml b/entries/delay.xml
index c94b2a0b1..b2066217d 100644
--- a/entries/delay.xml
+++ b/entries/delay.xml
@@ -21,7 +21,7 @@ $( "#foo" ).slideUp( 300 ).delay( 800 ).fadeIn( 400 );
<p>When this statement is executed, the element slides up for 300 milliseconds and then pauses for 800 milliseconds before fading in for 400 milliseconds.</p>
<div class="warning">
<p>
- <strong>The <code>.delay()</code> method is best for delaying between queued jQuery effects. Because it is limited—it doesn't, for example, offer a way to cancel the delay—<code>.delay()</code> is not a replacement for JavaScript's native <a href="https://developer.mozilla.org/en-US/docs/Web/API/WindowTimers.setTimeout">setTimeout</a> function, which may be more appropriate for certain use cases.</strong>
+ <strong>The <code>.delay()</code> method is best for delaying between queued jQuery effects. Because it is limited—it doesn't, for example, offer a way to cancel the delay—<code>.delay()</code> is not a replacement for JavaScript's native <a href="https://developer.mozilla.org/en-US/docs/Web/API/setTimeout">setTimeout</a> function, which may be more appropriate for certain use cases.</strong>
</p>
</div>
</longdesc>
@@ -44,7 +44,7 @@ $( "#foo" ).slideUp( 300 ).delay( 800 ).fadeIn( 400 );
}
]]></css>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "div.first" ).slideUp( 300 ).delay( 800 ).fadeIn( 400 );
$( "div.second" ).slideUp( 300 ).fadeIn( 400 );
});
diff --git a/entries/delegate.xml b/entries/delegate.xml
index 10641ae65..c0c0dac72 100644
--- a/entries/delegate.xml
+++ b/entries/delegate.xml
@@ -127,7 +127,7 @@ $( "body" ).delegate( "p", "myCustomEvent", function( e, myName, myValue ) {
.fadeIn( 30 )
.fadeOut( 1000 );
});
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "p" ).trigger( "myCustomEvent" );
});
]]></code>
diff --git a/entries/dequeue.xml b/entries/dequeue.xml
index 7caca4e36..c54401c78 100644
--- a/entries/dequeue.xml
+++ b/entries/dequeue.xml
@@ -14,7 +14,7 @@
<example>
<desc>Use dequeue to end a custom queue function which allows the queue to keep going.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "div" )
.animate({ left:"+=200px" }, 2000 )
.animate({ top:"0px" }, 600 )
diff --git a/entries/detach.xml b/entries/detach.xml
index 2ff7037c7..bc6b32c77 100644
--- a/entries/detach.xml
+++ b/entries/detach.xml
@@ -14,11 +14,11 @@
<example>
<desc>Detach all paragraphs from the DOM</desc>
<code><![CDATA[
-$( "p" ).click(function() {
+$( "p" ).on( "click", function() {
$( this ).toggleClass( "off" );
});
var p;
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
if ( p ) {
p.appendTo( "body" );
p = null;
diff --git a/entries/die.xml b/entries/die.xml
index a3d038ec3..efe2e6145 100644
--- a/entries/die.xml
+++ b/entries/die.xml
@@ -21,6 +21,9 @@
</argument>
</signature>
<longdesc>
+ <div class="warning">
+ <p>Note: This API has been removed in jQuery 1.9; please use <a href="/https/github.com/on/"><code>on()</code></a> instead.</p>
+ </div>
<p>Any handler that has been attached with <code>.live()</code> can be removed with <code>.die()</code>. This method is analogous to calling <code>.off()</code> with no arguments, which is used to remove all handlers attached with <code>.on()</code>.
See the discussions of <code>.live()</code> and <code>.off()</code> for further details.</p>
<p>If used without an argument, .die() removes <em>all</em> event handlers previously attached using <code>.live()</code> from the elements.</p>
diff --git a/entries/each.xml b/entries/each.xml
index 9a882fb2a..fd2db6483 100644
--- a/entries/each.xml
+++ b/entries/each.xml
@@ -6,7 +6,7 @@
<argument name="function" type="Function">
<desc>A function to execute for each matched element.</desc>
<argument name="index" type="Integer" />
- <argument name="element" type="Element" />
+ <argument name="element" type="Element" />
</argument>
</signature>
<desc>Iterate over a jQuery object, executing a function for each matched element. </desc>
@@ -46,15 +46,15 @@ $( "li" ).addClass( "bar" );
<example>
<desc>Iterate over three divs and sets their color property.</desc>
<code><![CDATA[
-$( document.body ).click(function() {
- $( "div" ).each(function( i ) {
+$( document.body ).on( "click", function() {
+ $( "div" ).each( function( i ) {
if ( this.style.color !== "blue" ) {
this.style.color = "blue";
} else {
this.style.color = "";
}
- });
-});
+ } );
+} );
]]></code>
<css><![CDATA[
div {
@@ -74,7 +74,7 @@ $( document.body ).click(function() {
<example>
<desc>To access a jQuery object instead of the regular DOM element, use <code>$( this )</code>. For example:</desc>
<code><![CDATA[
-$( "span" ).click(function() {
+$( "span" ).on( "click", function() {
$( "li" ).each(function() {
$( this ).toggleClass( "example" );
});
@@ -106,7 +106,7 @@ To do list: <span>(click here to change)</span>
<example>
<desc>Use <code>return false</code> to break out of each() loops early.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "div" ).each(function( index, element ) {
// element == this
$( element ).css( "backgroundColor", "yellow" );
diff --git a/entries/empty.xml b/entries/empty.xml
index 2be809f43..097ad9c66 100644
--- a/entries/empty.xml
+++ b/entries/empty.xml
@@ -31,9 +31,9 @@ $( ".hello" ).empty();
<example>
<desc>Removes all child nodes (including text nodes) from all paragraphs</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "p" ).empty();
-});
+} );
]]></code>
<css><![CDATA[
p {
diff --git a/entries/end.xml b/entries/end.xml
index 51b8cf3e7..7f85ea1aa 100644
--- a/entries/end.xml
+++ b/entries/end.xml
@@ -51,7 +51,7 @@ jQuery.fn.showTags = function( n ) {
})
.get()
.join( ", " );
- $( "b:eq( " + n + " )" ).text( tags );
+ $( "b" ).eq( n ).text( tags );
return this;
};
diff --git a/entries/eq-selector.xml b/entries/eq-selector.xml
index 1e48407b5..a191d31be 100644
--- a/entries/eq-selector.xml
+++ b/entries/eq-selector.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="selector" name="eq" return="">
+<entry type="selector" name="eq" return="" deprecated="3.4">
<title>:eq() Selector</title>
<signature>
<sample>:eq(index)</sample>
@@ -17,6 +17,9 @@
</signature>
<desc>Select the element at index <code>n</code> within the matched set.</desc>
<longdesc>
+ <div class="warning">
+ <p><strong>As of jQuery 3.4</strong>, the <code>:eq</code> pseudo-class is deprecated. Remove it from your selectors and filter the results later using <a href="/https/github.com/eq/"><code>.eq()</code></a>.</p>
+ </div>
<p>The index-related selectors (<code>:eq()</code>, <code>:lt()</code>, <code>:gt()</code>, <code>:even</code>, <code>:odd</code>) filter the set of elements that have matched the expressions that precede them. They narrow the set down based on the order of the elements within this matched set. For example, if elements are first selected with a class selector (<code>.myclass</code>) and four elements are returned, these elements are given indices <code>0</code> through <code>3</code> for the purposes of these selectors.</p>
<p>Note that since JavaScript arrays use <em>0-based indexing</em>, these selectors reflect that fact. This is why <code>$( ".myclass:eq(1)" )</code> selects the second element in the document with the class myclass, rather than the first. In contrast, <code>:nth-child(n)</code> uses <em>1-based indexing</em> to conform to the CSS specification.</p>
<p>Prior to jQuery 1.8, the <code>:eq(index)</code> selector did <em>not</em> accept a negative value for <code>index</code> (though the <a href="/https/github.com/eq/"><code>.eq(index)</code></a> method did).</p>
@@ -92,4 +95,5 @@ $( "li:eq(-2)" ).addClass( "foo" )
<category slug="selectors/jquery-selector-extensions"/>
<category slug="version/1.0"/>
<category slug="version/1.8"/>
+ <category slug="deprecated/deprecated-3.4"/>
</entry>
diff --git a/entries/error-shorthand.xml b/entries/error-shorthand.xml
new file mode 100644
index 000000000..b40d9b755
--- /dev/null
+++ b/entries/error-shorthand.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<entry type="method" name="error" return="jQuery" deprecated="1.8" removed="3.0">
+ <title>.error()</title>
+ <desc>Bind an event handler to the "error" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API has been removed in jQuery 3.0.</p>
+ <p>Instead of <code>.error( handler )</code> or <code>.error( eventData, handler )</code>, use <a href="/https/github.com/error/#on1"><code>.on( "error", handler )</code></a> or <a href="/https/github.com/error/#on1"><code>.on( "error", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.error()</code>, use <a href="/https/github.com/error/#trigger2"><code>.trigger( "error" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/browser-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-1.8"/>
+ <category slug="removed"/>
+</entry>
diff --git a/entries/error.xml b/entries/error.xml
index 6f646aa23..d1f9493ea 100644
--- a/entries/error.xml
+++ b/entries/error.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="error" return="jQuery" deprecated="1.8" removed="3.0">
- <title>.error()</title>
- <desc>Bind an event handler to the "error" JavaScript event.</desc>
+<entries>
+<desc>Bind an event handler to the "error" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>error event</title>
+ <desc>Bind an event handler to the "error" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute when the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""error"" type="string">
+ <desc>The string <code>"error"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -20,8 +19,9 @@
</argument>
</signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "error", handler )</code>.</p>
- <p><b>As of jQuery 1.8</b>, the <code>.error()</code> method is deprecated. Use <code>.on( "error", handler )</code> to attach event handlers to the <code>error</code> event instead.</p>
+ <div class="warning">
+ <p>This page describes the <code>error</code> event. For the <code>.error()</code> method removed in jQuery 3.0, see <a href="/https/github.com/error-shorthand/"><code>.error()</code></a>.</p>
+ </div>
<p>The <code>error</code> event is sent to elements, such as images, that are referenced by a document and loaded by the browser. It is called if the element was not loaded correctly.</p>
<p>For example, consider a page with a simple image element:</p>
<pre><code>
@@ -30,35 +30,50 @@
<p>The event handler can be bound to the image:</p>
<pre><code>
$( "#book" )
- .error(function() {
- alert( "Handler for .error() called." )
- })
+ .on( "error", function() {
+ alert( "Handler for `error` called." )
+ } )
.attr( "src", "missing.png" );
</code></pre>
<p>If the image cannot be loaded (for example, because it is not present at the supplied URL), the alert is displayed:</p>
<p>
- <samp>Handler for .error() called.</samp>
+ <samp>Handler for `error` called.</samp>
</p>
<div class="warning">
<p>The event handler <em>must</em> be attached before the browser fires the <code>error</code> event, which is why the example sets the <code>src</code> attribute after attaching the handler. Also, the <code>error</code> event may not be correctly fired when the page is served locally; <code>error</code> relies on HTTP status codes and will generally not be triggered if the URL uses the <code>file:</code> protocol.</p>
</div>
<p>Note: A jQuery <code>error</code> event handler should not be attached to the <code>window</code> object. The browser fires the <code>window</code>'s <code>error</code> event when a script error occurs. However, the window <code>error</code> event receives different arguments and has different return value requirements than conventional event handlers. Use <code>window.onerror</code> instead.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="error"/>
<example>
- <desc>To replace all the missing images with another, you can update the <code>src</code> attribute inside the callback passed to <code>.error()</code>. Be sure that the replacement image exists; otherwise the <code>error</code> event will be triggered indefinitely.</desc>
+ <desc>To replace all the missing images with another, you can update the <code>src</code> attribute inside the <code>error</code> handler. Be sure that the replacement image exists; otherwise the <code>error</code> event will be triggered indefinitely.</desc>
<code><![CDATA[
// If missing.png is missing, it is replaced by replacement.png
$( "img" )
- .error(function() {
+ .on( "error", function() {
$( this ).attr( "src", "replacement.png" );
- })
+ } )
.attr( "src", "missing.png" );
]]></code>
</example>
<category slug="events/browser-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
- <category slug="deprecated/deprecated-1.8"/>
- <category slug="removed"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>error event</title>
+ <desc>Trigger the "error" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""error"" type="string">
+ <desc>The string <code>"error"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "error", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/browser-events"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/even-selector.xml b/entries/even-selector.xml
index f190e0667..bfc8038a3 100644
--- a/entries/even-selector.xml
+++ b/entries/even-selector.xml
@@ -1,12 +1,15 @@
<?xml version="1.0"?>
-<entry type="selector" name="even" return="">
+<entry type="selector" name="even" return="" deprecated="3.4">
<title>:even Selector</title>
<sample>:even</sample>
<signature>
<added>1.0</added>
</signature>
- <desc>Selects even elements, zero-indexed. See also <a href="/Selectors/odd/">odd</a>.</desc>
+ <desc>Selects even elements, zero-indexed. See also <a href="/https/github.com/odd-selector/"><code>:odd</code></a>.</desc>
<longdesc>
+ <div class="warning">
+ <p><strong>As of jQuery 3.4</strong>, the <code>:even</code> pseudo-class is deprecated. Remove it from your selectors and filter the results later using <a href="/https/github.com/even/"><code>.even()</code></a> (available in jQuery 3.5.0 or newer).</p>
+ </div>
<p>In particular, note that the <em>0-based indexing</em> means that, counter-intuitively, <code>:even</code> selects the first element, third element, and so on within the matched set.</p>
</longdesc>
<note id="jquery-selector-extension" type="additional" data-selector=":even"/>
@@ -33,4 +36,5 @@ $( "tr:even" ).css( "background-color", "#bbf" );
<category slug="selectors/basic-filter-selectors"/>
<category slug="selectors/jquery-selector-extensions"/>
<category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.4"/>
</entry>
diff --git a/entries/even.xml b/entries/even.xml
new file mode 100644
index 000000000..cecff9e42
--- /dev/null
+++ b/entries/even.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0"?>
+<entry type="method" name="even" return="jQuery">
+ <title>.even()</title>
+ <signature>
+ <added>3.5</added>
+ </signature>
+ <desc>Reduce the set of matched elements to the even ones in the set, numbered from zero.</desc>
+ <longdesc>
+ <p>Given a jQuery object that represents a set of DOM elements, the <code>.even()</code> method constructs a new jQuery object from the even elements in that set. Counting starts from zero!</p>
+ <p>Consider a page with a simple list on it:</p>
+ <pre><code>
+<ul>
+ <li>list item 1</li>
+ <li>list item 2</li>
+ <li>list item 3</li>
+ <li>list item 4</li>
+ <li>list item 5</li>
+</ul>
+ </code></pre>
+ <p>We can apply this method to the set of list items:</p>
+ <pre><code>
+$( "li" ).even().css( "background-color", "red" );
+ </code></pre>
+ <p>The result of this call is a red background for the first, third & 5th items.</p>
+ </longdesc>
+ <example>
+ <desc>Highlight the even items in a list.</desc>
+ <css><![CDATA[
+ .highlight {
+ background-color: yellow;
+ }
+]]></css>
+ <code><![CDATA[
+$( "ul li" ).even().addClass( "highlight" );
+]]></code>
+ <html><![CDATA[
+<ul>
+ <li>Look:</li>
+ <li>This is some text in a list.</li>
+ <li>This is a note about it.</li>
+ <li>This is another note about it.</li>
+</ul>
+]]></html>
+ </example>
+ <category slug="traversing/filtering"/>
+ <category slug="version/3.5"/>
+</entry>
diff --git a/entries/event.currentTarget.xml b/entries/event.currentTarget.xml
index f70a8626d..859cb8d41 100644
--- a/entries/event.currentTarget.xml
+++ b/entries/event.currentTarget.xml
@@ -14,11 +14,11 @@
<example>
<desc>Alert that currentTarget matches the `this` keyword.</desc>
<code><![CDATA[
-$( "p" ).click(function( event ) {
+$( "p" ).on( "click", function( event ) {
alert( event.currentTarget === this ); // true
});
]]></code>
</example>
<category slug="events/event-object"/>
<category slug="version/1.3"/>
-</entry>
\ No newline at end of file
+</entry>
diff --git a/entries/event.isDefaultPrevented.xml b/entries/event.isDefaultPrevented.xml
index 676b31f3b..d9ada3149 100644
--- a/entries/event.isDefaultPrevented.xml
+++ b/entries/event.isDefaultPrevented.xml
@@ -9,7 +9,7 @@
<example>
<desc>Checks whether event.preventDefault() was called.</desc>
<code><![CDATA[
-$( "a" ).click(function( event ) {
+$( "a" ).on( "click", function( event ) {
alert( event.isDefaultPrevented() ); // false
event.preventDefault();
alert( event.isDefaultPrevented() ); // true
diff --git a/entries/event.isImmediatePropagationStopped.xml b/entries/event.isImmediatePropagationStopped.xml
index 4d8f3ad1e..433cd4912 100644
--- a/entries/event.isImmediatePropagationStopped.xml
+++ b/entries/event.isImmediatePropagationStopped.xml
@@ -21,7 +21,7 @@ function immediatePropStopped( event ) {
$( "#stop-log" ).append( "<div>" + msg + "</div>" );
}
-$( "button" ).click(function( event ) {
+$( "button" ).on( "click", function( event ) {
immediatePropStopped( event );
event.stopImmediatePropagation();
immediatePropStopped( event );
diff --git a/entries/event.isPropagationStopped.xml b/entries/event.isPropagationStopped.xml
index 26a85b760..c6c270b4d 100644
--- a/entries/event.isPropagationStopped.xml
+++ b/entries/event.isPropagationStopped.xml
@@ -21,11 +21,11 @@ function propStopped( event ) {
$( "#stop-log" ).append( "<div>" + msg + "</div>" );
}
-$( "button" ).click(function(event) {
+$( "button" ).on( "click", function( event ) {
propStopped( event );
event.stopPropagation();
propStopped( event );
-});
+} );
]]></code>
<html><![CDATA[
<button>click me</button>
diff --git a/entries/event.metaKey.xml b/entries/event.metaKey.xml
index f27b6e463..0c00d6b9b 100644
--- a/entries/event.metaKey.xml
+++ b/entries/event.metaKey.xml
@@ -26,7 +26,7 @@
<div id="display"></div>
]]></html>
<code><![CDATA[
-$( "#checkMetaKey" ).click(function( event ) {
+$( "#checkMetaKey" ).on( "click", function( event ) {
$( "#display" ).text( event.metaKey );
});
]]></code>
diff --git a/entries/event.namespace.xml b/entries/event.namespace.xml
index ed661c920..bbebcda4d 100644
--- a/entries/event.namespace.xml
+++ b/entries/event.namespace.xml
@@ -14,7 +14,7 @@
$( "p" ).on( "test.something", function( event ) {
alert( event.namespace );
});
-$( "button" ).click(function( event ) {
+$( "button" ).on( "click", function( event ) {
$( "p" ).trigger( "test.something" );
});
]]></code>
diff --git a/entries/event.preventDefault.xml b/entries/event.preventDefault.xml
index ac534fcbc..82b4e1047 100644
--- a/entries/event.preventDefault.xml
+++ b/entries/event.preventDefault.xml
@@ -11,7 +11,7 @@
<example>
<desc>Cancel the default action (navigation) of the click.</desc>
<code><![CDATA[
-$( "a" ).click(function( event ) {
+$( "a" ).on( "click", function( event ) {
event.preventDefault();
$( "<div>" )
.append( "default " + event.type + " prevented" )
diff --git a/entries/event.relatedTarget.xml b/entries/event.relatedTarget.xml
index 97908df75..e4ee9eafa 100644
--- a/entries/event.relatedTarget.xml
+++ b/entries/event.relatedTarget.xml
@@ -11,9 +11,9 @@
<example>
<desc>On mouseout of anchors, alert the element type being entered.</desc>
<code><![CDATA[
-$( "a" ).mouseout(function( event ) {
+$( "a" ).on( "mouseout", function( event ) {
alert( event.relatedTarget.nodeName ); // "DIV"
-});
+} );
]]></code>
</example>
<category slug="events/event-object"/>
diff --git a/entries/event.result.xml b/entries/event.result.xml
index fa5cd9adc..40bd18724 100644
--- a/entries/event.result.xml
+++ b/entries/event.result.xml
@@ -11,10 +11,10 @@
<example>
<desc>Display previous handler's return value</desc>
<code><![CDATA[
-$( "button" ).click(function( event ) {
+$( "button" ).on( "click", function( event ) {
return "hey";
});
-$( "button" ).click(function( event ) {
+$( "button" ).on( "click", function( event ) {
$( "p" ).html( event.result );
});
]]></code>
diff --git a/entries/event.stopImmediatePropagation.xml b/entries/event.stopImmediatePropagation.xml
index e5b53eba9..dd86bd7cc 100644
--- a/entries/event.stopImmediatePropagation.xml
+++ b/entries/event.stopImmediatePropagation.xml
@@ -25,14 +25,14 @@
}
]]></css>
<code><![CDATA[
-$( "p" ).click(function( event ) {
+$( "p" ).on( "click", function( event ) {
event.stopImmediatePropagation();
});
-$( "p" ).click(function( event ) {
+$( "p" ).on( "click", function( event ) {
// This function won't be executed
$( this ).css( "background-color", "#f00" );
});
-$( "div" ).click(function( event ) {
+$( "div" ).on( "click", function( event ) {
// This function will be executed
$( this ).css( "background-color", "#f00" );
});
diff --git a/entries/event.stopPropagation.xml b/entries/event.stopPropagation.xml
index 8d34bd4df..de93b6e68 100644
--- a/entries/event.stopPropagation.xml
+++ b/entries/event.stopPropagation.xml
@@ -14,7 +14,7 @@
<example>
<desc>Kill the bubbling on the click event.</desc>
<code><![CDATA[
-$( "p" ).click(function( event ) {
+$( "p" ).on( "click", function( event ) {
event.stopPropagation();
// Do something
});
diff --git a/entries/event.target.xml b/entries/event.target.xml
index 7ce3c544b..82c701778 100644
--- a/entries/event.target.xml
+++ b/entries/event.target.xml
@@ -11,7 +11,7 @@
<example>
<desc>Display the tag's name on click</desc>
<code><![CDATA[
-$( "body" ).click(function( event ) {
+$( "body" ).on( "click", function( event ) {
$( "#log" ).html( "clicked: " + event.target.nodeName );
});
]]></code>
@@ -40,7 +40,7 @@ function handler( event ) {
target.children().toggle();
}
}
-$( "ul" ).click( handler ).find( "ul" ).hide();
+$( "ul" ).on( "click", handler ).find( "ul" ).hide();
]]></code>
<html><![CDATA[
<ul>
diff --git a/entries/event.timeStamp.xml b/entries/event.timeStamp.xml
index f63b62cea..089997ba7 100644
--- a/entries/event.timeStamp.xml
+++ b/entries/event.timeStamp.xml
@@ -22,7 +22,7 @@
]]></css>
<code><![CDATA[
var last, diff;
-$( "div" ).click(function( event ) {
+$( "div" ).on( "click", function( event ) {
if ( last ) {
diff = event.timeStamp - last;
$( "div" ).append( "time since last event: " + diff + "<br>" );
diff --git a/entries/event.type.xml b/entries/event.type.xml
index 8bde75591..a51cc1c85 100644
--- a/entries/event.type.xml
+++ b/entries/event.type.xml
@@ -9,7 +9,7 @@
<example>
<desc>On all anchor clicks, alert the event type.</desc>
<code><![CDATA[
-$( "a" ).click(function( event ) {
+$( "a" ).on( "click", function( event ) {
alert( event.type ); // "click"
});
]]></code>
diff --git a/entries/event.which.xml b/entries/event.which.xml
index 1d36d5277..e8e6aa28b 100644
--- a/entries/event.which.xml
+++ b/entries/event.which.xml
@@ -6,7 +6,7 @@
</signature>
<desc>For key or mouse events, this property indicates the specific key or button that was pressed.</desc>
<longdesc>
- <p>The <code>event.which</code> property normalizes <code>event.keyCode</code> and <code>event.charCode</code>. It is recommended to watch <code>event.which</code> for keyboard key input. For more detail, read about <a href="https://developer.mozilla.org/en/DOM/event.charCode#Notes">event.charCode on the MDN</a>. </p>
+ <p>The <code>event.which</code> property normalizes <code>event.keyCode</code> and <code>event.charCode</code>. It is recommended to watch <code>event.which</code> for keyboard key input. For more detail, read about <a href="https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/charCode#notes">event.charCode on the MDN</a>. </p>
<p><code>event.which</code> also normalizes button presses (<code>mousedown</code> and <code>mouseup</code>events), reporting <code>1</code> for left button, <code>2</code> for middle, and <code>3</code> for right. Use <code>event.which</code> instead of <code>event.button</code>. </p>
</longdesc>
<example>
diff --git a/entries/fadeIn.xml b/entries/fadeIn.xml
index 0f4b6888b..1975c039c 100644
--- a/entries/fadeIn.xml
+++ b/entries/fadeIn.xml
@@ -29,7 +29,7 @@
<img id="book" src="book.png" alt="" width="100" height="123">
// With the element initially hidden, we can show it slowly:
-$( "#clickme" ).click(function() {
+$( "#clickme" ).on( "click", function() {
$( "#book" ).fadeIn( "slow", function() {
// Animation complete
});
@@ -52,9 +52,9 @@ $( "#clickme" ).click(function() {
<example>
<desc>Animates hidden divs to fade in one by one, completing each animation within 600 milliseconds.</desc>
<code><![CDATA[
-$( document.body ).click(function() {
- $( "div:hidden:first" ).fadeIn( "slow" );
-});
+$( document.body ).on( "click", function() {
+ $( "div:hidden" ).first().fadeIn( "slow" );
+} );
]]></code>
<css><![CDATA[
span {
@@ -88,7 +88,7 @@ $( document.body ).click(function() {
<example>
<desc>Fades a red block in over the text. Once the animation is done, it quickly fades in more text on top.</desc>
<code><![CDATA[
-$( "a" ).click(function() {
+$( "a" ).on( "click", function() {
$( "div" ).fadeIn( 3000, function() {
$( "span" ).fadeIn( 100 );
});
diff --git a/entries/fadeOut.xml b/entries/fadeOut.xml
index 186056ebd..5050e1a57 100644
--- a/entries/fadeOut.xml
+++ b/entries/fadeOut.xml
@@ -30,7 +30,7 @@
</code></pre>
<p>With the element initially shown, we can hide it slowly:</p>
<pre><code>
-$( "#clickme" ).click(function() {
+$( "#clickme" ).on( "click", function() {
$( "#book" ).fadeOut( "slow", function() {
// Animation complete.
});
@@ -56,7 +56,7 @@ $( "#clickme" ).click(function() {
<example>
<desc>Animates all paragraphs to fade out, completing the animation within 600 milliseconds.</desc>
<code><![CDATA[
-$( "p" ).click(function() {
+$( "p" ).on( "click", function() {
$( "p" ).fadeOut( "slow" );
});
]]></code>
@@ -76,7 +76,7 @@ $( "p" ).click(function() {
<example>
<desc>Fades out spans in one section that you click on.</desc>
<code><![CDATA[
-$( "span" ).click(function() {
+$( "span" ).on( "click", function() {
$( this ).fadeOut( 1000, function() {
$( "div" ).text( "'" + $( this ).text() + "' has faded!" );
$( this ).remove();
@@ -113,7 +113,7 @@ $( "span" ).hover(function() {
<example>
<desc>Fades out two divs, one with a "linear" easing and one with the default, "swing," easing.</desc>
<code><![CDATA[
-$( "#btn1" ).click(function() {
+$( "#btn1" ).on( "click", function() {
function complete() {
$( "<div>" ).text( this.id ).appendTo( "#log" );
}
@@ -121,7 +121,7 @@ $( "#btn1" ).click(function() {
$( "#box2" ).fadeOut( 1600, complete );
});
-$( "#btn2" ).click(function() {
+$( "#btn2" ).on( "click", function() {
$( "div" ).show();
$( "#log" ).empty();
});
diff --git a/entries/fadeTo.xml b/entries/fadeTo.xml
index 4bf38be14..c77da0d68 100644
--- a/entries/fadeTo.xml
+++ b/entries/fadeTo.xml
@@ -44,7 +44,7 @@
</div>
<img id="book" src="book.png" alt="" width="100" height="123">
// With the element initially shown, we can dim it slowly:
-$( "#clickme" ).click(function() {
+$( "#clickme" ).on( "click", function() {
$( "#book" ).fadeTo( "slow" , 0.5, function() {
// Animation complete.
});
@@ -63,9 +63,9 @@ $( "#clickme" ).click(function() {
<example>
<desc>Animates first paragraph to fade to an opacity of 0.33 (33%, about one third visible), completing the animation within 600 milliseconds.</desc>
<code><![CDATA[
-$( "p:first" ).click(function() {
+$( "p" ).first().on( "click", function() {
$( this ).fadeTo( "slow", 0.33 );
-});
+} );
]]></code>
<html><![CDATA[
<p>
@@ -80,7 +80,7 @@ Compare to this one that won't fade.
<example>
<desc>Fade div to a random opacity on each click, completing the animation within 200 milliseconds.</desc>
<code><![CDATA[
-$( "div" ).click(function() {
+$( "div" ).on( "click", function() {
$( this ).fadeTo( "fast", Math.random() );
});
]]></code>
@@ -128,26 +128,26 @@ var getPos = function( n ) {
$( "p" ).each(function( n ) {
var r = Math.floor( Math.random() * 3 );
var tmp = $( this ).text();
- $( this ).text( $( "p:eq(" + r + ")" ).text() );
- $( "p:eq(" + r + ")" ).text( tmp );
+ $( this ).text( $( "p" ).eq( r ).text() );
+ $( "p" ).eq( r ).text( tmp );
$( this ).css( "left", getPos( n ) );
-});
+} );
$( "div" )
.each(function( n ) {
$( this ).css( "left", getPos( n ) );
- })
+ } )
.css( "cursor", "pointer" )
- .click( function() {
+ .on( "click", function() {
$( this ).fadeTo( 250, 0.25, function() {
$( this )
.css( "cursor", "" )
.prev()
- .css({
+ .css( {
"font-weight": "bolder",
"font-style": "italic"
- });
- });
- });
+ } );
+ } );
+ } );
]]></code>
<css><![CDATA[
div, p {
diff --git a/entries/fadeToggle.xml b/entries/fadeToggle.xml
index f3906b453..22e246ee4 100644
--- a/entries/fadeToggle.xml
+++ b/entries/fadeToggle.xml
@@ -26,14 +26,14 @@
<example>
<desc>Fades first paragraph in or out, completing the animation within 600 milliseconds and using a linear easing. Fades last paragraph in or out for 200 milliseconds, inserting a "finished" message upon completion. </desc>
<code><![CDATA[
-$( "button:first" ).click(function() {
- $( "p:first" ).fadeToggle( "slow", "linear" );
-});
-$( "button:last" ).click(function() {
- $( "p:last" ).fadeToggle( "fast", function() {
+$( "button" ).first().on( "click", function() {
+ $( "p" ).first().fadeToggle( "slow", "linear" );
+} );
+$( "button" ).last().on( "click", function() {
+ $( "p" ).last().fadeToggle( "fast", function() {
$( "#log" ).append( "<div>finished</div>" );
- });
-});
+ } );
+} );
]]></code>
<html><![CDATA[
<button>fadeToggle p1</button>
diff --git a/entries/file-selector.xml b/entries/file-selector.xml
index db9c7b867..c5295eca0 100644
--- a/entries/file-selector.xml
+++ b/entries/file-selector.xml
@@ -13,16 +13,16 @@
<example>
<desc>Finds all file inputs.</desc>
<code><![CDATA[
-var input = $( "input:file" ).css({
+var input = $( "input:file" ).css( {
background: "yellow",
border: "3px red solid"
-});
+} );
$( "div" )
.text( "For this type jQuery found " + input.length + "." )
.css( "color", "red" );
-$( "form" ).submit(function( event ) {
+$( "form" ).on( "submit", function( event ) {
event.preventDefault();
-});
+} );
]]></code>
<css><![CDATA[
textarea {
diff --git a/entries/filter.xml b/entries/filter.xml
index 01489193e..ed92d385c 100644
--- a/entries/filter.xml
+++ b/entries/filter.xml
@@ -42,9 +42,9 @@
</code></pre>
<p>We can apply this method to the set of list items:</p>
<pre><code>
-$( "li" ).filter( ":even" ).css( "background-color", "red" );
+$( "li" ).filter( ":nth-child(2n)" ).css( "background-color", "red" );
</code></pre>
- <p>The result of this call is a red background for items 1, 3, and 5, as they match the selector (recall that <code>:even</code> and <code>:odd</code> use 0-based indexing).</p>
+ <p>The result of this call is a red background for items 2, 4, and 6, as they match the selector.</p>
<h4 id="using-filter-function">Using a Filter Function</h4>
<p>The second form of this method allows us to filter elements against a function rather than a selector. For each element, if the function returns <code>true</code> (or a "truthy" value), the element will be included in the filtered set; otherwise, it will be excluded. Suppose we have a somewhat more involved HTML snippet:</p>
<pre><code>
diff --git a/entries/find.xml b/entries/find.xml
index c6a32e84c..fc10241bd 100644
--- a/entries/find.xml
+++ b/entries/find.xml
@@ -18,7 +18,7 @@
<desc>Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.</desc>
<longdesc>
<p>Given a jQuery object that represents a set of DOM elements, the <code>.find()</code> method allows us to search through the descendants of these elements in the DOM tree and construct a new jQuery object from the matching elements. The <code>.find()</code> and <code>.children()</code> methods are similar, except that the latter only travels a single level down the DOM tree.</p>
- <p>The first signature for the <code>.find()</code>method accepts a selector expression of the same type that we can pass to the <code>$()</code> function. The elements will be filtered by testing whether they match this selector. The expressions allowed include selectors like <code>> p</code> which will find all the paragraphs that are children of the elements in the jQuery object.</p>
+ <p>The first signature for the <code>.find()</code>method accepts a selector expression of the same type that we can pass to the <code>$()</code> function. The elements will be filtered by testing whether they match this selector; all parts of the selector must lie inside of an element on which .find() is called. The expressions allowed include selectors like <code>> p</code> which will find all the paragraphs that are children of the elements in the jQuery object.</p>
<p>Consider a page with a basic nested list on it:</p>
<pre><code>
<ul class="level-1">
diff --git a/entries/first-child-selector.xml b/entries/first-child-selector.xml
index 4b30b503a..d91a50b8b 100644
--- a/entries/first-child-selector.xml
+++ b/entries/first-child-selector.xml
@@ -7,7 +7,7 @@
</signature>
<desc>Selects all elements that are the first child of their parent.</desc>
<longdesc>
- <p>While <a href="/https/github.com/first-selector/">:first</a> matches only a single element, the <code>:first-child</code> selector can match more than one: one for each parent. This is equivalent to <code>:nth-child(1)</code>.</p>
+ <p>While <a href="/https/github.com/first/">.first()</a> matches only a single element, the <code>:first-child</code> selector can match more than one: one for each parent. This is equivalent to <code>:nth-child(1)</code>.</p>
</longdesc>
<example>
<desc>Finds the first span in each matched div to underline and add a hover state.</desc>
diff --git a/entries/first-selector.xml b/entries/first-selector.xml
index 0676d85fc..1308ff5ec 100644
--- a/entries/first-selector.xml
+++ b/entries/first-selector.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="selector" name="first" return="">
+<entry type="selector" name="first" return="" deprecated="3.4">
<title>:first Selector</title>
<sample>:first</sample>
<signature>
@@ -7,6 +7,9 @@
</signature>
<desc>Selects the first matched DOM element.</desc>
<longdesc>
+ <div class="warning">
+ <p><strong>As of jQuery 3.4</strong>, the <code>:first</code> pseudo-class is deprecated. Remove it from your selectors and filter the results later using <a href="/https/github.com/first/"><code>.first()</code></a>.</p>
+ </div>
<p>The <code>:first</code> pseudo-class is equivalent to <code>:eq( 0 )</code>. It could also be written as <code>:lt( 1 )</code>. While this matches only a single element, <a href="/https/github.com/first-child-selector/">:first-child</a> can match more than one: One for each parent.</p>
</longdesc>
<note id="jquery-selector-extension" type="additional" data-selector=":first"/>
@@ -33,4 +36,5 @@ $( "tr:first" ).css( "font-style", "italic" );
<category slug="selectors/basic-filter-selectors"/>
<category slug="selectors/jquery-selector-extensions"/>
<category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.4"/>
</entry>
diff --git a/entries/first.xml b/entries/first.xml
index f73f8f10b..90ac489c7 100644
--- a/entries/first.xml
+++ b/entries/first.xml
@@ -24,21 +24,22 @@ $( "li" ).first().css( "background-color", "red" );
<p>The result of this call is a red background for the first item.</p>
</longdesc>
<example>
- <desc>Highlight the first span in a paragraph.</desc>
+ <desc>Highlight the first item in a list.</desc>
<css><![CDATA[
- .highlight{
- background-color: yellow
+ .highlight {
+ background-color: yellow;
}
]]></css>
<code><![CDATA[
-$( "p span" ).first().addClass( "highlight" );
+$( "ul li" ).first().addClass( "highlight" );
]]></code>
<html><![CDATA[
-<p>
- <span>Look:</span>
- <span>This is some text in a paragraph.</span>
- <span>This is a note about it.</span>
-</p>
+<ul>
+ <li>Look:</li>
+ <li>This is some text in a list.</li>
+ <li>This is a note about it.</li>
+ <li>This is another note about it.</li>
+</ul>
]]></html>
</example>
<category slug="traversing/filtering"/>
diff --git a/entries/focus-shorthand.xml b/entries/focus-shorthand.xml
new file mode 100644
index 000000000..a38f4c280
--- /dev/null
+++ b/entries/focus-shorthand.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<entry type="method" name="focus" return="jQuery" deprecated="3.3">
+ <title>.focus()</title>
+ <desc>Bind an event handler to the "focus" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.focus( handler )</code> or <code>.focus( eventData, handler )</code>, use <a href="/https/github.com/focus/#on1"><code>.on( "focus", handler )</code></a> or <a href="/https/github.com/focus/#on1"><code>.on( "focus", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.focus()</code>, use <a href="/https/github.com/focus/#trigger2"><code>.trigger( "focus" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="forms"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/focus.xml b/entries/focus.xml
index 1db6b6437..c9736a295 100644
--- a/entries/focus.xml
+++ b/entries/focus.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="focus" return="jQuery">
- <title>.focus()</title>
- <desc>Bind an event handler to the "focus" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+
+<desc>Bind an event handler to the "focus" event, or trigger that event on an element.</desc>
+<entry type="method" name="on" return="jQuery">
+ <title>focus event</title>
+ <desc>Bind an event handler to the "focus" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""focus"" type="string">
+ <desc>The string <code>"focus"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,17 +18,16 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
+ <div class="warning">
+ <p>This page describes the <code>focus</code> event. For the deprecated <code>.focus()</code> method, see <a href="/https/github.com/focus-shorthand/"><code>.focus()</code></a>.</p>
+ </div>
<ul>
- <li>This method is a shortcut for <code>.on( "focus", handler )</code> in the first and second variations, and <code>.trigger( "focus" )</code> in the third.</li>
<li>The <code>focus</code> event is sent to an element when it gains focus. This event is implicitly applicable to a limited set of elements, such as form elements (<code><input></code>, <code><select></code>, etc.) and links (<code><a href></code>). In recent browser versions, the event can be extended to include all element types by explicitly setting the element's <code>tabindex</code> property. An element can gain focus via keyboard commands, such as the Tab key, or by mouse clicks on the element.</li>
<li>Elements with focus are usually highlighted in some way by the browser, for example with a dotted line surrounding the element. The focus is used to determine which element is the first to receive keyboard-related events.</li>
</ul>
<div class="warning">
- <p>Attempting to set focus to a hidden element causes an error in Internet Explorer. Take care to only use <code>.focus()</code> on elements that are visible. To run an element's focus event handlers without setting focus to the element, use <code>.triggerHandler( "focus" )</code> instead of <code>.focus()</code>.</p>
+ <p>Attempting to set focus to a hidden element causes an error in Internet Explorer. Take care to only use <code>.trigger( "focus" )</code> on elements that are visible. To run an element's focus event handlers without setting focus to the element, use <code>.triggerHandler( "focus" )</code> instead of <code>.trigger( "focus" )</code>.</p>
</div>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -43,24 +41,24 @@
</code></pre>
<p>The event handler can be bound to the first input field:</p>
<pre><code>
-$( "#target" ).focus(function() {
- alert( "Handler for .focus() called." );
-});
+$( "#target" ).on( "focus", function() {
+ alert( "Handler for `focus` called." );
+} );
</code></pre>
<p>Now clicking on the first field, or tabbing to it from another field, displays the alert:</p>
<p>
- <samp>Handler for .focus() called.</samp>
+ <samp>Handler for `focus` called.</samp>
</p>
<p>We can trigger the event when another element is clicked:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#target" ).focus();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "focus" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also alert the message.</p>
- <p>The <code>focus</code> event does not bubble in Internet Explorer. Therefore, scripts that rely on event delegation with the <code>focus</code> event will not work consistently across browsers. As of version 1.4.2, however, jQuery works around this limitation by mapping <code>focus</code> to the <code>focusin</code> event in its event delegation methods, <a href="/https/github.com/live/"><code>.live()</code></a> and <a href="/https/github.com/delegate/"><code>.delegate()</code></a>.</p>
+ <p>The <code>focus</code> event does not bubble. As of version 1.4.2, jQuery works around this limitation by mapping <code>focus</code> to the <code>focusin</code> event in its event delegation methods.</p>
+ <p>The native <code>focus</code> event is asynchronous in all versions of IE, contrary to other browsers. To avoid issues related to this discrepancy, as of jQuery 3.7.0, jQuery uses <code>focusin</code> as the native backing event for <code>focus</code> in IE.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="focus"/>
<example>
<desc>Fire focus.</desc>
<css><![CDATA[
@@ -69,9 +67,9 @@ $( "#other" ).click(function() {
}
]]></css>
<code><![CDATA[
-$( "input" ).focus(function() {
+$( "input" ).on( "focus", function() {
$( this ).next( "span" ).css( "display", "inline" ).fadeOut( 1000 );
-});
+} );
]]></code>
<html><![CDATA[
<p><input type="text"> <span>focus fire</span></p>
@@ -81,21 +79,41 @@ $( "input" ).focus(function() {
<example>
<desc>To stop people from writing in text input boxes, try:</desc>
<code><![CDATA[
-$( "input[type=text]" ).focus(function() {
- $( this ).blur();
-});
+$( "input[type=text]" ).on( "focus", function() {
+ $( this ).trigger( "blur" );
+} );
]]></code>
</example>
<example>
<desc>To focus on a login input box with id 'login' on page startup, try:</desc>
<code><![CDATA[
-$( document ).ready(function() {
- $( "#login" ).focus();
-});
+$( function() {
+ $( "#login" ).trigger( "focus" );
+} );
]]></code>
</example>
<category slug="events/form-events"/>
<category slug="forms"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+ <category slug="version/3.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>focus event</title>
+ <desc>Trigger the "focus" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""focus"" type="string">
+ <desc>The string <code>"focus"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "focus", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="forms"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/focusin-shorthand.xml b/entries/focusin-shorthand.xml
new file mode 100644
index 000000000..ff8f548ed
--- /dev/null
+++ b/entries/focusin-shorthand.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<entry type="method" name="focusin" return="jQuery" deprecated="3.3">
+ <title>.focusin()</title>
+ <desc>Bind an event handler to the "focusin" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.focusin( handler )</code> or <code>.focusin( eventData, handler )</code>, use <a href="/https/github.com/focusin/#on1"><code>.on( "focusin", handler )</code></a> or <a href="/https/github.com/focusin/#on1"><code>.on( "focusin", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.focusin()</code>, use <a href="/https/github.com/focusin/#trigger2"><code>.trigger( "focusin" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="forms"/>
+ <category slug="version/1.4"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/focusin.xml b/entries/focusin.xml
index aaff429dc..7b5288f67 100644
--- a/entries/focusin.xml
+++ b/entries/focusin.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="focusin" return="jQuery">
- <title>.focusin()</title>
+<entries>
+
+<desc>Bind an event handler to the "focusin" event, or trigger that event on an element.</desc>
+<entry type="method" name="on" return="jQuery">
+ <title>focusin event</title>
<desc>Bind an event handler to the "focusin" event.</desc>
<signature>
- <added>1.4</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""focusin"" type="string">
+ <desc>The string <code>"focusin"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,15 +18,13 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "focusin", handler )</code> in the first two variations, and <code>.trigger( "focusin" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>focusin</code> event. For the deprecated <code>.focusin()</code> method, see <a href="/https/github.com/focusin-shorthand/"><code>.focusin()</code></a>.</p>
+ </div>
<p>The <code>focusin</code> event is sent to an element when it, or any element inside of it, gains focus. This is distinct from the <a href="/https/github.com/focus/">focus</a> event in that it supports detecting the focus event on parent elements (in other words, it supports event bubbling).</p>
<p>This event will likely be used together with the <a href="/https/github.com/focusout/">focusout</a> event.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="focusin"/>
<example>
<desc>Watch for a focus to occur within the paragraphs on the page.</desc>
<css><![CDATA[
@@ -36,9 +33,9 @@
}
]]></css>
<code><![CDATA[
-$( "p" ).focusin(function() {
+$( "p" ).on( "focusin", function() {
$( this ).find( "span" ).css( "display", "inline" ).fadeOut( 1000 );
-});
+} );
]]></code>
<html><![CDATA[
<p><input type="text"> <span>focusin fire</span></p>
@@ -47,6 +44,27 @@ $( "p" ).focusin(function() {
</example>
<category slug="events/form-events"/>
<category slug="forms"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>focusin event</title>
+ <desc>Trigger the "focusin" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""focusin"" type="string">
+ <desc>The string <code>"focusin"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "focusin", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="forms"/>
+ <category slug="version/1.0"/>
<category slug="version/1.4"/>
- <category slug="version/1.4.3"/>
</entry>
+
+</entries>
diff --git a/entries/focusout-shorthand.xml b/entries/focusout-shorthand.xml
new file mode 100644
index 000000000..6114a08be
--- /dev/null
+++ b/entries/focusout-shorthand.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<entry type="method" name="focusout" return="jQuery" deprecated="3.3">
+ <title>.focusout()</title>
+ <desc>Bind an event handler to the "focusout" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.focusout( handler )</code> or <code>.focusout( eventData, handler )</code>, use <a href="/https/github.com/focusout/#on1"><code>.on( "focusout", handler )</code></a> or <a href="/https/github.com/focusout/#on1"><code>.on( "focusout", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.focusout()</code>, use <a href="/https/github.com/focusout/#trigger2"><code>.trigger( "focusout" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="forms"/>
+ <category slug="version/1.4"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/focusout.xml b/entries/focusout.xml
index 6b633c897..7b90cb82d 100644
--- a/entries/focusout.xml
+++ b/entries/focusout.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="focusout" return="jQuery">
- <title>.focusout()</title>
- <desc>Bind an event handler to the "focusout" JavaScript event.</desc>
+<entries>
+
+<desc>Bind an event handler to the "focusout" event, or trigger that event on an element.</desc>
+<entry type="method" name="on" return="jQuery">
+ <title>focusout event</title>
+ <desc>Bind an event handler to the "focusout" event.</desc>
<signature>
- <added>1.4</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""focusout"" type="string">
+ <desc>The string <code>"focusout"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,15 +18,13 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "focusout", handler )</code> when passed arguments, and <code>.trigger( "focusout" )</code> when no arguments are passed.</p>
+ <div class="warning">
+ <p>This page describes the <code>focusout</code> event. For the deprecated <code>.focusout()</code> method, see <a href="/https/github.com/focusout-shorthand/"><code>.focusout()</code></a>.</p>
+ </div>
<p>The <code>focusout</code> event is sent to an element when it, or any element inside of it, loses focus. This is distinct from the <a href="/https/github.com/blur/">blur</a> event in that it supports detecting the loss of focus on descendant elements (in other words, it supports event bubbling).</p>
<p>This event will likely be used together with the <a href="/https/github.com/focusin/">focusin</a> event.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="focusout"/>
<example>
<desc>Watch for a loss of focus to occur inside paragraphs and note the difference between the <code>focusout</code> count and the <code>blur</code> count. (The <code>blur</code> count does not change because those events do not bubble.)</desc>
<css><![CDATA[
@@ -40,17 +37,17 @@
}
]]></css>
<code><![CDATA[
-var focus = 0,
+var focusout = 0,
blur = 0;
$( "p" )
- .focusout(function() {
- focus++;
- $( "#focus-count" ).text( "focusout fired: " + focus + "x" );
- })
- .blur(function() {
+ .on( "focusout", function() {
+ focusout++;
+ $( "#focus-count" ).text( "focusout fired: " + focusout + "x" );
+ } )
+ .on( "blur", function() {
blur++;
$( "#blur-count" ).text( "blur fired: " + blur + "x" );
- });
+ } );
]]></code>
<html><![CDATA[
<div class="inputs">
@@ -68,6 +65,27 @@ $( "p" )
</example>
<category slug="events/form-events"/>
<category slug="forms"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>focusout event</title>
+ <desc>Trigger the "focuout" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""focusout"" type="string">
+ <desc>The string <code>"focusout"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "focusout", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="forms"/>
+ <category slug="version/1.0"/>
<category slug="version/1.4"/>
- <category slug="version/1.4.3"/>
</entry>
+
+</entries>
diff --git a/entries/get.xml b/entries/get.xml
index 64272cf47..cb52eb2d0 100644
--- a/entries/get.xml
+++ b/entries/get.xml
@@ -43,10 +43,10 @@ console.log( $( "li" ).get( -1 ) );
<example>
<desc>Display the tag name of the click element.</desc>
<code><![CDATA[
-$( "*", document.body ).click(function( event ) {
+$( "*", document.body ).on( "click", function( event ) {
event.stopPropagation();
var domElement = $( this ).get( 0 );
- $( "span:first" ).text( "Clicked on - " + domElement.nodeName );
+ $( "span" ).first().text( "Clicked on - " + domElement.nodeName );
});
]]></code>
<css><![CDATA[
diff --git a/entries/gt-selector.xml b/entries/gt-selector.xml
index 303723a9d..1aad2e3d7 100644
--- a/entries/gt-selector.xml
+++ b/entries/gt-selector.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="selector" name="gt" return="">
+<entry type="selector" name="gt" return="" deprecated="3.4">
<title>:gt() Selector</title>
<signature>
<sample>:gt(index)</sample>
@@ -17,6 +17,9 @@
</signature>
<desc>Select all elements at an index greater than <code>index</code> within the matched set.</desc>
<longdesc>
+ <div class="warning">
+ <p><strong>As of jQuery 3.4</strong>, the <code>:gt</code> pseudo-class is deprecated. Remove it from your selectors and filter the results later using <a href="/https/github.com/slice/"><code>.slice()</code></a>. For example, <code>:gt(3)</code> can be replaced with a call to <code>.slice( 4 )</code> (the provided index needs to be increased by one).</p>
+ </div>
<p>
<strong>index-related selectors</strong>
</p>
@@ -42,4 +45,5 @@ $( "td:gt(-2)" ).css( "color", "red" );
<category slug="selectors/basic-filter-selectors"/>
<category slug="selectors/jquery-selector-extensions"/>
<category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.4"/>
</entry>
diff --git a/entries/hasClass.xml b/entries/hasClass.xml
index ddf5d893a..622570e93 100644
--- a/entries/hasClass.xml
+++ b/entries/hasClass.xml
@@ -30,8 +30,8 @@ $( "#mydiv" ).hasClass( "quux" )
<example>
<desc>Looks for the paragraph that contains 'selected' as a class.</desc>
<code><![CDATA[
-$( "#result1" ).append( $( "p:first" ).hasClass( "selected" ).toString() );
-$( "#result2" ).append( $( "p:last" ).hasClass( "selected" ).toString() );
+$( "#result1" ).append( $( "p" ).first().hasClass( "selected" ).toString() );
+$( "#result2" ).append( $( "p" ).last().hasClass( "selected" ).toString() );
$( "#result3" ).append( $( "p" ).hasClass( "selected" ).toString() ) ;
]]></code>
<css><![CDATA[
diff --git a/entries/height.xml b/entries/height.xml
index 2bbe55a04..3a57f6039 100644
--- a/entries/height.xml
+++ b/entries/height.xml
@@ -34,13 +34,13 @@ $( document ).height();
function showHeight( element, height ) {
$( "div" ).text( "The height for the " + element + " is " + height + "px." );
}
-$( "#getp" ).click(function() {
+$( "#getp" ).on( "click", function() {
showHeight( "paragraph", $( "p" ).height() );
});
-$( "#getd" ).click(function() {
+$( "#getd" ).on( "click", function() {
showHeight( "document", $( document ).height() );
});
-$( "#getw" ).click(function() {
+$( "#getw" ).on( "click", function() {
showHeight( "window", $( window ).height() );
});
]]></code>
diff --git a/entries/hidden-selector.xml b/entries/hidden-selector.xml
index e44d732bd..44b8397c6 100644
--- a/entries/hidden-selector.xml
+++ b/entries/hidden-selector.xml
@@ -29,9 +29,9 @@
// In some browsers :hidden includes head, title, script, etc...
var hiddenElements = $( "body" ).find( ":hidden" ).not( "script" );
-$( "span:first" ).text( "Found " + hiddenElements.length + " hidden elements total." );
+$( "span" ).first().text( "Found " + hiddenElements.length + " hidden elements total." );
$( "div:hidden" ).show( 3000 );
-$( "span:last" ).text( "Found " + $( "input:hidden" ).length + " hidden inputs." );
+$( "span" ).last().text( "Found " + $( "input:hidden" ).length + " hidden inputs." );
]]></code>
<css><![CDATA[
div {
diff --git a/entries/hide.xml b/entries/hide.xml
index b90aed059..01f88a155 100644
--- a/entries/hide.xml
+++ b/entries/hide.xml
@@ -49,7 +49,7 @@ $( ".target" ).hide();
</code></pre>
<pre><code>
// With the element initially shown, we can hide it slowly:
-$( "#clickme" ).click(function() {
+$( "#clickme" ).on( "click", function() {
$( "#book" ).hide( "slow", function() {
alert( "Animation complete." );
});
@@ -68,7 +68,7 @@ $( "#clickme" ).click(function() {
<desc>Hides all paragraphs then the link on click.</desc>
<code><![CDATA[
$( "p" ).hide();
-$( "a" ).click(function( event ) {
+$( "a" ).on( "click", function( event ) {
event.preventDefault();
$( this ).hide();
});
@@ -82,7 +82,7 @@ $( "a" ).click(function( event ) {
<example>
<desc>Animates all shown paragraphs to hide slowly, completing the animation within 600 milliseconds.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "p" ).hide( "slow" );
});
]]></code>
@@ -101,13 +101,13 @@ $( "button" ).click(function() {
<example>
<desc>Animates all spans (words in this case) to hide fastly, completing each animation within 200 milliseconds. Once each animation is done, it starts the next one.</desc>
<code><![CDATA[
-$( "#hider" ).click(function() {
+$( "#hider" ).on( "click", function() {
$( "span:last-child" ).hide( "fast", function() {
// Use arguments.callee so we don't need a named function
$( this ).prev().hide( "fast", arguments.callee );
});
});
-$( "#shower" ).click(function() {
+$( "#shower" ).on( "click", function() {
$( "span" ).show( 2000 );
});
]]></code>
@@ -134,7 +134,7 @@ $( "#shower" ).click(function() {
for ( var i = 0; i < 5; i++ ) {
$( "<div>" ).appendTo( document.body );
}
-$( "div" ).click(function() {
+$( "div" ).on( "click", function() {
$( this ).hide( 2000, function() {
$( this ).remove();
});
diff --git a/entries/hover.xml b/entries/hover.xml
index 3eb38753b..a924d368f 100644
--- a/entries/hover.xml
+++ b/entries/hover.xml
@@ -1,7 +1,7 @@
<?xml version="1.0"?>
<entries>
<desc>Bind one or two handlers to the matched elements, to be executed when the mouse pointer enters and leaves the elements.</desc>
- <entry type="method" name="hover" return="jQuery">
+ <entry type="method" name="hover" return="jQuery" deprecated="3.3">
<title>.hover()</title>
<desc>Bind two handlers to the matched elements, to be executed when the mouse pointer enters and leaves the elements.</desc>
<signature>
@@ -16,12 +16,15 @@
</argument>
</signature>
<longdesc>
+ <div class="warning">
+ <p>This API is deprecated. Use <code>.on( "mouseenter", handlerIn ).on( "mouseleave", handlerOut )</code> instead.</p>
+ </div>
<p>The <code>.hover()</code> method binds handlers for both <code>mouseenter</code> and <code>mouseleave</code> events. You can use it to simply apply behavior to an element during the time the mouse is within the element.</p>
<p>Calling <code>$( selector ).hover( handlerIn, handlerOut )</code> is shorthand for:</p>
<pre><code>
-$( selector ).mouseenter( handlerIn ).mouseleave( handlerOut );
+$( selector ).on( "mouseenter", handlerIn ).on( "mouseleave", handlerOut );
</code></pre>
- <p>See the discussions for <code><a href="/https/github.com/mouseenter/">.mouseenter()</a></code> and <code><a href="/https/github.com/mouseleave/">.mouseleave()</a></code> for more details.</p>
+ <p>See the discussions for <code><a href="/https/github.com/mouseenter/">mouseenter</a></code> and <code><a href="/https/github.com/mouseleave/">mouseleave</a></code> for more details.</p>
</longdesc>
<example>
<desc>To add a special style to list items that are being hovered over, try:</desc>
@@ -30,7 +33,7 @@ $( "li" ).hover(
function() {
$( this ).append( $( "<span> ***</span>" ) );
}, function() {
- $( this ).find( "span:last" ).remove();
+ $( this ).find( "span" ).last().remove();
}
);
@@ -80,8 +83,10 @@ $( "td" ).off( "mouseenter mouseleave" );
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.3"/>
</entry>
- <entry type="method" name="hover" return="jQuery">
+
+ <entry type="method" name="hover" return="jQuery" deprecated="3.3">
<desc>Bind a single handler to the matched elements, to be executed when the mouse pointer enters or leaves the elements.</desc>
<signature>
<added>1.4</added>
@@ -91,21 +96,24 @@ $( "td" ).off( "mouseenter mouseleave" );
</argument>
</signature>
<longdesc>
+ <div class="warning">
+ <p>This API is deprecated. Use <code>.on( "mouseenter mouseleave", handlerInOut )</code> instead.</p>
+ </div>
<p>The <code>.hover()</code> method, when passed a single function, will execute that handler for both <code>mouseenter</code> and <code>mouseleave</code> events. This allows the user to use jQuery's various toggle methods within the handler or to respond differently within the handler depending on the <code>event.type</code>.</p>
<p>Calling <code>$(selector).hover(handlerInOut)</code> is shorthand for:</p>
<pre><code>
$( selector ).on( "mouseenter mouseleave", handlerInOut );
</code></pre>
- <p>See the discussions for <code><a href="/https/github.com/mouseenter/">.mouseenter()</a></code> and <code><a href="/https/github.com/mouseleave/">.mouseleave()</a></code> for more details.</p>
+ <p>See the discussions for <code><a href="/https/github.com/mouseenter/">mouseenter</a></code> and <code><a href="/https/github.com/mouseleave/">mouseleave</a></code> for more details.</p>
</longdesc>
<example>
<desc>Slide the next sibling LI up or down on hover, and toggle a class.</desc>
<code><![CDATA[
$( "li" )
- .filter( ":odd" )
+ .odd()
.hide()
.end()
- .filter( ":even" )
+ .even()
.hover(function() {
$( this )
.toggleClass( "active" )
@@ -143,5 +151,6 @@ $( "li" )
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.3"/>
</entry>
</entries>
diff --git a/entries/html.xml b/entries/html.xml
index b830c566b..1a29d361a 100644
--- a/entries/html.xml
+++ b/entries/html.xml
@@ -29,7 +29,7 @@ $( "div.demo-container" ).html();
<example>
<desc>Click a paragraph to convert it from html to text.</desc>
<code><![CDATA[
-$( "p" ).click(function() {
+$( "p" ).on( "click", function() {
var htmlString = $( this ).html();
$( this ).text( htmlString );
});
@@ -118,7 +118,7 @@ $( "div.demo-container" ).html(function() {
});
</code></pre>
<p>Given a document with six paragraphs, this example will set the HTML of <code><div class="demo-container"></code> to <code><p>All new content for <em>6 paragraphs!</em></p></code>.</p>
- <p>This method uses the browser's <code>innerHTML</code> property. Some browsers may not generate a DOM that exactly replicates the HTML source provided. For example, Internet Explorer prior to version 8 will convert all <code>href</code> properties on links to absolute URLs, and Internet Explorer prior to version 9 will not correctly handle HTML5 elements without the addition of a separate <a href="https://code.google.com/p/html5shiv/">compatibility layer</a>.</p>
+ <p>This method uses the browser's <code>innerHTML</code> property. Some browsers may not generate a DOM that exactly replicates the HTML source provided. For example, Internet Explorer prior to version 8 will convert all <code>href</code> properties on links to absolute URLs, and Internet Explorer prior to version 9 will not correctly handle HTML5 elements without the addition of a separate <a href="https://github.com/afarkas/html5shiv">compatibility layer</a>.</p>
<p>To set the content of a <code><script></code> element, which does not contain HTML, use the <a href="/https/github.com/text/"><code>.text()</code></a> method and not <code>.html()</code>.</p>
<p><strong>Note:</strong> In Internet Explorer up to and including version 9, setting the text content of an HTML element may corrupt the text nodes of its children that are being removed from the document as a result of the operation. If you are keeping references to these DOM elements and need them to be unchanged, use <code>.empty().html( string )</code> instead of <code>.html(string)</code> so that the elements are removed from the document before the new string is assigned to the element.</p>
</longdesc>
diff --git a/entries/image-selector.xml b/entries/image-selector.xml
index 8af0a3515..2b569d3a8 100644
--- a/entries/image-selector.xml
+++ b/entries/image-selector.xml
@@ -13,16 +13,16 @@
<example>
<desc>Finds all image inputs.</desc>
<code><![CDATA[
-var input = $( "input:image" ).css({
+var input = $( "input:image" ).css( {
background:"yellow",
border:"3px red solid"
-});
+} );
$( "div" )
.text( "For this type jQuery found " + input.length + "." )
.css( "color", "red" );
-$( "form" ).submit(function( event ) {
+$( "form" ).on( "submit", function( event ) {
event.preventDefault();
-});
+} );
]]></code>
<css><![CDATA[
textarea {
diff --git a/entries/index.xml b/entries/index.xml
index efcde43cf..1db070aa0 100644
--- a/entries/index.xml
+++ b/entries/index.xml
@@ -53,7 +53,7 @@ alert( "Index: " + $( "li" ).index( listItem ) );
</p>
<p>Note that if the jQuery collection used as the <code>.index()</code> method's argument contains more than one element, the first element within the matched set of elements will be used.</p>
<pre><code>
-var listItems = $( "li:gt(0)" );
+var listItems = $( "li" ).slice( 1 );
alert( "Index: " + $( "li" ).index( listItems ) );
</code></pre>
<p>We get back the zero-based position of the first list item within the matched set:</p>
@@ -81,7 +81,7 @@ alert( "Index: " + $( "#bar" ).index() );
<example>
<desc>On click, returns the index (zero-based) of that div in the page.</desc>
<code><![CDATA[
-$( "div" ).click(function() {
+$( "div" ).on( "click", function() {
// `this` is the DOM element that was clicked
var index = $( "div" ).index( this );
$( "span" ).text( "That was div index #" + index );
@@ -133,7 +133,7 @@ $( "div" ).html( "Index: " + $( "li" ).index( listItem ) );
}
]]></css>
<code><![CDATA[
-var listItems = $( "li:gt(0)" );
+var listItems = $( "li" ).slice( 1 );
$( "div" ).html( "Index: " + $( "li" ).index( listItems ) );
]]></code>
<html><![CDATA[
diff --git a/entries/innerHeight.xml b/entries/innerHeight.xml
index bdc22f236..2f71ae9f9 100644
--- a/entries/innerHeight.xml
+++ b/entries/innerHeight.xml
@@ -16,13 +16,13 @@
<figcaption>Figure 1 - Illustration of the measured height</figcaption>
</figure>
</longdesc>
- <note id="dimensions-number" type="additional" data-title=".innerHeight()"/>
+ <note id="dimensions-number" type="additional" data-title=".innerHeight()"/>
<note id="hidden-element-dimensions" type="additional" data-title=".innerHeight()"/>
<example>
<desc>Get the innerHeight of a paragraph.</desc>
<code><![CDATA[
-var p = $( "p:first" );
-$( "p:last" ).text( "innerHeight:" + p.innerHeight() );
+var p = $( "p" ).first();
+$( "p" ).last().text( "innerHeight:" + p.innerHeight() );
]]></code>
<css><![CDATA[
p {
@@ -44,7 +44,7 @@ $( "p:last" ).text( "innerHeight:" + p.innerHeight() );
<entry type="method" name="innerHeight" return="jQuery">
<signature>
- <added>1.8.0</added>
+ <added>1.8</added>
<argument name="value">
<type name="String"/>
<type name="Number"/>
@@ -52,7 +52,7 @@ $( "p:last" ).text( "innerHeight:" + p.innerHeight() );
</argument>
</signature>
<signature>
- <added>1.8.0</added>
+ <added>1.8</added>
<argument name="function" type="Function">
<argument name="index" type="Integer" />
<argument name="height" type="Number" />
diff --git a/entries/innerWidth.xml b/entries/innerWidth.xml
index d3641b007..54b6b3588 100644
--- a/entries/innerWidth.xml
+++ b/entries/innerWidth.xml
@@ -15,13 +15,13 @@
<figcaption>Figure 1 - Illustration of the measured width</figcaption>
</figure>
</longdesc>
- <note id="dimensions-number" type="additional" data-title=".innerWidth()"/>
+ <note id="dimensions-number" type="additional" data-title=".innerWidth()"/>
<note id="hidden-element-dimensions" type="additional" data-title=".innerWidth()"/>
<example>
<desc>Get the innerWidth of a paragraph.</desc>
<code><![CDATA[
-var p = $( "p:first" );
-$( "p:last" ).text( "innerWidth:" + p.innerWidth() );
+var p = $( "p" ).first();
+$( "p" ).last().text( "innerWidth:" + p.innerWidth() );
]]></code>
<css><![CDATA[
p {
@@ -43,15 +43,15 @@ $( "p:last" ).text( "innerWidth:" + p.innerWidth() );
<entry type="method" name="innerWidth" return="jQuery">
<signature>
- <added>1.8.0</added>
+ <added>1.8</added>
<argument name="value">
- <type name="String"/>
- <type name="Number"/>
- <desc>A number representing the number of pixels, or a number along with an optional unit of measure appended (as a string).</desc>
+ <type name="String"/>
+ <type name="Number"/>
+ <desc>A number representing the number of pixels, or a number along with an optional unit of measure appended (as a string).</desc>
</argument>
</signature>
<signature>
- <added>1.8.0</added>
+ <added>1.8</added>
<argument name="function" type="Function">
<argument name="index" type="Integer" />
<argument name="width" type="Number" />
diff --git a/entries/input-selector.xml b/entries/input-selector.xml
index 7f5d8fd9a..ec5c6c23d 100644
--- a/entries/input-selector.xml
+++ b/entries/input-selector.xml
@@ -18,9 +18,9 @@ var formChildren = $( "form > *" );
$( "#messages" ).text( "Found " + allInputs.length + " inputs and the form has " +
formChildren.length + " children." );
-$( "form" ).submit(function( event ) {
+$( "form" ).on( "submit", function( event ) {
event.preventDefault();
-});
+} );
]]></code>
<css><![CDATA[
textarea {
diff --git a/entries/insertAfter.xml b/entries/insertAfter.xml
index 9065d3059..8c406cfa0 100644
--- a/entries/insertAfter.xml
+++ b/entries/insertAfter.xml
@@ -14,7 +14,7 @@
</signature>
<desc>Insert every element in the set of matched elements after the target.</desc>
<longdesc>
- <p>The <code><a href="/https/github.com/after/">.after()</a></code> and <code>.insertAfter()</code> methods perform the same task. The major difference is in the syntax-specifically, in the placement of the content and target. With <code>.after()</code>, the selector expression preceding the method is the container after which the content is inserted. With <code>.insertAfter()</code>, on the other hand, the content precedes the method, either as a selector expression or as markup created on the fly, and it is inserted after the target container.</p>
+ <p>The <code><a href="/https/github.com/after/">.after()</a></code> and <code>.insertAfter()</code> methods perform the same task. The major difference is in the syntax—specifically, in the placement of the content and target. With <code>.after()</code>, the selector expression preceding the method is the container after which the content is inserted. With <code>.insertAfter()</code>, on the other hand, the content precedes the method, either as a selector expression or as markup created on the fly, and it is inserted after the target container.</p>
<p>Consider the following HTML:</p>
<pre><code>
<div class="container">
diff --git a/entries/is.xml b/entries/is.xml
index 5595d26ac..e6eb2ce55 100644
--- a/entries/is.xml
+++ b/entries/is.xml
@@ -13,7 +13,7 @@
<desc>A function used as a test for every element in the set. It accepts two arguments, <code>index</code>, which is the element's index in the jQuery collection, and <code>element</code>, which is the DOM element. Within the function, <code>this</code> refers to the current DOM element.</desc>
<argument name="index" type="Integer" />
<argument name="element" type="Element" />
- <return type="Boolean" />
+ <return type="Boolean" />
</argument>
</signature>
<signature>
@@ -41,7 +41,7 @@
</code></pre>
<p>You can attach a click handler to the <ul> element, and then limit the code to be triggered only when a list item itself, not one of its children, is clicked:</p>
<pre><code>
-$( "ul" ).click(function( event ) {
+$( "ul" ).on( "click", function( event ) {
var target = $( event.target );
if ( target.is( "li" ) ) {
target.css( "background-color", "red" );
@@ -49,8 +49,6 @@ $( "ul" ).click(function( event ) {
});
</code></pre>
<p>Now, when the user clicks on the word "list" in the first item or anywhere in the third item, the clicked list item will be given a red background. However, when the user clicks on item 1 in the first item or anywhere in the second item, nothing will occur, because in those cases the target of the event would be <code><strong></code> or <code><span></code>, respectively.</p>
- <p>Prior to jQuery 1.7, in selector strings with positional selectors such as <code>:first</code>, <code>:gt()</code>, or <code>:even</code>, the positional filtering is done against the jQuery object passed to <code>.is()</code>, <em>not</em> against the containing document. So for the HTML shown above, an expression such as <code>$( "li:first" ).is( "li:last" )</code> returns <code>true</code>, but <code>$( "li:first-child" ).is( "li:last-child" )</code> returns <code>false</code>. In addition, a bug in Sizzle prevented many positional selectors from working properly. These two factors made positional selectors almost unusable in filters.</p>
- <p>Starting with jQuery 1.7, selector strings with positional selectors apply the selector against the document, and then determine whether the first element of the current jQuery set matches any of the resulting elements. So for the HTML shown above, an expression such as <code>$( "li:first" ).is( "li:last" )</code> returns <code>false</code>. Note that since positional selectors are jQuery additions and not W3C standard, we recommend using the W3C selectors whenever feasible.</p>
<h4>Using a Function</h4>
<p>The second form of this method evaluates expressions related to elements based on a function rather than a selector. For each element, if the function returns <code>true</code>, <code>.is()</code> returns <code>true</code> as well. For example, given a somewhat more involved HTML snippet:</p>
<pre><code>
@@ -65,7 +63,7 @@ $( "ul" ).click(function( event ) {
</code></pre>
<p>You can attach a click handler to every <code><li></code> that evaluates the number of <code><strong></code> elements within the clicked <code><li></code> at that time like so:</p>
<pre><code>
-$( "li" ).click(function() {
+$( "li" ).on( "click", function() {
var li = $( this ),
isWithTwo = li.is(function() {
return $( "strong", this ).length === 2;
@@ -179,7 +177,7 @@ $( "div" ).text( "isFormParent = " + isFormParent );
<desc>Checks against an existing collection of alternating list elements. Blue, alternating list elements slide up while others turn red.</desc>
<code><![CDATA[
var alt = $( "#browsers li:nth-child(2n)" ).css( "background", "#0ff" );
-$( "li" ).click(function() {
+$( "li" ).on( "click", function() {
var li = $( this );
if ( li.is( alt ) ) {
li.slideUp();
@@ -206,7 +204,7 @@ $( "li" ).click(function() {
<desc>An alternate way to achieve the above example using an element rather than a jQuery object. Checks against an existing collection of alternating list elements. Blue, alternating list elements slide up while others turn red.</desc>
<code><![CDATA[
var alt = $( "#browsers li:nth-child(2n)" ).css( "background", "#0ff" );
-$( "li" ).click(function() {
+$( "li" ).on( "click", function() {
if ( alt.is( this ) ) {
$( this ).slideUp();
} else {
diff --git a/entries/jQuery.ajax.xml b/entries/jQuery.ajax.xml
index 80157d286..9074388b9 100644
--- a/entries/jQuery.ajax.xml
+++ b/entries/jQuery.ajax.xml
@@ -84,7 +84,12 @@ $.ajax({
<type name="PlainObject"/>
<type name="String"/>
<type name="Array"/>
- <desc>Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests. See <code>processData</code> option to prevent this automatic processing. Object must be Key/Value pairs. If value is an Array, jQuery serializes multiple values with same key based on the value of the <code>traditional</code> setting (described below).</desc>
+ <desc>
+ <p>Data to be sent to the server. If the HTTP method is one that cannot have an entity body, such as GET, the <code>data</code> is appended to the URL.</p>
+ <p>When <code>data</code> is an object, jQuery generates the data string from the object's key/value pairs unless the <code>processData</code> option is set to <code>false</code>. For example, <code>{ a: "bc", d: "e,f" }</code> is converted to the string <code>"a=bc&d=e%2Cf"</code>. If the value is an array, jQuery serializes multiple values with same key based on the value of the <code>traditional</code> setting (described below). For example, <code>{ a: [1,2] }</code> becomes the string <code>"a%5B%5D=1&a%5B%5D=2"</code> with the default <code>traditional: false</code> setting.</p>
+ <p>When <code>data</code> is passed as a string it should <strong>already be encoded</strong> using the correct encoding for <code>contentType</code>, which by default is <code>application/x-www-form-urlencoded</code>.</p>
+ <p>In requests with <code>dataType: "json"</code> or <code>dataType: "jsonp"</code>, if the string contains a double question mark (<code>??</code>) anywhere in the URL or a single question mark (<code>?</code>) in the query string, it is replaced with a value generated by jQuery that is unique for each copy of the library on the page (e.g. <code>jQuery21406515378922229067_1479880736745</code>).</p>
+ </desc>
</property>
<property name="dataFilter" type="Function">
<argument name="data" type="String"/>
@@ -97,7 +102,7 @@ $.ajax({
<ul>
<li><code>"xml"</code>: Returns a XML document that can be processed via jQuery.</li>
<li><code>"html"</code>: Returns HTML as plain text; included script tags are evaluated when inserted in the DOM.</li>
- <li><code>"script"</code>: Evaluates the response as JavaScript and returns it as plain text. Disables caching by appending a query string parameter, <code>_=[TIMESTAMP]</code>, to the URL unless the <code>cache</code> option is set to <code>true</code>. <strong>Note:</strong> This will turn POSTs into GETs for remote-domain requests.</li>
+ <li><code>"script"</code>: Evaluates the response as JavaScript and returns it as plain text. Disables caching by appending a query string parameter, <code>_=[TIMESTAMP]</code>, to the URL unless the <code>cache</code> option is set to <code>true</code>. <strong>Note:</strong> This will turn POSTs into GETs for remote-domain requests. Prior to jQuery 3.5.0, unsuccessful HTTP responses with a script <code>Content-Type</code> were still executed.</li>
<li><code>"json"</code>: Evaluates the response as JSON and returns a JavaScript object. Cross-domain <code>"json"</code> requests that have a callback placeholder, e.g. <code>?callback=?</code>, are performed using <a href="https://bob.ippoli.to/archives/2005/12/05/remote-json-jsonp/">JSONP</a> unless the request includes <code>jsonp: false</code> in its request options. The JSON data is parsed in a strict manner; any malformed JSON is rejected and a parse error is thrown. As of jQuery 1.9, an empty response is also rejected; the server should return a response of <code>null</code> or <code>{}</code> instead. (See <a href="https://json.org/">json.org</a> for more information on proper JSON formatting.)</li>
<li><code>"jsonp"</code>: Loads in a JSON block using <a href="https://bob.ippoli.to/archives/2005/12/05/remote-json-jsonp/">JSONP</a>. Adds an extra <code>"?callback=?"</code> to the end of your URL to specify the callback. Disables caching by appending a query string parameter, <code>"_=[TIMESTAMP]"</code>, to the URL unless the <code>cache</code> option is set to <code>true</code>.</li>
<li><code>"text"</code>: A plain text string.</li>
@@ -109,7 +114,7 @@ $.ajax({
<argument name="jqXHR" type="jqXHR"/>
<argument name="textStatus" type="String"/>
<argument name="errorThrown" type="String"/>
- <desc>A function to be called if the request fails. The function receives three arguments: The jqXHR (in jQuery 1.4.x, XMLHttpRequest) object, a string describing the type of error that occurred and an optional exception object, if one occurred. Possible values for the second argument (besides <code>null</code>) are <code>"timeout"</code>, <code>"error"</code>, <code>"abort"</code>, and <code>"parsererror"</code>. When an HTTP error occurs, <code>errorThrown</code> receives the textual portion of the HTTP status, such as "Not Found" or "Internal Server Error." <strong>As of jQuery 1.5</strong>, the <code>error</code> setting can accept an array of functions. Each function will be called in turn. <strong>Note:</strong> <em>This handler is not called for cross-domain script and cross-domain JSONP requests.</em> This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
+ <desc>A function to be called if the request fails. The function receives three arguments: The jqXHR (in jQuery 1.4.x, XMLHttpRequest) object, a string describing the type of error that occurred and an optional exception object, if one occurred. Possible values for the second argument (besides <code>null</code>) are <code>"timeout"</code>, <code>"error"</code>, <code>"abort"</code>, and <code>"parsererror"</code>. When an HTTP error occurs, <code>errorThrown</code> receives the textual portion of the HTTP status, such as "Not Found" or "Internal Server Error." (in HTTP/2 it may instead be an empty string) <strong>As of jQuery 1.5</strong>, the <code>error</code> setting can accept an array of functions. Each function will be called in turn. <strong>Note:</strong> <em>This handler is not called for cross-domain scripts and cross-domain JSONP requests.</em> This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
</property>
<property default="true" name="global" type="Boolean">
<desc>Whether to trigger global Ajax event handlers for this request. The default is <code>true</code>. Set to <code>false</code> to prevent the global handlers like <code>ajaxStart</code> or <code>ajaxStop</code> from being triggered. This can be used to control various <a href="/Ajax_Events/">Ajax Events</a>.</desc>
@@ -133,7 +138,7 @@ $.ajax({
<type name="Function"/>
<desc>Specify the callback function name for a JSONP request. This value will be used instead of the random name automatically generated by jQuery. It is preferable to let jQuery generate a unique name as it'll make it easier to manage the requests and provide callbacks and error handling. You may want to specify the callback when you want to enable better browser caching of GET requests. <strong>As of jQuery 1.5</strong>, you can also use a function for this setting, in which case the value of <code>jsonpCallback</code> is set to the return value of that function.</desc>
</property>
- <property default="'GET'" name="method" type="String" added="1.9.0">
+ <property default="'GET'" name="method" type="String" added="1.9">
<desc>The HTTP method to use for the request (e.g. <code>"POST"</code>, <code>"GET"</code>, <code>"PUT"</code>).</desc>
</property>
<property name="mimeType" type="String" added="1.5.1">
@@ -145,8 +150,11 @@ $.ajax({
<property default="true" name="processData" type="Boolean">
<desc>By default, data passed in to the <code>data</code> option as an object (technically, anything other than a string) will be processed and transformed into a query string, fitting to the default content-type "application/x-www-form-urlencoded". If you want to send a DOMDocument, or other non-processed data, set this option to <code>false</code>.</desc>
</property>
+ <property name="scriptAttrs" type="PlainObject" added="3.4">
+ <desc>Defines an object with additional attributes to be used in a "script" or "jsonp" request. The key represents the name of the attribute and the value is the attribute's value. If this object is provided it will force the use of a script-tag transport. For example, this can be used to set <code>nonce</code>, <code>integrity</code>, or <code>crossorigin</code> attributes to satisfy Content Security Policy requirements.</desc>
+ </property>
<property name="scriptCharset" type="String">
- <desc>Only applies when the "script" transport is used (e.g., cross-domain requests with "jsonp" or "script" dataType and "GET" type). Sets the <code>charset</code> attribute on the script tag used in the request. Used when the character set on the local page is not the same as the one on the remote script.</desc>
+ <desc>Only applies when the "script" transport is used. Sets the <code>charset</code> attribute on the script tag used in the request. Used when the character set on the local page is not the same as the one on the remote script. Alternatively, the <code>charset</code> attribute can be specified in <code>scriptAttrs</code> instead, which will also ensure the use of the "script" transport.</desc>
</property>
<property name="statusCode" type="PlainObject" default="{}" added="1.5">
<desc>
@@ -287,7 +295,7 @@ jqxhr.always(function() {
<code>status</code>
</li>
<li>
- <code>statusText</code>
+ <code>statusText</code> (may be an empty string in HTTP/2)
</li>
<li>
<code>abort( [ statusText ] )</code>
@@ -335,7 +343,7 @@ jqxhr.always(function() {
<p>By default, Ajax requests are sent using the GET HTTP method. If the POST method is required, the method can be specified by setting a value for the <code>type</code> option. This option affects how the contents of the <code>data</code> option are sent to the server. POST data will always be transmitted to the server using UTF-8 charset, per the W3C XMLHTTPRequest standard.</p>
<p>The <code>data</code> option can contain either a query string of the form <code>key1=value1&key2=value2</code>, or an object of the form <code>{key1: 'value1', key2: 'value2'}</code>. If the latter form is used, the data is converted into a query string using <code><a href="/https/github.com/jQuery.param/">jQuery.param()</a></code> before it is sent. This processing can be circumvented by setting <code>processData</code> to <code>false</code>. The processing might be undesirable if you wish to send an XML object to the server; in this case, change the <code>contentType</code> option from <code>application/x-www-form-urlencoded</code> to a more appropriate MIME type.</p>
<h4 id="advanced-options">Advanced Options</h4>
- <p>The <code>global</code> option prevents handlers registered using <code><a href="/https/github.com/ajaxSend/">.ajaxSend()</a></code>, <code><a href="/https/github.com/ajaxError/">.ajaxError()</a></code>, and similar methods from firing when this request would trigger them. This can be useful to, for example, suppress a loading indicator that was implemented with <code><a href="/https/github.com/ajaxSend/">.ajaxSend()</a></code> if the requests are frequent and brief. With cross-domain script and JSONP requests, the global option is automatically set to <code>false</code>. See the descriptions of these methods below for more details.</p>
+ <p>The <code>global</code> option prevents handlers registered for the <code><a href="/https/github.com/ajaxSend/">ajaxSend</a></code>, <code><a href="/https/github.com/ajaxError/">ajaxError</a></code>, and similar events from firing when this request would trigger them. This can be useful to, for example, suppress a loading indicator that was implemented with an <code><a href="/https/github.com/ajaxSend/">ajaxSend</a></code> handler if the requests are frequent and brief. With cross-domain script and JSONP requests, the global option is automatically set to <code>false</code>. See the descriptions of these methods below for more details.</p>
<p>If the server performs HTTP authentication before providing a response, the user name and password pair can be sent via the <code>username</code> and <code>password</code> options.</p>
<p>Ajax requests are time-limited, so errors can be caught and handled to provide a better user experience. Request timeouts are usually either left at their default or set as a global default using <code><a href="/https/github.com/jQuery.ajaxSetup/">$.ajaxSetup()</a></code> rather than being overridden for specific requests with the <code>timeout</code> option.</p>
<p>By default, requests are always issued, but the browser may serve results out of its cache. To disallow use of the cached results, set <code>cache</code> to <code>false</code>. To cause the request to report failure if the asset has not been modified since the last request, set <code>ifModified</code> to <code>true</code>.</p>
@@ -454,4 +462,6 @@ $.ajax({
<category slug="version/1.0"/>
<category slug="version/1.5"/>
<category slug="version/1.5.1"/>
+ <category slug="version/3.5"/>
+ <category slug="version/3.6"/>
</entry>
diff --git a/entries/jQuery.ajaxSetup.xml b/entries/jQuery.ajaxSetup.xml
index d175c54ac..b0b54447e 100644
--- a/entries/jQuery.ajaxSetup.xml
+++ b/entries/jQuery.ajaxSetup.xml
@@ -26,7 +26,7 @@ $.ajax({
});
</code></pre>
<div class="warning">
- <p>Note: Global callback functions should be set with their respective global Ajax event handler methods—<code><a href="/https/github.com/ajaxStart/">.ajaxStart()</a></code>, <code><a href="/https/github.com/ajaxStop/">.ajaxStop()</a></code>, <code><a href="/https/github.com/ajaxComplete/">.ajaxComplete()</a></code>, <code><a href="/https/github.com/ajaxError/">.ajaxError()</a></code>, <code><a href="/https/github.com/ajaxSuccess/">.ajaxSuccess()</a></code>, <code><a href="/https/github.com/ajaxSend/">.ajaxSend()</a></code>—rather than within the <code>options</code> object for <code>$.ajaxSetup()</code>.</p>
+ <p>Note: Global callback functions should be set via <code>.on()</code> with their respective global Ajax events—<code><a href="/https/github.com/ajaxStart/">ajaxStart</a></code>, <code><a href="/https/github.com/ajaxStop/">ajaxStop</a></code>, <code><a href="/https/github.com/ajaxComplete/">ajaxComplete</a></code>, <code><a href="/https/github.com/ajaxError/">ajaxError</a></code>, <code><a href="/https/github.com/ajaxSuccess/">ajaxSuccess</a></code>, <code><a href="/https/github.com/ajaxSend/">ajaxSend</a></code>—rather than within the <code>options</code> object for <code>$.ajaxSetup()</code>.</p>
</div>
</longdesc>
<example>
diff --git a/entries/jQuery.boxModel.xml b/entries/jQuery.boxModel.xml
index ac4648503..b80abe29a 100644
--- a/entries/jQuery.boxModel.xml
+++ b/entries/jQuery.boxModel.xml
@@ -4,8 +4,12 @@
<signature>
<added>1.0</added>
</signature>
- <desc>States if the current page, in the user's browser, is being rendered using the <a href="https://www.w3.org/TR/REC-CSS2/box.html">W3C CSS Box Model</a>. <strong>This property was removed in jQuery 1.8</strong>. Please try to use feature detection instead.</desc>
- <longdesc/>
+ <desc>States if the current page, in the user's browser, is being rendered using the <a href="https://www.w3.org/TR/REC-CSS2/box.html">W3C CSS Box Model</a>.</desc>
+ <longdesc>
+ <div class="warning">
+ <p>Note: This API has been removed in jQuery 3.0; check if <code>.document.compatMode</code> is equal to <code>"CSS1Compat"</code> instead. Or, even better - always specify a DOCTYPE and avoid using quirks mode which jQuery doesn't support.</p>
+ </div>
+ </longdesc>
<category slug="utilities"/>
<category slug="version/1.0"/>
<category slug="deprecated/deprecated-1.3"/>
diff --git a/entries/jQuery.browser.xml b/entries/jQuery.browser.xml
index 667ed5f15..11686eaec 100644
--- a/entries/jQuery.browser.xml
+++ b/entries/jQuery.browser.xml
@@ -7,6 +7,9 @@
</signature>
<desc>Contains flags for the useragent, read from navigator.userAgent. <strong>This property was removed in jQuery 1.9</strong> and is available only through the jQuery.migrate plugin. Please try to use feature detection instead.</desc>
<longdesc>
+ <div class="warning">
+ <p>Note: This API has been removed in jQuery 1.9; please rely on feature detection instead.</p>
+ </div>
<p>The <code>$.browser</code> property provides information about the web browser that is accessing the page, as reported by the browser itself. It contains flags for each of the four most prevalent browser classes (Internet Explorer, Mozilla, Webkit, and Opera) as well as version information.</p>
<p>Available flags are:</p>
<ul>
@@ -56,6 +59,9 @@ $.browser.msie;
</signature>
<desc>The version number of the rendering engine for the user's browser. <strong>This property was removed in jQuery 1.9</strong> and is available only through the jQuery.migrate plugin.</desc>
<longdesc>
+ <div class="warning">
+ <p>Note: This API has been removed in jQuery 1.9; please rely on feature detection instead.</p>
+ </div>
<p>Here are some typical results:</p>
<ul>
<li>Internet Explorer: 6.0, 7.0, 8.0</li>
diff --git a/entries/jQuery.cssHooks.xml b/entries/jQuery.cssHooks.xml
index 19bb9054e..ec36ccfe1 100644
--- a/entries/jQuery.cssHooks.xml
+++ b/entries/jQuery.cssHooks.xml
@@ -163,7 +163,7 @@ if ( $.support.someCSSProp && $.support.someCSSProp !== "someCSSProp" )
})( jQuery );
</code></pre>
<h4 id="special-units">Special units</h4>
- <p>By default, jQuery adds a "px" unit to the values passed to the <code>.css()</code> method. This behavior can be prevented by adding the property to the <a href="/https/github.com/jQuery.cssNumer/"><code>jQuery.cssNumber</code></a> object</p>
+ <p>By default, jQuery adds a "px" unit to the values passed to the <code>.css()</code> method. This behavior can be prevented by adding the property to the <a href="/https/github.com/jQuery.cssNumber/"><code>jQuery.cssNumber</code></a> object</p>
<pre><code>
$.cssNumber.someCSSProp = true;
</code></pre>
diff --git a/entries/jQuery.cssNumber.xml b/entries/jQuery.cssNumber.xml
index ce5af8867..c49b3c785 100644
--- a/entries/jQuery.cssNumber.xml
+++ b/entries/jQuery.cssNumber.xml
@@ -1,30 +1,50 @@
<?xml version="1.0"?>
-<entry type="property" name="jQuery.cssNumber" return="Object">
+<entry type="property" name="jQuery.cssNumber" return="Object" removed="4.0">
<title>jQuery.cssNumber</title>
<signature>
<added>1.4.3</added>
</signature>
- <desc>An object containing all CSS properties that may be used without a unit. The <a href="/https/github.com/css/"><code>.css()</code></a> method uses this object to see if it may append <code>px</code> to unitless values.</desc>
+ <desc>An object containing all CSS properties that may be used without a unit. Prior to jQuery 4.0, the <a href="/https/github.com/css/"><code>.css()</code></a> method uses this object to see if it may append <code>px</code> to unitless values.</desc>
<longdesc>
- <p>You can think about <code>jQuery.cssNumber</code> as a list of all CSS properties you might use without a unit. It's used by <a href="/https/github.com/css/"><code>.css()</code></a> to determine if it needs to add <code>px</code> to unitless values.</p>
- <p>The keys of the <code>jQuery.cssNumber</code> object are camel-cased and the values are all set to <code>true</code>. If you want to prevent the <a href="/https/github.com/css/"><code>.css()</code></a> method from automatically adding the <code>px</code> unit for a specific CSS property, you can add an extra property to the <code>jQuery.cssNumber</code> object.</p>
+ <div class="warning">
+ <p>Note: This API has been removed in jQuery 4.0; please pass a string value with the desired units instead.</p>
+ </div>
+ <p>You can think about <code>jQuery.cssNumber</code> as a list of all CSS properties you might use without a unit. Prior to jQuery 4.0, it was used by <a href="/https/github.com/css/"><code>.css()</code></a> to determine if it needs to add <code>px</code> to unitless values.</p>
+ <p>The keys of the <code>jQuery.cssNumber</code> object are camel-cased and the values are all set to <code>true</code>. If you want to prevent the <a href="/https/github.com/css/"><code>.css()</code></a> method from automatically adding the <code>px</code> unit for a specific CSS property and that property is not yet a key of the <code>jQuery.cssNumber</code> object, you can add such an extra property:</p>
<pre><code>
-jQuery.cssNumber.someCSSProp = true;
+if ( jQuery.cssNumber ) {
+ jQuery.cssNumber.someCSSProp = true;
+}
</code></pre>
<p>By default the object contains the following properties:</p>
<ul>
- <li><code>zIndex</code></li>
- <li><code>fontWeight</code></li>
- <li><code>opacity</code></li>
- <li><code>zoom</code></li>
- <li><code>lineHeight</code></li>
- <li><code>widows</code> (added in jQuery 1.6)</li>
- <li><code>orphans</code> (added in jQuery 1.6)</li>
- <li><code>fillOpacity</code> (added in jQuery 1.6.2)</li>
- <li><code>columnCount</code> (added in jQuery 1.9)</li>
- <li><code>order</code> (added in jQuery 1.10.2)</li>
- <li><code>flexGrow</code> (added in jQuery 1.11.1)</li>
- <li><code>flexShrink</code> (added in jQuery 1.11.1)</li>
+ <li><code>animationIterationCount</code> (added in 1.12.0/2.2.0)</li>
+ <li><code>aspectRatio</code> (added in 3.7.0)</li>
+ <li><code>borderImageSlice</code> (added in 3.7.0)</li>
+ <li><code>columnCount</code> (added in 1.9.0)</li>
+ <li><code>flexGrow</code> (added in 1.11.1/2.1.1)</li>
+ <li><code>flexShrink</code> (added in 1.11.1/2.1.1)</li>
+ <li><code>fontWeight</code> (added in 1.4.3)</li>
+ <li><code>gridArea</code> (added in 3.4.0)</li>
+ <li><code>gridColumn</code> (added in 3.4.0)</li>
+ <li><code>gridColumnEnd</code> (added in 3.4.0)</li>
+ <li><code>gridColumnStart</code> (added in 3.4.0)</li>
+ <li><code>gridRow</code> (added in 3.4.0)</li>
+ <li><code>gridRowEnd</code> (added in 3.4.0)</li>
+ <li><code>gridRowStart</code> (added in 3.4.0)</li>
+ <li><code>lineHeight</code> (added in 1.4.3)</li>
+ <li><code>opacity</code> (added in 1.4.3)</li>
+ <li><code>order</code> (added in 1.10.2/2.0.3)</li>
+ <li><code>orphans</code> (added in 1.6.0)</li>
+ <li><code>scale</code> (added in 3.7.0)</li>
+ <li><code>widows</code> (added in 1.6.0)</li>
+ <li><code>zIndex</code> (added in 1.4.3)</li>
+ <li><code>zoom</code> (added in 1.4.3)</li>
+ <li><code>fillOpacity</code> (SVG-related, added in 1.6.2)</li>
+ <li><code>floodOpacity</code> (SVG-related, added in 3.7.0)</li>
+ <li><code>stopOpacity</code> (SVG-related, added in 3.7.0)</li>
+ <li><code>strokeMiterlimit</code> (SVG-related, added in 3.7.0)</li>
+ <li><code>strokeOpacity</code> (SVG-related, added in 3.7.0)</li>
</ul>
</longdesc>
<category slug="css"/>
diff --git a/entries/jQuery.data.xml b/entries/jQuery.data.xml
index bc1bab43f..5207c8b89 100644
--- a/entries/jQuery.data.xml
+++ b/entries/jQuery.data.xml
@@ -34,8 +34,8 @@ jQuery.data( div, "test", {
first: 16,
last: "pizza!"
});
-$( "span:first" ).text( jQuery.data( div, "test" ).first );
-$( "span:last" ).text( jQuery.data( div, "test" ).last );
+$( "span" ).first().text( jQuery.data( div, "test" ).first );
+$( "span" ).last().text( jQuery.data( div, "test" ).last );
]]></code>
<css><![CDATA[
div {
@@ -92,7 +92,7 @@ alert( jQuery.data( document.body ) );
<example>
<desc>Get the data named "blah" stored at for an element.</desc>
<code><![CDATA[
-$( "button" ).click( function() {
+$( "button" ).on( "click", function() {
var value,
div = $( "div" )[ 0 ];
switch ( $( "button" ).index( this ) ) {
@@ -113,7 +113,7 @@ $( "button" ).click( function() {
break;
}
$( "span" ).text( "" + value );
-});
+} );
]]></code>
<css><![CDATA[
div {
diff --git a/entries/jQuery.dequeue.xml b/entries/jQuery.dequeue.xml
index 4bf143cb5..c9b6faf29 100644
--- a/entries/jQuery.dequeue.xml
+++ b/entries/jQuery.dequeue.xml
@@ -18,7 +18,7 @@
<example>
<desc>Use jQuery.dequeue() to end a custom queue function which allows the queue to keep going.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "div" )
.animate({ left: '+=200px' }, 2000 )
.animate({ top: '0px' }, 600 )
diff --git a/entries/jQuery.error.xml b/entries/jQuery.error.xml
index 3ae5110af..54b64d5d9 100644
--- a/entries/jQuery.error.xml
+++ b/entries/jQuery.error.xml
@@ -10,11 +10,15 @@
<desc>Takes a string and throws an exception containing it.</desc>
<longdesc>
<p>This method exists primarily for plugin developers who wish to override it and provide a better display (or more information) for the error messages.</p>
+ <p>If you do override the method, remember to still throw an error at the end to preserve semantics.</p>
</longdesc>
<example>
- <desc>Override jQuery.error for display in Firebug.</desc>
+ <desc>Override <code>jQuery.error</code> to send it to a logging service, assuming the <code>sendErrorLog</code> method is provided by this service.</desc>
<code><![CDATA[
-jQuery.error = console.error;
+jQuery.error = function( message ) {
+ sendErrorLog( "jQuery error: " + message );
+ throw new Error( message );
+};
]]></code>
</example>
<category slug="internals"/>
diff --git a/entries/jQuery.extend.xml b/entries/jQuery.extend.xml
index b28ec2e0c..472626153 100644
--- a/entries/jQuery.extend.xml
+++ b/entries/jQuery.extend.xml
@@ -4,9 +4,9 @@
<signature>
<added>1.0</added>
<argument name="target" type="Object">
- <desc> An object that will receive the new properties if additional objects are passed in or that will extend the jQuery namespace if it is the sole argument.</desc>
+ <desc> An object that will receive the new properties.</desc>
</argument>
- <argument name="object1" type="Object" optional="true">
+ <argument name="object1" type="Object">
<desc>An object containing additional properties to merge in.</desc>
</argument>
<argument name="objectN" optional="true" type="Object">
@@ -28,6 +28,12 @@
<desc>Additional objects containing properties to merge in.</desc>
</argument>
</signature>
+ <signature>
+ <added>1.0</added>
+ <argument name="object" type="Object">
+ <desc> An object to merge onto the jQuery namespace.</desc>
+ </argument>
+ </signature>
<desc>Merge the contents of two or more objects together into the first object.</desc>
<longdesc>
<p>When two or more object arguments are supplied to <code>$.extend()</code>, properties from all of the objects are added to the target object. Arguments that are <code>null</code> or <code>undefined</code> are ignored.</p>
@@ -35,6 +41,7 @@
<p>Keep in mind that the target object (first argument) will be modified, and will also be returned from <code>$.extend()</code>. If, however, you want to preserve both of the original objects, you can do so by passing an empty object as the target:</p>
<pre><code>var object = $.extend({}, object1, object2);</code></pre>
<p>The merge performed by <code>$.extend()</code> is not recursive by default; if a property of the first object is itself an object or array, it will be completely overwritten by a property with the same key in the second or subsequent object. The values are not merged. This can be seen in the example below by examining the value of banana. However, by passing <code>true</code> for the first function argument, objects will be recursively merged.</p>
+ <p><strong>Warning</strong>: Versions prior to 3.4 had a security issue where calling <code>jQuery.extend(true, {}, object)</code> on an unsanitized object containing a <code>__proto__</code> property would extend <code>Object.prototype</code>.</p>
<p><strong>Warning</strong>: Passing <code>false</code> for the first argument is not supported.</p>
<p>Undefined properties are not copied. However, properties inherited from the object's prototype <em>will</em> be copied over. Properties that are an object constructed via <code>new MyCustomObject(args)</code>, or built-in JavaScript types such as Date or RegExp, are not re-constructed and will appear as plain Objects in the resulting object or array.</p>
<p>On a <code>deep</code> extend, Object and Array are extended, but object wrappers on primitive types such as String, Boolean, and Number are not. Deep-extending a cyclical data structure will result in an error.</p>
@@ -106,4 +113,5 @@ $( "#log" ).append( "<div><b>settings -- </b>" + JSON.stringify( settings ) + "<
</example>
<category slug="utilities"/>
<category slug="version/1.0"/>
+ <category slug="version/3.4"/>
</entry>
diff --git a/entries/jQuery.fx.interval.xml b/entries/jQuery.fx.interval.xml
index 2dfd1719f..b86516c3e 100644
--- a/entries/jQuery.fx.interval.xml
+++ b/entries/jQuery.fx.interval.xml
@@ -1,12 +1,14 @@
<?xml version="1.0"?>
-<entry type="property" name="jQuery.fx.interval" return="Number" deprecated="3.0">
+<entry type="property" name="jQuery.fx.interval" return="Number" deprecated="3.0" removed="4.0">
<title>jQuery.fx.interval</title>
<desc>The rate (in milliseconds) at which animations fire.</desc>
<signature>
<added>1.4.3</added>
</signature>
<longdesc>
- <p>This property is deprecated as of version 3.0, and has no effect in browsers that support the <a href="https://caniuse.com/#feat=requestanimationframe"><code>requestAnimationFrame</code></a> method.</p>
+ <div class="warning">
+ <p>This property is deprecated as of version 3.0, and has no effect in browsers that support the <a href="https://caniuse.com/#feat=requestanimationframe"><code>requestAnimationFrame</code></a> method.</p>
+ </div>
<p>On browsers that do not support <code>requestAnimationFrame</code>, this property can be changed to adjust the interval at which animations will run. The default is 13 milliseconds.</p>
<p>Since jQuery uses one global interval, no animation should be running or all animations should stop for the change of this property to take effect.</p>
</longdesc>
@@ -14,7 +16,7 @@
<desc>Cause all animations to run with less frames.</desc>
<code><![CDATA[
jQuery.fx.interval = 100;
-$( "input" ).click(function() {
+$( "input" ).on( "click", function() {
$( "div" ).toggle( 3000 );
});
]]></code>
diff --git a/entries/jQuery.fx.off.xml b/entries/jQuery.fx.off.xml
index 74bfd60a3..8464f69f5 100644
--- a/entries/jQuery.fx.off.xml
+++ b/entries/jQuery.fx.off.xml
@@ -20,10 +20,10 @@ var toggleFx = function() {
$.fx.off = !$.fx.off;
};
toggleFx();
-$( "button" ).click( toggleFx );
-$( "input" ).click(function() {
+$( "button" ).on( "click", toggleFx );
+$( "input" ).on( "click", function() {
$( "div" ).toggle( "slow" );
-});
+} );
]]></code>
<css><![CDATA[
div {
diff --git a/entries/jQuery.get.xml b/entries/jQuery.get.xml
index be1e25a2a..575a6f835 100644
--- a/entries/jQuery.get.xml
+++ b/entries/jQuery.get.xml
@@ -22,9 +22,9 @@
</argument>
</signature>
<signature>
- <added>1.12/2.2</added>
+ <added>1.12-and-2.2</added>
<argument name="settings" type="PlainObject" optional="false">
- <desc>A set of key/value pairs that configure the Ajax request. All properties except for <code>url</code> are optional. A default can be set for any option with <a href="/https/github.com/jQuery.ajaxSetup/">$.ajaxSetup()</a>. See <a href="/https/github.com/jquery.ajax/#jQuery-ajax-settings">jQuery.ajax( settings )</a> for a complete list of all settings. The type option will automatically be set to <code>GET</code>.</desc>
+ <desc>A set of key/value pairs that configure the Ajax request. All properties except for <code>url</code> are optional. A default can be set for any option with <a href="/https/github.com/jQuery.ajaxSetup/">$.ajaxSetup()</a>. See <a href="/https/github.com/jQuery.ajax/#jQuery-ajax-settings">jQuery.ajax( settings )</a> for a complete list of all settings. The type option will automatically be set to <code>GET</code>.</desc>
</argument>
</signature>
<desc>Load data from the server using a HTTP GET request.</desc>
@@ -116,16 +116,28 @@ $.get( "test.cgi", { name: "John", time: "2pm" } )
]]></code>
</example>
<example>
- <desc> Get the test.php page contents, which has been returned in json format (<?php echo json_encode( array( "name"=>"John","time"=>"2pm" ) ); ?>), and add it to the page.</desc>
+ <desc>Get the test.php page contents, which has been returned in json format (<?php echo json_encode( array( "name"=>"John","time"=>"2pm" ) ); ?>), and add it to the page.</desc>
<code><![CDATA[
$.get( "test.php", function( data ) {
$( "body" )
.append( "Name: " + data.name ) // John
.append( "Time: " + data.time ); // 2pm
}, "json" );
+]]></code>
+ </example>
+ <example>
+ <desc>Get another page on the same domain. Outputs to console both the data returned and the type of data returned.</desc>
+ <code><![CDATA[
+// If this was sent on https://api.jquery.com/jQuery.get/ you will
+// get the response result of https://api.jquery.com/jQuery.ajax/
+$.get( "/jQuery.ajax/", function( data ) {
+ console.log( typeof data ); // string
+ console.log( data ); // HTML content of the jQuery.ajax page
+});
]]></code>
</example>
<category slug="ajax/shorthand-methods"/>
<category slug="version/1.0"/>
<category slug="version/1.5"/>
+ <category slug="version/1.12-and-2.2"/>
</entry>
diff --git a/entries/jQuery.getJSON.xml b/entries/jQuery.getJSON.xml
index 07a926cca..1449293d2 100644
--- a/entries/jQuery.getJSON.xml
+++ b/entries/jQuery.getJSON.xml
@@ -82,7 +82,7 @@ var jqxhr = $.getJSON( "example.json", function() {
// Perform other work here ...
// Set another completion function for the request above
-jqxhr.complete(function() {
+jqxhr.always(function() {
console.log( "second complete" );
});
</code></pre>
diff --git a/entries/jQuery.getScript.xml b/entries/jQuery.getScript.xml
index be884042e..d44d1f3a1 100644
--- a/entries/jQuery.getScript.xml
+++ b/entries/jQuery.getScript.xml
@@ -27,7 +27,7 @@ $.ajax({
<h4 id="success-callback">
Success Callback
</h4>
- <p>The callback is fired once the script has been loaded but not necessarily executed.</p>
+ <p>The callback is fired once the script has been loaded and executed.</p>
<p>Scripts are included and run by referencing the file name:</p>
<pre><code>
$.getScript( "ajax/test.js", function( data, textStatus, jqxhr ) {
@@ -48,14 +48,15 @@ $.getScript( "ajax/test.js" )
$( "div.log" ).text( "Triggered ajaxError handler." );
});
</code></pre>
- <p>Prior to jQuery 1.5, the global <code>.ajaxError()</code> callback event had to be used in order to handle <code>$.getScript()</code> errors:</p>
+ <p>Prior to jQuery 1.5, the global <code>ajaxError</code> callback event had to be used in order to handle <code>$.getScript()</code> errors:</p>
<pre><code>
-$( "div.log" ).ajaxError(function( e, jqxhr, settings, exception ) {
+$( "div.log" ).on( "ajaxError", function( e, jqxhr, settings, exception ) {
if ( settings.dataType == "script" ) {
$( this ).text( "Triggered ajaxError handler." );
}
-});
+} );
</code></pre>
+ <p>Prior to jQuery 3.5.0, unsuccessful HTTP responses with a script <code>Content-Type</code> were still executed.</p>
<h4 id="caching-requests">Caching Responses</h4>
<p>By default, <code>$.getScript()</code> sets the cache setting to <code>false</code>. This appends a timestamped query parameter to the request URL to ensure that the browser downloads the script each time it is requested. You can override this feature by setting the cache property globally using <a href="/https/github.com/jquery.ajaxsetup/"><code>$.ajaxSetup()</code></a>: </p>
<pre><code>
@@ -91,9 +92,9 @@ $.cachedScript( "ajax/test.js" ).done(function( script, textStatus ) {
<example>
<desc>Load the <a href="https://github.com/jquery/jquery-color">official jQuery Color Animation plugin</a> dynamically and bind some color animations to occur once the new functionality is loaded.</desc>
<code><![CDATA[
-var url = "https://code.jquery.com/color/jquery.color.js";
+var url = "https://code.jquery.com/color/jquery.color-2.1.2.js";
$.getScript( url, function() {
- $( "#go" ).click(function() {
+ $( "#go" ).on( "click", function() {
$( ".block" )
.animate({
backgroundColor: "rgb(255, 180, 180)"
@@ -125,4 +126,5 @@ $.getScript( url, function() {
<category slug="ajax/shorthand-methods"/>
<category slug="version/1.0"/>
<category slug="version/1.5"/>
+ <category slug="version/3.5"/>
</entry>
diff --git a/entries/jQuery.globalEval.xml b/entries/jQuery.globalEval.xml
index ad6b7d1e5..f6234efed 100644
--- a/entries/jQuery.globalEval.xml
+++ b/entries/jQuery.globalEval.xml
@@ -7,6 +7,31 @@
<desc>The JavaScript code to execute.</desc>
</argument>
</signature>
+ <signature>
+ <added>3.4</added>
+ <argument name="code" type="String">
+ <desc>The JavaScript code to execute.</desc>
+ </argument>
+ <argument name="options" type="PlainObject" optional="true">
+ <property name="nonce" type="string">
+ <desc>The nonce attribute passed to the executed script.</desc>
+ </property>
+ </argument>
+ </signature>
+ <signature>
+ <added>3.5</added>
+ <argument name="code" type="String">
+ <desc>The JavaScript code to execute.</desc>
+ </argument>
+ <argument name="options" type="PlainObject" optional="true">
+ <property name="nonce" type="string">
+ <desc>The nonce attribute passed to the executed script.</desc>
+ </property>
+ </argument>
+ <argument name="doc" type="Document" optional="true">
+ <desc>A document in which context the code will be evaluated.</desc>
+ </argument>
+ </signature>
<desc>Execute some JavaScript code globally.</desc>
<longdesc>
<p>This method behaves differently from using a normal JavaScript <code>eval()</code> in that it's executed within the global context (which is important for loading external scripts dynamically).</p>
@@ -15,7 +40,19 @@
<desc>Execute a script in the global context.</desc>
<code><![CDATA[
function test() {
- jQuery.globalEval( "var newVar = true;" )
+ jQuery.globalEval( "var newVar = true;" );
+}
+test();
+// newVar === true
+]]></code>
+ </example>
+ <example>
+ <desc>Execute a script with a nonce value on a site with Content Security Policy enabled.</desc>
+ <code><![CDATA[
+function test() {
+ jQuery.globalEval( "var newVar = true;", {
+ nonce: "nonce-2726c7f26c"
+ } );
}
test();
// newVar === true
diff --git a/entries/jQuery.holdReady.xml b/entries/jQuery.holdReady.xml
index 016e951a1..0ba8ceb04 100644
--- a/entries/jQuery.holdReady.xml
+++ b/entries/jQuery.holdReady.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="method" name="jQuery.holdReady" return="undefined">
+<entry type="method" name="jQuery.holdReady" return="undefined" deprecated="3.2">
<title>jQuery.holdReady()</title>
<desc>Holds or releases the execution of jQuery's ready event.</desc>
<signature>
@@ -9,6 +9,16 @@
</argument>
</signature>
<longdesc>
+ <div class="warning">
+ <p>Note: This API has been deprecated in jQuery 3.2. Instead of relying on this global switch, it's better to put explicitly wait for required code. If you need to wait both for the ready state & for a custom promise, use the following pattern:</p>
+ <code><![CDATA[$.when( $.ready, customPromise )
+ .then( function() {
+ // main code
+ } )
+ .catch( function( error ) {
+ // handle errors
+ } )]]></code>
+ </div>
<p>The <code>$.holdReady()</code> method allows the caller to delay jQuery's ready event. This <em>advanced feature</em> would typically be used by dynamic script loaders that want to load additional JavaScript such as jQuery plugins before allowing the ready event to occur, even though the DOM may be ready. This method must be called early in the document, such as in the <code><head></code> immediately after the jQuery script tag. Calling this method after the ready event has already fired will have no effect. </p>
<p>To delay the ready event, first call <code>$.holdReady( true )</code>. When the ready event should be released to execute, call <code>$.holdReady( false )</code>. Note that multiple holds can be put on the ready event, one for each <code>$.holdReady( true )</code> call. The ready event will not actually fire until all holds have been released with a corresponding number of <code>$.holdReady( false )</code> calls <em>and</em> the normal document ready conditions are met. (See <a href="/https/github.com/ready/"><code>ready</code></a> for more information.)</p>
</longdesc>
@@ -25,4 +35,5 @@ $.getScript( "myplugin.js", function() {
<category slug="properties/global-jquery-object-properties"/>
<category slug="events/document-loading"/>
<category slug="version/1.6"/>
+ <category slug="deprecated/deprecated-3.2"/>
</entry>
diff --git a/entries/jQuery.htmlPrefilter.xml b/entries/jQuery.htmlPrefilter.xml
index 3682ed5bd..753819039 100644
--- a/entries/jQuery.htmlPrefilter.xml
+++ b/entries/jQuery.htmlPrefilter.xml
@@ -3,75 +3,15 @@
<title>jQuery.htmlPrefilter()</title>
<desc>Modify and filter HTML strings passed through <a href="/https/github.com/category/manipulation/">jQuery manipulation methods</a>.</desc>
<signature>
- <added>1.12/2.2</added>
+ <added>1.12-and-2.2</added>
<argument name="html" type="String">
<desc>The HTML string on which to operate.</desc>
</argument>
</signature>
<longdesc>
- <p>This method rarely needs to be called directly. Instead, use it as an entry point to modify existing <a href="/https/github.com/category/manipulation/">jQuery manipulation methods</a>. For instance, to remove all <code><del></code> tags from incoming HTML strings, do this:</p>
- <pre><code>
-var htmlPrefilter = $.htmlPrefilter,
- rdel = /<(del)(?=[\s>])[\w\W]*?<\/\1\s*>/gi;
-
-$.htmlPrefilter = function( html ) {
- return htmlPrefilter.call( this, html ).replace( rdel, "" );
-};
- </code></pre>
- <p>This function can also be overwritten in order to bypass certain edge case issues. The default <code>htmlPrefilter</code> function in jQuery will greedily ensure that all tags are XHTML-compliant. This includes anything that looks like an HTML tag, but is actually within a string (e.g. <pre><a title="<div />"><></pre>). The <code>jQuery.htmlPrefilter()</code> function can be used to bypass this:</p>
- <pre><code>
-$.htmlPrefilter = function( html ) {
- // Return HTML strings unchanged
- return html;
-};
- </code></pre>
- <p>However, while the above fix is short and simple, it puts the burden on you to ensure XHTML-compliant tags in any HTML strings. A more thorough fix for this issue would be this:</p>
- <pre><code>
-var panything = "[\\w\\W]*?",
-
- // Whitespace
- // https://html.spec.whatwg.org/multipage/infrastructure.html#space-character
- pspace = "[\\x20\\t\\r\\n\\f]",
-
- // End of tag name (whitespace or greater-than)
- pnameEnd = pspace.replace( "]", ">]" ),
-
- // Tag name (a leading letter, then almost anything)
- // https://html.spec.whatwg.org/multipage/syntax.html#tag-open-state
- // https://html.spec.whatwg.org/multipage/syntax.html#tag-name-state
- pname = "[a-z]" + pnameEnd.replace( "[", "[^/\\0" ) + "*",
-
- // Void element (end tag prohibited)
- // https://html.spec.whatwg.org/multipage/syntax.html#void-elements
- pvoidName = "(?:area|base|br|col|embed|hr|img|input|keygen|link|menuitem|meta|param|" +
- "source|track|wbr)(?=" + pnameEnd + ")",
-
- // Attributes (double-quoted value, single-quoted value, unquoted value, or no value)
- // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
- pattrs = "(?:" + pspace + "+[^\\0-\\x20\\x7f-\\x9f=\"'/>]+(?:" + pspace + "*=" + pspace +
- "*(?:\"" + panything + "\"|'" + panything + "'|" +
- pnameEnd.replace( "[", "[^" ) + "*(?!/)" +
- ")|))*" + pspace + "*",
-
- // Trailing content of a close tag
- pcloseTail = "(?:" + pspace + panything + "|)",
-
- rspecialHtml = new RegExp(
- // Non-void element that self-closes: $1–$5
- "(<)(?!" + pvoidName + ")(" + pname + ")(" + pattrs + ")(\\/)(>)|" +
- // No-innerHTML container (element, comment, or CDATA): $6
- "(<(script|style|textarea)" + pattrs + ">" + panything + "<\\/\\7" + pcloseTail + ">|" +
- "<!--" + panything + "--)",
- "gi"
- ),
-
- // "<"; element name; attributes; ">"; "<"; "/"; element name; ">"; no-innerHTML container
- pspecialReplacement = "$1$2$3$5$1$4$2$5$6";
-
-$.htmlPrefilter = function( html ) {
- return ( html + "" ).replace( rspecialHtml, pspecialReplacement );
-};
- </code></pre>
+ <p>This method rarely needs to be called directly. Instead, use it as an entry point to modify existing <a href="/https/github.com/category/manipulation/">jQuery manipulation methods</a>. jQuery calls this method on input HTML before processing it further: it accepts an HTML string & should return a HTML string as well.</p>
+ <p>This function can also be overwritten in order to bypass certain edge case issues. The default <code>htmlPrefilter</code> function in jQuery leaves input unmodified since 3.5.0. Older versions would greedily ensure that all tags were XHTML-compliant. This included anything that looked like an HTML tag, but was actually within a string (e.g. <code><a title="<div />"><></code>), leading to potential security issues. For more information, see the <a href="https://jquery.com/upgrade-guide/3.5/">jQuery Core 3.5 Upgrade guide</a>.</p>
</longdesc>
<category slug="manipulation"/>
+ <category slug="version/3.5"/>
</entry>
diff --git a/entries/jQuery.isArray.xml b/entries/jQuery.isArray.xml
index 6f040c4ec..9891126ff 100644
--- a/entries/jQuery.isArray.xml
+++ b/entries/jQuery.isArray.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="method" name="jQuery.isArray" return="boolean">
+<entry type="method" name="jQuery.isArray" return="boolean" deprecated="3.2" removed="4.0">
<title>jQuery.isArray()</title>
<signature>
<added>1.3</added>
@@ -9,6 +9,9 @@
</signature>
<desc>Determine whether the argument is an array.</desc>
<longdesc>
+ <div class="warning">
+ <p>Note: This API has been deprecated in jQuery 3.2; please use the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray"><code>Array.isArray</code></a> method instead.</p>
+ </div>
<p><code>$.isArray()</code> returns a Boolean indicating whether the object is a JavaScript array (not an array-like object, such as a jQuery object).</p>
</longdesc>
<example>
@@ -22,4 +25,5 @@ Is [] an Array? <b></b>
</example>
<category slug="utilities"/>
<category slug="version/1.3"/>
+ <category slug="deprecated/deprecated-3.2"/>
</entry>
diff --git a/entries/jQuery.isFunction.xml b/entries/jQuery.isFunction.xml
index 7aed55748..5160f0a70 100644
--- a/entries/jQuery.isFunction.xml
+++ b/entries/jQuery.isFunction.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="method" name="jQuery.isFunction" return="boolean" deprecated="3.3">
+<entry type="method" name="jQuery.isFunction" return="boolean" deprecated="3.3" removed="4.0">
<title>jQuery.isFunction()</title>
<signature>
<added>1.2</added>
@@ -9,7 +9,9 @@
</signature>
<desc>Determines if its argument is callable as a function.</desc>
<longdesc>
- <p>As of jQuery 3.3, <code>jQuery.isFunction()</code> has been deprecated. In most cases, its use can be replaced by <code>typeof x === "function"</code>.</p>
+ <div class="warning">
+ <p>As of jQuery 3.3, <code>jQuery.isFunction()</code> has been deprecated. In most cases, its use can be replaced by <code>typeof x === "function"</code>.</p>
+ </div>
<p><strong>Note:</strong> As of jQuery 1.3, functions provided by the browser like <code>alert()</code> and DOM element methods like <code>getAttribute()</code> are not guaranteed to be detected as functions in browsers such as Internet Explorer.</p>
</longdesc>
<example>
diff --git a/entries/jQuery.isNumeric.xml b/entries/jQuery.isNumeric.xml
index b51eb84d3..c4fe4a72d 100644
--- a/entries/jQuery.isNumeric.xml
+++ b/entries/jQuery.isNumeric.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="method" name="jQuery.isNumeric" return="Boolean">
+<entry type="method" name="jQuery.isNumeric" return="Boolean" deprecated="3.3" removed="4.0">
<title>jQuery.isNumeric()</title>
<desc>Determines whether its argument represents a JavaScript number.</desc>
<signature>
@@ -9,6 +9,9 @@
</argument>
</signature>
<longdesc>
+ <div class="warning">
+ <p>Note: This API has been deprecated in jQuery 3.3.</p>
+ </div>
<p>The <code>$.isNumeric()</code> method checks whether its argument represents a numeric value. If so, it returns <code>true</code>. Otherwise it returns <code>false</code>. The argument can be of any type.</p>
<p>As of jQuery 3.0 <code>$.isNumeric()</code> returns <code>true</code> only if the argument is of type <a href="/Types/#Number"><code>number</code></a>, or if it's of type <code>string</code> and it can be coerced into finite numbers. In all other cases, it returns <code>false</code>.</p>
</longdesc>
@@ -39,4 +42,5 @@ $.isNumeric( undefined )
</example>
<category slug="utilities"/>
<category slug="version/1.7"/>
+ <category slug="deprecated/deprecated-3.3"/>
</entry>
diff --git a/entries/jQuery.isWindow.xml b/entries/jQuery.isWindow.xml
index ee8ed3b13..76a58f176 100644
--- a/entries/jQuery.isWindow.xml
+++ b/entries/jQuery.isWindow.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="method" name="jQuery.isWindow" return="boolean" deprecated="3.3">
+<entry type="method" name="jQuery.isWindow" return="boolean" deprecated="3.3" removed="4.0">
<title>jQuery.isWindow()</title>
<signature>
<added>1.4.3</added>
@@ -9,6 +9,12 @@
</signature>
<desc>Determine whether the argument is a window.</desc>
<longdesc>
+ <div class="warning">
+ <p>Note: This API has been deprecated in jQuery 3.3; if you need this function, reimplement it by yourself:</p>
+ <code><![CDATA[function isWindow( obj ) {
+ return obj != null && obj === obj.window;
+}]]></code>
+ </div>
<p>This is used in a number of places in jQuery to determine if we're operating against a browser window (such as the current window or an iframe).</p>
</longdesc>
<example>
diff --git a/entries/jQuery.map.xml b/entries/jQuery.map.xml
index 3c499e6c8..2016df876 100644
--- a/entries/jQuery.map.xml
+++ b/entries/jQuery.map.xml
@@ -3,8 +3,8 @@
<title>jQuery.map()</title>
<signature>
<added>1.0</added>
- <argument name="array" type="Array">
- <desc>The Array to translate.</desc>
+ <argument name="array" type="ArrayLikeObject">
+ <desc>The Array or an Array-like object to translate.</desc>
</argument>
<argument name="callback" type="Function">
<argument name="elementOfArray" type="Object" />
@@ -16,7 +16,7 @@
<signature>
<added>1.6</added>
<argument name="object" type="Object">
- <desc>The Object to translate.</desc>
+ <desc>The non-Array-like Object to translate.</desc>
</argument>
<argument name="callback" type="Function">
<argument name="propertyOfObject" type="Object" />
@@ -28,16 +28,13 @@
<desc>Translate all items in an array or object to new array of items.</desc>
<longdesc>
<p>If you wish to process a jQuery object — for example, <code>$('div').map( callback );</code> — use <a href="/https/github.com/map/">.map()</a> instead. </p>
- <p>The <code>$.map()</code> method applies a function to each item in an array or object and maps the results into a new array. <strong>Prior to jQuery 1.6</strong>, <code>$.map()</code> supports traversing <em>arrays only</em>. <strong>As of jQuery 1.6</strong> it also traverses objects.</p>
- <p>Array-like objects — those with a <code>.length</code> property <em>and</em> a value on the <code>.length - 1</code> index — must be converted to actual arrays before being passed to <code>$.map()</code>. The jQuery library provides <a href="/https/github.com/jQuery.makeArray/">$.makeArray()</a> for such conversions.</p>
+ <p>The <code>$.map()</code> method applies a function to each item in an array or object and maps the results into a new array. <strong>Prior to jQuery 1.6</strong>, <code>$.map()</code> supports traversing <em>arrays and array-like objects only</em>. <strong>As of jQuery 1.6</strong> it also traverses objects.</p>
+ <p>Array-like objects — those with a <code>.length</code> property <em>and</em> a value on the <code>.length - 1</code> index — may be passed to <code>$.map()</code>.</p>
<pre><code>
-// The following object masquerades as an array.
+// The following object is array-like.
var fakeArray = { "length": 2, 0: "Addy", 1: "Subtracty" };
-// Therefore, convert it to a real array
-var realArray = $.makeArray( fakeArray )
-
-// Now it can be used reliably with $.map()
+// It can be used reliably with $.map()
$.map( realArray, function( val, i ) {
// Do something
});
diff --git a/entries/jQuery.now.xml b/entries/jQuery.now.xml
index 6c41af36c..00992aba8 100644
--- a/entries/jQuery.now.xml
+++ b/entries/jQuery.now.xml
@@ -1,13 +1,17 @@
<?xml version="1.0"?>
-<entry type="method" name="jQuery.now" return="Number">
+<entry type="method" name="jQuery.now" return="Number" deprecated="3.3" removed="4.0">
<title>jQuery.now()</title>
<signature>
<added>1.4.3</added>
</signature>
<desc>Return a number representing the current time.</desc>
<longdesc>
- <p>The <code>$.now()</code> method is a shorthand for the number returned by the expression <code>(new Date).getTime()</code>.</p>
+ <div class="warning">
+ <p>Note: This API has been deprecated in jQuery 3.3; please use the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/now"><code>Date.now()</code></a> method instead.</p>
+ </div>
+ <p>The <code>$.now()</code> method is an alias for <code>Date.now()</code>.</p>
</longdesc>
<category slug="utilities"/>
<category slug="version/1.4.3"/>
-</entry>
\ No newline at end of file
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/jQuery.parseHTML.xml b/entries/jQuery.parseHTML.xml
index 5354627ae..5ff74ce77 100644
--- a/entries/jQuery.parseHTML.xml
+++ b/entries/jQuery.parseHTML.xml
@@ -18,8 +18,8 @@
<p><code>jQuery.parseHTML</code> uses native methods to convert the string to a set of DOM nodes, which can then be inserted into the document. These methods do render all trailing or leading text (even if that's just whitespace). To prevent trailing/leading whitespace from being converted to text nodes you can pass the HTML string through <a href="/https/github.com/jQuery.trim/"><code>jQuery.trim</code></a>.</p>
<p>By default, the <code>context</code> is the current <code>document</code> if not specified or given as <code>null</code> or <code>undefined</code>. If the HTML was to be used in another document such as an iframe, that frame's document could be used.</p>
<p>As of 3.0 the default behavior is changed. If the <code>context</code> is not specified or given as <code>null</code> or <code>undefined</code>, a new <code>document</code> is used. This can potentially improve security because inline events will not execute when the HTML is parsed. Once the parsed HTML is injected into a document it does execute, but this gives tools a chance to traverse the created DOM and remove anything deemed unsafe. This improvement does not apply to internal uses of <code>jQuery.parseHTML</code> as they usually pass in the current <code>document</code>. Therefore, a statement like <code>$( "#log" ).append( $( htmlString ) )</code> is still subject to the injection of malicious code.</p>
- <h2>Security Considerations</h2>
- <p>Most jQuery APIs that accept HTML strings will run scripts that are included in the HTML. <code>jQuery.parseHTML</code> does not run scripts in the parsed HTML unless <code>keepScripts</code> is explicitly <code>true</code>. However, it is still possible in most environments to execute scripts indirectly, for example via the <code><img onerror></code> attribute. The caller should be aware of this and guard against it by cleaning or escaping any untrusted inputs from sources such as the URL or cookies. For future compatibility, callers should not depend on the ability to run <em>any</em> script content when <code>keepScripts</code> is unspecified or <code>false</code>.</p>
+ <h2>Security Considerations</h2>
+ <p>Most jQuery APIs that accept HTML strings will run scripts that are included in the HTML. <code>jQuery.parseHTML</code> does not run scripts in the parsed HTML unless <code>keepScripts</code> is explicitly <code>true</code>. However, it is still possible in most environments to execute scripts indirectly, for example via the <code><img onerror></code> attribute. The caller should be aware of this and guard against it by cleaning or escaping any untrusted inputs from sources such as the URL or cookies. For future compatibility, callers should not depend on the ability to run <em>any</em> script content when <code>keepScripts</code> is unspecified or <code>false</code>.</p>
</longdesc>
<example>
<desc>Create an array of DOM nodes using an HTML string and insert it into a div.</desc>
diff --git a/entries/jQuery.parseJSON.xml b/entries/jQuery.parseJSON.xml
index c09f3c40e..2023ebc83 100644
--- a/entries/jQuery.parseJSON.xml
+++ b/entries/jQuery.parseJSON.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="method" name="jQuery.parseJSON" deprecated="3.0">
+<entry type="method" name="jQuery.parseJSON" deprecated="3.0" removed="4.0">
<return type="String"/>
<return type="Number"/>
<return type="Object"/>
@@ -14,7 +14,9 @@
</signature>
<desc>Takes a well-formed JSON string and returns the resulting JavaScript value.</desc>
<longdesc>
- <p>As of jQuery 3.0, <code>$.parseJSON</code> is deprecated. To parse JSON strings use the native <code>JSON.parse</code> method instead.</p>
+ <div class="warning">
+ <p>As of jQuery 3.0, <code>$.parseJSON</code> is deprecated. To parse JSON strings use the native <code>JSON.parse</code> method instead.</p>
+ </div>
<p>Passing in a malformed JSON string results in a JavaScript exception being thrown. For example, the following are all invalid JSON strings:</p>
<ul>
<li><code>"{test: 1}"</code> (test does not have double quotes around it).</li>
diff --git a/entries/jQuery.post.xml b/entries/jQuery.post.xml
index 6152350a0..e5411bed9 100644
--- a/entries/jQuery.post.xml
+++ b/entries/jQuery.post.xml
@@ -22,12 +22,12 @@
</argument>
</signature>
<signature>
- <added>1.12/2.2</added>
+ <added>1.12-and-2.2</added>
<argument name="settings" type="PlainObject" optional="false">
- <desc>A set of key/value pairs that configure the Ajax request. All properties except for <code>url</code> are optional. A default can be set for any option with <a href="/https/github.com/jQuery.ajaxSetup/">$.ajaxSetup()</a>. See <a href="/https/github.com/jquery.ajax/#jQuery-ajax-settings">jQuery.ajax( settings )</a> for a complete list of all settings. Type will automatically be set to <code>POST</code>.</desc>
+ <desc>A set of key/value pairs that configure the Ajax request. All properties except for <code>url</code> are optional. A default can be set for any option with <a href="/https/github.com/jQuery.ajaxSetup/">$.ajaxSetup()</a>. See <a href="/https/github.com/jQuery.ajax/#jQuery-ajax-settings">jQuery.ajax( settings )</a> for a complete list of all settings. Type will automatically be set to <code>POST</code>.</desc>
</argument>
</signature>
- <desc>Load data from the server using a HTTP POST request.</desc>
+ <desc>Send data to the server using a HTTP POST request.</desc>
<longdesc>
<p>This is a shorthand Ajax function, which is equivalent to:</p>
<pre><code>
@@ -50,7 +50,7 @@ $.post( "ajax/test.html", function( data ) {
<p>This example fetches the requested HTML snippet and inserts it on the page.</p>
<p>Pages fetched with <code>POST</code> are never cached, so the <code>cache</code> and <code>ifModified</code> options in <code><a href="/https/github.com/jQuery.ajaxSetup/">jQuery.ajaxSetup()</a></code> have no effect on these requests.</p>
<h4 id="jqxhr-object">The jqXHR Object</h4>
- <p><strong>As of jQuery 1.5</strong>, all of jQuery's Ajax methods return a superset of the <code>XMLHTTPRequest</code> object. This jQuery XHR object, or "jqXHR," returned by <code>$.get()</code> implements the Promise interface, giving it all the properties, methods, and behavior of a Promise (see <a href="/https/github.com/category/deferred-object/">Deferred object</a> for more information). The <code>jqXHR.done()</code> (for success), <code>jqXHR.fail()</code> (for error), and <code>jqXHR.always()</code> (for completion, whether success or error; added in jQuery 1.6) methods take a function argument that is called when the request terminates. For information about the arguments this function receives, see the <a href="/https/github.com/jQuery.ajax/#jqXHR">jqXHR Object</a> section of the <code>$.ajax()</code> documentation.</p>
+ <p><strong>As of jQuery 1.5</strong>, all of jQuery's Ajax methods return a superset of the <code>XMLHTTPRequest</code> object. This jQuery XHR object, or "jqXHR," returned by <code>$.post()</code> implements the Promise interface, giving it all the properties, methods, and behavior of a Promise (see <a href="/https/github.com/category/deferred-object/">Deferred object</a> for more information). The <code>jqXHR.done()</code> (for success), <code>jqXHR.fail()</code> (for error), and <code>jqXHR.always()</code> (for completion, whether success or error; added in jQuery 1.6) methods take a function argument that is called when the request terminates. For information about the arguments this function receives, see the <a href="/https/github.com/jQuery.ajax/#jqXHR">jqXHR Object</a> section of the <code>$.ajax()</code> documentation.</p>
<p>The Promise interface also allows jQuery's Ajax methods, including <code>$.get()</code>, to chain multiple <code>.done()</code>, <code>.fail()</code>, and <code>.always()</code> callbacks on a single request, and even to assign these callbacks after the request may have completed. If the request is already complete, the callback is fired immediately.</p>
<pre><code>
// Assign handlers immediately after making the request,
@@ -135,7 +135,7 @@ $.post( "test.php", { func: "getNameAndTime" }, function( data ) {
<desc>Post a form using Ajax and put results in a div</desc>
<code><![CDATA[
// Attach a submit handler to the form
-$( "#searchForm" ).submit(function( event ) {
+$( "#searchForm" ).on( "submit", function( event ) {
// Stop form from submitting normally
event.preventDefault();
@@ -152,8 +152,8 @@ $( "#searchForm" ).submit(function( event ) {
posting.done(function( data ) {
var content = $( data ).find( "#content" );
$( "#result" ).empty().append( content );
- });
-});
+ } );
+} );
]]></code>
<html><![CDATA[
<form action="/" id="searchForm">
@@ -167,4 +167,5 @@ $( "#searchForm" ).submit(function( event ) {
<category slug="ajax/shorthand-methods"/>
<category slug="version/1.0"/>
<category slug="version/1.5"/>
+ <category slug="version/1.12-and-2.2"/>
</entry>
diff --git a/entries/jQuery.proxy.xml b/entries/jQuery.proxy.xml
index e7c5f0ff8..d00748b93 100644
--- a/entries/jQuery.proxy.xml
+++ b/entries/jQuery.proxy.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="method" name="jQuery.proxy" return="Function">
+<entry type="method" name="jQuery.proxy" return="Function" deprecated="3.3">
<title>jQuery.proxy()</title>
<signature>
<added>1.4</added>
@@ -46,6 +46,9 @@
<desc>Takes a function and returns a new one that will always have a particular context.</desc>
<longdesc>
+ <div class="warning">
+ <p>Note: This API has been deprecated in jQuery 3.3; please use the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_objects/Function/bind"><code>Function.prototype.bind</code></a> method instead.</p>
+ </div>
<p>This method is most useful for attaching event handlers to an element where the context is pointing back to a different object. Additionally, jQuery makes sure that even if you bind the function returned from <code>jQuery.proxy()</code> it will still unbind the correct function if passed the original.</p>
<p>Be aware, however, that jQuery's event binding subsystem assigns a unique id to each event handling function in order to track it when it is used to specify the function to be unbound. The function represented by <code>jQuery.proxy()</code> is seen as a single function by the event subsystem, even when it is used to bind different contexts. To avoid unbinding the wrong handler, use a unique event namespace for binding and unbinding (e.g., <code>"click.myproxy1"</code>) rather than specifying the proxied function during unbinding.</p>
<p><strong>As of jQuery 1.6</strong>, any number of additional arguments may be supplied to <code>$.proxy()</code>, and they will be passed to the function whose context will be changed.</p>
@@ -170,4 +173,5 @@ $( "#test" )
<category slug="utilities"/>
<category slug="version/1.4"/>
<category slug="version/1.6"/>
+ <category slug="deprecated/deprecated-3.3"/>
</entry>
diff --git a/entries/jQuery.queue.xml b/entries/jQuery.queue.xml
index 3921e0206..16fa17531 100644
--- a/entries/jQuery.queue.xml
+++ b/entries/jQuery.queue.xml
@@ -19,7 +19,7 @@
<example>
<desc>Show the length of the queue.</desc>
<code><![CDATA[
-$( "#show" ).click(function() {
+$( "#show" ).on( "click", function() {
var n = jQuery.queue( $( "div" )[ 0 ], "fx" );
$( "span" ).text( "Queue length is: " + n.length );
});
@@ -70,7 +70,7 @@ runIt();
<category slug="utilities"/>
<category slug="version/1.3"/>
</entry>
- <entry type="method" name="jQuery.queue" return="jQuery">
+ <entry type="method" name="jQuery.queue" return="Array">
<signature>
<added>1.3</added>
<argument name="element" type="Element">
@@ -105,21 +105,21 @@ runIt();
<example>
<desc>Queue a custom function.</desc>
<code><![CDATA[
-$( document.body ).click(function() {
+$( document.body ).on( "click", function() {
var divs = $( "div" )
.show( "slow" )
.animate({ left: "+=200" }, 2000 );
jQuery.queue( divs[ 0 ], "fx", function() {
$( this ).addClass( "newcolor" );
jQuery.dequeue( this );
- });
+ } );
divs.animate({ left: "-=200" }, 500 );
jQuery.queue( divs[ 0 ], "fx", function() {
$( this ).removeClass( "newcolor" );
jQuery.dequeue( this );
- });
+ } );
divs.slideUp();
-});
+} );
]]></code>
<css><![CDATA[
div {
@@ -144,7 +144,7 @@ Click here...
<example>
<desc>Set a queue array to delete the queue.</desc>
<code><![CDATA[
-$( "#start" ).click(function() {
+$( "#start" ).on( "click", function() {
var divs = $( "div" )
.show( "slow" )
.animate({ left: "+=200" }, 5000 );
@@ -159,7 +159,7 @@ $( "#start" ).click(function() {
});
divs.slideUp();
});
-$( "#stop" ).click(function() {
+$( "#stop" ).on( "click", function() {
jQuery.queue( $( "div" )[ 0 ], "fx", [] );
$( "div" ).stop();
});
diff --git a/entries/jQuery.removeData.xml b/entries/jQuery.removeData.xml
index 8a85933bf..6a92a25f4 100644
--- a/entries/jQuery.removeData.xml
+++ b/entries/jQuery.removeData.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="method" name="jQuery.removeData" return="jQuery">
+<entry type="method" name="jQuery.removeData" return="undefined">
<title>jQuery.removeData()</title>
<signature>
<added>1.2.3</added>
@@ -19,13 +19,13 @@
<desc>Set a data store for 2 names then remove one of them.</desc>
<code><![CDATA[
var div = $( "div" )[ 0 ];
-$( "span:eq(0)" ).text( "" + $( "div" ).data( "test1" ) );
+$( "span" ).eq( 0 ).text( "" + $( "div" ).data( "test1" ) );
jQuery.data( div, "test1", "VALUE-1" );
jQuery.data( div, "test2", "VALUE-2" );
-$( "span:eq(1)" ).text( "" + jQuery.data( div, "test1" ) );
+$( "span" ).eq( 1 ).text( "" + jQuery.data( div, "test1" ) );
jQuery.removeData( div, "test1" );
-$( "span:eq(2)" ).text( "" + jQuery.data( div, "test1" ) );
-$( "span:eq(3)" ).text( "" + jQuery.data( div, "test2" ) );
+$( "span" ).eq( 2 ).text( "" + jQuery.data( div, "test1" ) );
+$( "span" ).eq( 3 ).text( "" + jQuery.data( div, "test2" ) );
]]></code>
<css><![CDATA[
div {
diff --git a/entries/jQuery.sub.xml b/entries/jQuery.sub.xml
index a52c9ab65..04cdfdb8d 100644
--- a/entries/jQuery.sub.xml
+++ b/entries/jQuery.sub.xml
@@ -6,9 +6,9 @@
</signature>
<desc>Creates a new copy of jQuery whose properties and methods can be modified without affecting the original jQuery object.</desc>
<longdesc>
- <p>
- <strong>This method is deprecated as of jQuery 1.7 and will be moved to a plugin in jQuery 1.8.</strong>
- </p>
+ <div class="warning">
+ <p>Note: This API has been removed in jQuery 1.9.</p>
+ </div>
<p>There are two specific use cases for which jQuery.sub() was created. The first was for providing a painless way of overriding jQuery methods without completely destroying the original methods and another was for helping to do encapsulation and basic namespacing for jQuery plugins.</p>
<p>Note that jQuery.sub() doesn't attempt to do any sort of isolation - that's not its intention. All the methods on the sub'd version of jQuery will still point to the original jQuery (events bound and triggered will still be through the main jQuery, data will be bound to elements through the main jQuery, Ajax queries and events will run through the main jQuery, etc.).</p>
<p>Note that if you're looking to use this for plugin development you should first <i>strongly</i> consider using something like the jQuery UI widget factory which manages both state and plugin sub-methods. <a href="http://blog.nemikor.com/2010/05/15/building-stateful-jquery-plugins/">Some examples of using the jQuery UI widget factory</a> to build a plugin.</p>
@@ -47,7 +47,7 @@ typeof jQuery( "body" ).myCustomMethod // undefined
};
myjQuery(function( $ ) {
- $( ".menu" ).click(function() {
+ $( ".menu" ).on( "click", function() {
$( this ).find( ".submenu" ).remove();
});
diff --git a/entries/jQuery.support.xml b/entries/jQuery.support.xml
index 636ec72eb..3252fd6ea 100644
--- a/entries/jQuery.support.xml
+++ b/entries/jQuery.support.xml
@@ -4,10 +4,15 @@
<signature>
<added>1.3</added>
</signature>
- <desc>A collection of properties that represent the presence of different browser features or bugs. Intended for jQuery's internal use; specific properties may be removed when they are no longer needed internally to improve page startup performance. For your own project's feature-detection needs, we strongly recommend the use of an external library such as <a href="https://modernizr.com">Modernizr</a> instead of dependency on properties in <code>jQuery.support</code>.</desc>
+ <desc>A collection of properties that represent the presence of different browser features or bugs; intended for jQuery's internal use.</desc>
+ <longdesc>
+ <p>A collection of properties that represent the presence of different browser features or bugs. Intended for jQuery's internal use; specific properties may be removed when they are no longer needed internally to improve page startup performance. For your own project's feature-detection needs, we strongly recommend the use of an external library such as <a href="https://modernizr.com">Modernizr</a> instead of dependency on properties in <code>jQuery.support</code>.</p>
+ <p>As of jQuery 1.11 or 1.12, <code>jQuery.support</code> is no longer JSON-serializable; some properties point to functions that return the support test result when called. This was necessary to support lazy execution of support tests.</p>
+ </longdesc>
<category slug="properties/global-jquery-object-properties"/>
<category slug="utilities"/>
<category slug="version/1.3"/>
<category slug="version/1.5.1"/>
+ <category slug="version/1.11-and-2.1"/>
<category slug="deprecated/deprecated-1.9"/>
</entry>
diff --git a/entries/jQuery.trim.xml b/entries/jQuery.trim.xml
index d0dcfa68e..cfc537b63 100644
--- a/entries/jQuery.trim.xml
+++ b/entries/jQuery.trim.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="method" name="jQuery.trim" return="String">
+<entry type="method" name="jQuery.trim" return="String" deprecated="3.5" removed="4.0">
<title>jQuery.trim()</title>
<signature>
<added>1.0</added>
@@ -9,6 +9,9 @@
</signature>
<desc>Remove the whitespace from the beginning and end of a string.</desc>
<longdesc>
+ <div class="warning">
+ <p>Note: This API has been deprecated in jQuery 3.5; please use the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trim"><code>String.prototype.trim</code></a> method instead. Unlike <code>jQuery.trim</code>, <code>String.prototype.trim</code> does not work with types other than strings (<code>null</code>, <code>undefined</code>, <code>Number</code>). Make sure that your code is compatible when migrating.</p>
+ </div>
<p>The <code>$.trim()</code> function removes all newlines, spaces (including non-breaking spaces), and tabs from the beginning and end of the supplied string. If these whitespace characters occur in the middle of the string, they are preserved.</p>
</longdesc>
<example>
@@ -34,4 +37,5 @@ $.trim(" hello, how are you? ");
</example>
<category slug="utilities"/>
<category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.5"/>
</entry>
diff --git a/entries/jQuery.type.xml b/entries/jQuery.type.xml
index 26dbe9130..4dd56897e 100644
--- a/entries/jQuery.type.xml
+++ b/entries/jQuery.type.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="method" name="jQuery.type" return="String">
+<entry type="method" name="jQuery.type" return="String" deprecated="3.3" removed="4.0">
<title>jQuery.type()</title>
<signature>
<added>1.4.3</added>
@@ -9,6 +9,9 @@
</signature>
<desc>Determine the internal JavaScript [[Class]] of an object.</desc>
<longdesc>
+ <div class="warning">
+ <p>Note: This API has been deprecated in jQuery 3.3.</p>
+ </div>
<p>A number of techniques are used to determine the exact return value for an object. The [[Class]] is determined as follows:</p>
<ul>
<li>If the object is undefined or null, then "undefined" or "null" is returned accordingly.
@@ -24,16 +27,16 @@
<li>jQuery.type( true ) === "boolean"</li>
<li>jQuery.type( new Boolean() ) === "boolean"</li>
<li>jQuery.type( 3 ) === "number"</li>
- <li>jQuery.type( new Number(3) ) === "number"</li>
+ <li>jQuery.type( new Number( 3 ) ) === "number"</li>
<li>jQuery.type( "test" ) === "string"</li>
- <li>jQuery.type( new String("test") ) === "string"</li>
- <li>jQuery.type( function(){} ) === "function"</li>
+ <li>jQuery.type( new String( "test" ) ) === "string"</li>
+ <li>jQuery.type( function() {} ) === "function"</li>
<li>jQuery.type( [] ) === "array"</li>
<li>jQuery.type( new Array() ) === "array"</li>
<li>jQuery.type( new Date() ) === "date"</li>
<li>jQuery.type( new Error() ) === "error" // <strong>as of jQuery 1.9</strong></li>
<li>jQuery.type( Symbol() ) === "symbol" // <strong>as of jQuery 1.9</strong></li>
- <li>jQuery.type( Object(Symbol()) ) === "symbol" // <strong>as of jQuery 1.12</strong></li>
+ <li>jQuery.type( Object( Symbol() ) ) === "symbol" // <strong>as of jQuery 1.12</strong></li>
<li>jQuery.type( /test/ ) === "regexp"</li>
</ul>
</li>
@@ -51,4 +54,5 @@ Is it a RegExp? <b></b>
</example>
<category slug="utilities"/>
<category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
</entry>
diff --git a/entries/jQuery.unique.xml b/entries/jQuery.unique.xml
index 56a8ced53..bac613345 100644
--- a/entries/jQuery.unique.xml
+++ b/entries/jQuery.unique.xml
@@ -9,7 +9,9 @@
</signature>
<desc>Sorts an array of DOM elements, in place, with the duplicates removed. Note that this only works on arrays of DOM elements, not strings or numbers.</desc>
<longdesc>
- <p><strong>As of jQuery 3.0, this method is deprecated and just an alias of <code><a href="/https/github.com/jQuery.uniqueSort/">jQuery.uniqueSort()</a></code>. Please use that method instead.</strong></p>
+ <div class="warning">
+ <p>As of jQuery 3.0, this method is deprecated and just an alias of <code><a href="/https/github.com/jQuery.uniqueSort/">jQuery.uniqueSort()</a></code>. Please use that method instead.</p>
+ </div>
<p>The <code>$.unique()</code> function searches through an array of objects, sorting the array, and removing any duplicate nodes. A node is considered a duplicate if it is the <em>exact same</em> node as one already in the array; two different nodes with identical attributes are not considered to be duplicates. This function only works on plain JavaScript arrays of DOM elements, and is chiefly used internally by jQuery. You probably will never need to use it.</p>
<p>As of jQuery 1.4 the results will always be returned in document order.</p>
</longdesc>
@@ -21,10 +23,10 @@ var divs = $( "div" ).get();
// Add 3 elements of class dup too (they are divs)
divs = divs.concat( $( ".dup" ).get() );
-$( "div:eq(1)" ).text( "Pre-unique there are " + divs.length + " elements." );
+$( "div" ).eq( 1 ).text( "Pre-unique there are " + divs.length + " elements." );
divs = jQuery.unique( divs );
-$( "div:eq(2)" ).text( "Post-unique there are " + divs.length + " elements." )
+$( "div" ).eq( 2 ).text( "Post-unique there are " + divs.length + " elements." )
.css( "color", "red" );
]]></code>
<css><![CDATA[
diff --git a/entries/jQuery.uniqueSort.xml b/entries/jQuery.uniqueSort.xml
index 88735af95..4cc086645 100644
--- a/entries/jQuery.uniqueSort.xml
+++ b/entries/jQuery.uniqueSort.xml
@@ -2,29 +2,29 @@
<entry type="method" name="jQuery.uniqueSort" return="Array">
<title>jQuery.uniqueSort()</title>
<signature>
- <added>1.12-2.2</added>
- <argument name="array" type="Array">
- <desc>The Array of DOM elements.</desc>
+ <added>1.12-and-2.2</added>
+ <argument name="array" type="ArrayLikeObject">
+ <desc>The Array or an Array-like object of DOM elements.</desc>
</argument>
</signature>
- <desc>Sorts an array of DOM elements, in place, with the duplicates removed. Note that this only works on arrays of DOM elements, not strings or numbers.</desc>
+ <desc>Sorts an array or an array-like object of DOM elements, in place, with the duplicates removed. Note that this only works on arrays/array-likes of DOM elements, not strings or numbers.</desc>
<longdesc>
- <p>The <code>$.uniqueSort()</code> function searches through an array of objects, sorting the array, and removing any duplicate nodes. A node is considered a duplicate if it is the <em>exact same</em> node as one already in the array; two different nodes with identical attributes are not considered to be duplicates. This function only works on plain JavaScript arrays of DOM elements, and is chiefly used internally by jQuery. You probably will never need to use it.</p>
+ <p>The <code>$.uniqueSort()</code> function searches through an array or an array-like object of DOM elements, sorting the array/array-like, and removing any duplicate nodes. A node is considered a duplicate if it is the <em>exact same</em> node as one already in the input; two different nodes with identical attributes are not considered to be duplicates. This function only works on plain JavaScript arrays/array-like objects of DOM elements, and is chiefly used internally by jQuery. You probably will never need to use it.</p>
<p>Prior to jQuery 3.0, this method was called <code><a href="/https/github.com/jQuery.unique/">jQuery.unique()</a></code>.</p>
<p>As of jQuery 1.4 the results will always be returned in document order.</p>
</longdesc>
<example>
<desc>Removes any duplicate elements from the array of divs.</desc>
<code><![CDATA[
-// unique() must take a native array
+// uniqueSort() must take a native array
var divs = $( "div" ).get();
// Add 3 elements of class dup too (they are divs)
divs = divs.concat( $( ".dup" ).get() );
-$( "div:eq(1)" ).text( "Pre-unique there are " + divs.length + " elements." );
+$( "div" ).eq( 1 ).text( "Pre-uniqueSort there are " + divs.length + " elements." );
divs = jQuery.uniqueSort( divs );
-$( "div:eq(2)" ).text( "Post-unique there are " + divs.length + " elements." )
+$( "div" ).eq( 2 ).text( "Post-uniqueSort there are " + divs.length + " elements." )
.css( "color", "red" );
]]></code>
<css><![CDATA[
@@ -42,5 +42,5 @@ $( "div:eq(2)" ).text( "Post-unique there are " + divs.length + " elements." )
]]></html>
</example>
<category slug="utilities"/>
- <category slug="version/1.12-2.2"/>
+ <category slug="version/1.12-and-2.2"/>
</entry>
diff --git a/entries/jQuery.xml b/entries/jQuery.xml
index a0ff76d18..8df77906f 100644
--- a/entries/jQuery.xml
+++ b/entries/jQuery.xml
@@ -11,7 +11,8 @@
<argument name="context" optional="true">
<type name="Element"/>
<type name="jQuery"/>
- <desc>A DOM Element, Document, or jQuery to use as context</desc>
+ <type name="Selector"/>
+ <desc>A DOM Element, Document, jQuery or selector to use as context</desc>
</argument>
</signature>
<signature>
@@ -49,7 +50,7 @@
<h4 id="selector-context">Selector Context</h4>
<p>By default, selectors perform their searches within the DOM starting at the document root. However, an alternate context can be given for the search by using the optional second parameter to the <code>$()</code> function. For example, to do a search within an event handler, the search can be restricted like so:</p>
<pre><code>
-$( "div.foo" ).click(function() {
+$( "div.foo" ).on( "click", function() {
$( "span", this ).addClass( "bar" );
});
</code></pre>
@@ -61,7 +62,7 @@ $( "div.foo" ).click(function() {
<p>Please note that although you can pass text nodes and comment nodes into a jQuery collection this way, most operations don't support them. The few that do will have an explicit note on their API documentation page.</p>
<p>A common use of single-DOM-element construction is to call jQuery methods on an element that has been passed to a callback function through the keyword <code>this</code>:</p>
<pre><code>
-$( "div.foo" ).click(function() {
+$( "div.foo" ).on( "click", function() {
$( this ).slideUp();
});
</code></pre>
@@ -77,7 +78,7 @@ $.post( "url.xml", function( data ) {
<p>When a jQuery object is passed to the <code>$()</code> function, a clone of the object is created. This new jQuery object references the same DOM elements as the initial one.</p>
<h4 id="returning-empty-set">Returning an Empty Set</h4>
- <p>As of jQuery 1.4, calling the <code>jQuery()</code> method with <em>no arguments</em> returns an empty jQuery set (with a <code><a href="/https/github.com/length/">.length</a></code> property of 0). In previous versions of jQuery, this would return a set containing the document node.</p>
+ <p>Calling the <code>jQuery()</code> method with <em>no arguments</em> returns an empty jQuery set (with a <code><a href="/https/github.com/length/">.length</a></code> property of 0). Similarly, if an argument of <code>null</code>, <code>undefined</code>, an empty array (<code>[]</code>), or an empty string (<code>""</code>) is passed, the set contains no elements.</p>
<h4 id="working-with-plain-objects">Working With Plain Objects</h4>
<p>At present, the only operations supported on plain JavaScript objects wrapped in jQuery are: <code>.data()</code>,<code>.prop()</code>,<code>.on()</code>, <code>.off()</code>, <code>.trigger()</code> and <code>.triggerHandler()</code>. The use of <code>.data()</code> (or any method requiring <code>.data()</code>) on a plain object will result in a new property on the object called jQuery{randomNumber} (eg. jQuery123456789).</p>
<pre><code>
@@ -155,7 +156,7 @@ $( myForm.elements ).hide();
<argument name="html" type="htmlString">
<desc>A string of HTML to create on the fly. Note that this parses HTML, <strong>not</strong> XML.</desc>
</argument>
- <argument name="ownerDocument" optional="true" type="document">
+ <argument name="ownerDocument" optional="true" type="Document">
<desc>A document in which the new elements will be created.</desc>
</argument>
</signature>
@@ -177,12 +178,12 @@ $( myForm.elements ).hide();
<p>By default, elements are created with an <code>.ownerDocument</code> matching the document into which the jQuery library was loaded. Elements being injected into a different document should be created using that document, e.g., <code>$("<p>hello iframe</p>", $("#myiframe").prop("contentWindow").document)</code>.</p>
<p>If the HTML is more complex than a single tag without attributes, as it is in the above example, the actual creation of the elements is handled by the browser's <code>.innerHTML</code> mechanism. In most cases, jQuery creates a new <code><div></code> element and sets the <code>innerHTML</code> property of the element to the HTML snippet that was passed in. When the parameter has a single tag (with optional closing tag or quick-closing) — <code>$( "<img />" )</code> or <code>$( "<img>" )</code>, <code>$( "<a></a>" )</code> or <code>$( "<a>" )</code> — jQuery creates the element using the native JavaScript <code>.createElement()</code> function.</p>
<p>When passing in complex HTML, some browsers may not generate a DOM that exactly replicates the HTML source provided. As mentioned, jQuery uses the browser's <code>.innerHTML</code> property to parse the passed HTML and insert it into the current document. During this process, some browsers filter out certain elements such as <code><html></code>, <code><title></code>, or <code><head></code> elements. As a result, the elements inserted may not be representative of the original string passed.</p>
- <p>Filtering isn't, however, limited to these tags. For example, Internet Explorer prior to version 8 will also convert all <code>href</code> properties on links to absolute URLs, and Internet Explorer prior to version 9 will not correctly handle HTML5 elements without the addition of a separate <a href="https://code.google.com/p/html5shiv/">compatibility layer</a>.</p>
+ <p>Filtering isn't, however, limited to these tags. For example, Internet Explorer prior to version 8 will also convert all <code>href</code> properties on links to absolute URLs, and Internet Explorer prior to version 9 will not correctly handle HTML5 elements without the addition of a separate <a href="https://github.com/afarkas/html5shiv">compatibility layer</a>.</p>
<p>To ensure cross-platform compatibility, the snippet must be well-formed. Tags that can contain other elements should be paired with a closing tag:</p>
<pre><code>$( "<a href='https://jquery.com'></a>" );</code></pre>
<p>Tags that cannot contain elements may be quick-closed or not:</p>
<pre><code>
-$( "<img>" );
+$( "<img />" );
$( "<input>" );
</code></pre>
<p>When passing HTML to <code>jQuery()</code>, note that text nodes are not treated as DOM elements. With the exception of a few methods (such as <code>.content()</code>), they are generally ignored or removed. E.g:</p>
diff --git a/entries/keydown-shorthand.xml b/entries/keydown-shorthand.xml
new file mode 100644
index 000000000..98b125b34
--- /dev/null
+++ b/entries/keydown-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="keydown" return="jQuery" deprecated="3.3">
+ <title>.keydown()</title>
+ <desc>Bind an event handler to the "keydown" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.keydown( handler )</code> or <code>.keydown( eventData, handler )</code>, use <a href="/https/github.com/keydown/#on1"><code>.on( "keydown", handler )</code></a> or <a href="/https/github.com/keydown/#on1"><code>.on( "keydown", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.keydown()</code>, use <a href="/https/github.com/keydown/#trigger2"><code>.trigger( "keydown" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/keyboard-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/keydown.xml b/entries/keydown.xml
index f21ae4e0f..576a1ad0c 100644
--- a/entries/keydown.xml
+++ b/entries/keydown.xml
@@ -1,15 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="keydown" return="jQuery">
- <title>.keydown()</title>
+<entries>
+<desc>Bind an event handler to the "keydown" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>keydown event</title>
+ <desc>Bind an event handler to the "keydown" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""keydown"" type="string">
+ <desc>The string <code>"keydown"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -18,12 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
- <desc>Bind an event handler to the "keydown" JavaScript event, or trigger that event on an element.</desc>
<longdesc>
- <p>This method is a shortcut for <code>.on( "keydown", handler )</code> in the first and second variations, and <code>.trigger( "keydown" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>keydown</code> event. For the deprecated <code>.keydown()</code> method, see <a href="/https/github.com/keydown-shorthand/"><code>.keydown()</code></a>.</p>
+ </div>
<p>The <code>keydown</code> event is sent to an element when the user presses a key on the keyboard. If the key is kept pressed, the event is sent every time the operating system repeats the key. It can be attached to any element, but the event is only sent to the element that has the focus. Focusable elements can vary between browsers, but form elements can always get focus so are reasonable candidates for this event type.</p>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -36,42 +34,41 @@
</code></pre>
<p>The event handler can be bound to the input field:</p>
<pre><code>
-$( "#target" ).keydown(function() {
- alert( "Handler for .keydown() called." );
-});
+$( "#target" ).on( "keydown", function() {
+ alert( "Handler for `keydown` called." );
+} );
</code></pre>
<p>Now when the insertion point is inside the field, pressing a key displays the alert:</p>
<p>
- <samp>Handler for .keydown() called.</samp>
+ <samp>Handler for `keydown` called.</samp>
</p>
- <p>To trigger the event manually, apply <code>.keydown()</code> without an argument:</p>
+ <p>To trigger the event manually, use <code>.trigger( "keydown" )</code>:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#target" ).keydown();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "keydown" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also alert the message.</p>
<p>If key presses anywhere need to be caught (for example, to implement global shortcut keys on a page), it is useful to attach this behavior to the <code>document</code> object. Because of event bubbling, all key presses will make their way up the DOM to the <code>document</code> object unless explicitly stopped.</p>
<p>To determine which key was pressed, examine the <a href="/https/github.com/category/events/event-object/">event object</a> that is passed to the handler function. While browsers use differing properties to store this information, jQuery normalizes the <code>.which</code> property so you can reliably use it to retrieve the key code. This code corresponds to a key on the keyboard, including codes for special keys such as arrows. For catching actual text entry, <code>.keypress()</code> may be a better choice.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="keydown"/>
<example>
<desc>Show the event object for the keydown handler when a key is pressed in the input.</desc>
<code><![CDATA[
var xTriggered = 0;
-$( "#target" ).keydown(function( event ) {
+$( "#target" ).on( "keydown", function( event ) {
if ( event.which == 13 ) {
event.preventDefault();
}
xTriggered++;
- var msg = "Handler for .keydown() called " + xTriggered + " time(s).";
+ var msg = "Handler for `keydown` called " + xTriggered + " time(s).";
$.print( msg, "html" );
$.print( event );
-});
+} );
-$( "#other" ).click(function() {
- $( "#target" ).keydown();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "keydown" );
+} );
]]></code>
<css><![CDATA[
fieldset {
@@ -107,5 +104,23 @@ $( "#other" ).click(function() {
</example>
<category slug="events/keyboard-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>keydown event</title>
+ <desc>Trigger the "keydown" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""keydown"" type="string">
+ <desc>The string <code>"keydown"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "keydown", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/keyboard-events"/>
+ <category slug="version/1.0"/>
+</entry>
+
+</entries>
diff --git a/entries/keypress-shorthand.xml b/entries/keypress-shorthand.xml
new file mode 100644
index 000000000..56a0d1d85
--- /dev/null
+++ b/entries/keypress-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="keypress" return="jQuery" deprecated="3.3">
+ <title>.keypress()</title>
+ <desc>Bind an event handler to the "keypress" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.keypress( handler )</code> or <code>.keypress( eventData, handler )</code>, use <a href="/https/github.com/keypress/#on1"><code>.on( "keypress", handler )</code></a> or <a href="/https/github.com/keypress/#on1"><code>.on( "keypress", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.keypress()</code>, use <a href="/https/github.com/keypress/#trigger2"><code>.trigger( "keypress" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/keyboard-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/keypress.xml b/entries/keypress.xml
index 0fd28cf3d..089765bfa 100644
--- a/entries/keypress.xml
+++ b/entries/keypress.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="keypress" return="jQuery">
- <title>.keypress()</title>
- <desc>Bind an event handler to the "keypress" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+<desc>Bind an event handler to the "keypress" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>keypress event</title>
+ <desc>Bind an event handler to the "keypress" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""keypress"" type="string">
+ <desc>The string <code>"keypress"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,12 +18,11 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
+ <div class="warning">
+ <p>This page describes the <code>keypress</code> event. For the deprecated <code>.keypress()</code> method, see <a href="/https/github.com/keypress-shorthand/"><code>.keypress()</code></a>.</p>
+ </div>
<p><strong>Note:</strong> as the <code>keypress</code> event isn't covered by any official specification, the actual behavior encountered when using it may differ across browsers, browser versions, and platforms.</p>
- <p>This method is a shortcut for <code>.on( "keypress", handler )</code> in the first two variations, and <code>.trigger( "keypress" )</code> in the third.</p>
<p>The <code>keypress</code> event is sent to an element when the browser registers keyboard input. This is similar to the <code>keydown</code> event, except that modifier and non-printing keys such as <kbd>Shift</kbd>, <kbd>Esc</kbd>, and <kbd>delete</kbd> trigger <code>keydown</code> events but not <code>keypress</code> events. Other differences between the two events may arise depending on platform and browser.</p>
<p>A <code>keypress</code> event handler can be attached to any element, but the event is only sent to the element that has the focus. Focusable elements can vary between browsers, but form controls can always get focus so are reasonable candidates for this event type.</p>
<p>For example, consider the HTML:</p>
@@ -40,43 +38,42 @@
</code></pre>
<p>The event handler can be bound to the input field:</p>
<pre><code>
-$( "#target" ).keypress(function() {
- console.log( "Handler for .keypress() called." );
-});
+$( "#target" ).on( "keypress", function() {
+ console.log( "Handler for `keypress` called." );
+} );
</code></pre>
<p>Now when the insertion point is inside the field, pressing a key displays the log:</p>
<p>
- <samp>Handler for .keypress() called.</samp>
+ <samp>Handler for `keypress` called.</samp>
</p>
- <p>To trigger the event manually, apply <code>.keypress()</code> without an argument:</p>
+ <p>To trigger the event manually, use <code>.trigger( "keypress" )</code>:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#target" ).keypress();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "keypress" );
+} );
</code></pre>
<p>After this code executes, clicks on the <samp>Trigger the handler</samp> div will also log the message.</p>
<p>If key presses anywhere need to be caught (for example, to implement global shortcut keys on a page), it is useful to attach this behavior to the <code>document</code> object. Because of event bubbling, all key presses will make their way up the DOM to the <code>document</code> object unless explicitly stopped.</p>
<p>To determine which character was entered, examine the <code>event</code> object that is passed to the handler function. While browsers use differing properties to store this information, jQuery normalizes the <code>.which</code> property so you can reliably use it to retrieve the character code.</p>
<p>Note that <code>keydown</code> and <code>keyup</code> provide a code indicating which key is pressed, while <code>keypress</code> indicates which character was entered. For example, a lowercase "a" will be reported as 65 by <code>keydown</code> and <code>keyup</code>, but as 97 by <code>keypress</code>. An uppercase "A" is reported as 65 by all events. Because of this distinction, when catching special keystrokes such as arrow keys, <code>.keydown()</code> or <code>.keyup()</code> is a better choice.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="keypress"/>
<example>
<desc>Show the event object when a key is pressed in the input. Note: This demo relies on a simple $.print() plugin (https://api.jquery.com/resources/events.js) for the event object's output.</desc>
<code><![CDATA[
var xTriggered = 0;
-$( "#target" ).keypress(function( event ) {
+$( "#target" ).on( "keypress", function( event ) {
if ( event.which == 13 ) {
event.preventDefault();
}
xTriggered++;
- var msg = "Handler for .keypress() called " + xTriggered + " time(s).";
+ var msg = "Handler for `keypress` called " + xTriggered + " time(s).";
$.print( msg, "html" );
$.print( event );
-});
+} );
-$( "#other" ).click(function() {
- $( "#target" ).keypress();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "keypress" );
+} );
]]></code>
<css><![CDATA[
fieldset {
@@ -112,5 +109,23 @@ $( "#other" ).click(function() {
</example>
<category slug="events/keyboard-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>keypress event</title>
+ <desc>Trigger the "keypress" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""keypress"" type="string">
+ <desc>The string <code>"keypress"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "keypress", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/keyboard-events"/>
+ <category slug="version/1.0"/>
+</entry>
+
+</entries>
diff --git a/entries/keyup-shorthand.xml b/entries/keyup-shorthand.xml
new file mode 100644
index 000000000..965dbeb84
--- /dev/null
+++ b/entries/keyup-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="keyup" return="jQuery" deprecated="3.3">
+ <title>.keyup()</title>
+ <desc>Bind an event handler to the "keyup" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.keyup( handler )</code> or <code>.keyup( eventData, handler )</code>, use <a href="/https/github.com/keyup/#on1"><code>.on( "keyup", handler )</code></a> or <a href="/https/github.com/keyup/#on1"><code>.on( "keyup", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.keyup()</code>, use <a href="/https/github.com/keyup/#trigger2"><code>.trigger( "keyup" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/keyboard-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/keyup.xml b/entries/keyup.xml
index 91193b538..b0d6399f4 100644
--- a/entries/keyup.xml
+++ b/entries/keyup.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="keyup" return="jQuery">
- <title>.keyup()</title>
- <desc>Bind an event handler to the "keyup" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+<desc>Bind an event handler to the "keyup" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>keyup event</title>
+ <desc>Bind an event handler to the "keyup" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""keyup"" type="string">
+ <desc>The string <code>"keyup"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "keyup", handler )</code> in the first two variations, and <code>.trigger( "keyup" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>keyup</code> event. For the deprecated <code>.keyup()</code> method, see <a href="/https/github.com/keyup-shorthand/"><code>.keyup()</code></a>.</p>
+ </div>
<p>The <code>keyup</code> event is sent to an element when the user releases a key on the keyboard. It can be attached to any element, but the event is only sent to the element that has the focus. Focusable elements can vary between browsers, but form elements can always get focus so are reasonable candidates for this event type.</p>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -36,43 +34,42 @@
</code></pre>
<p>The event handler can be bound to the input field:</p>
<pre><code>
-$( "#target" ).keyup(function() {
- alert( "Handler for .keyup() called." );
-});
+$( "#target" ).on( "keyup", function() {
+ alert( "Handler for `keyup` called." );
+} );
</code></pre>
<p>Now when the insertion point is inside the field and a key is pressed and released, the alert is displayed:</p>
<p>
- <samp>Handler for .keyup() called.</samp>
+ <samp>Handler for `keyup` called.</samp>
</p>
- <p>To trigger the event manually, apply <code>.keyup()</code> without arguments:</p>
+ <p>To trigger the event manually, use <code>.trigger( "keyup" )</code>:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#target" ).keyup();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "keyup" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also alert the message.</p>
<p>If key presses anywhere need to be caught (for example, to implement global shortcut keys on a page), it is useful to attach this behavior to the <code>document</code> object. Because of event bubbling, all key presses will make their way up the DOM to the <code>document</code> object unless explicitly stopped.</p>
<p>To determine which key was pressed, examine the event object that is passed to the handler function. While browsers use differing properties to store this information, jQuery normalizes the <code>.which</code> property so you can reliably use it to retrieve the key code. This code corresponds to a key on the keyboard, including codes for special keys such as arrows. For catching actual text entry, <code>.keypress()</code> may be a better choice.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="keyup"/>
<example>
<desc>Show the event object for the keyup handler (using a simple $.print plugin) when a key is released in the input.</desc>
<code><![CDATA[
var xTriggered = 0;
-$( "#target" ).keyup(function( event ) {
+$( "#target" ).on( "keyup", function( event ) {
xTriggered++;
- var msg = "Handler for .keyup() called " + xTriggered + " time(s).";
+ var msg = "Handler for `keyup` called " + xTriggered + " time(s).";
$.print( msg, "html" );
$.print( event );
-}).keydown(function( event ) {
+} ).on( "keydown", function( event ) {
if ( event.which == 13 ) {
event.preventDefault();
}
-});
+} );
-$( "#other").click(function() {
- $( "#target" ).keyup();
-});
+$( "#other").on( "click", function() {
+ $( "#target" ).trigger( "keyup" );
+} );
]]></code>
<css><![CDATA[
fieldset {
@@ -108,5 +105,23 @@ $( "#other").click(function() {
</example>
<category slug="events/keyboard-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>keyup event</title>
+ <desc>Trigger the "keyup" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""keyup"" type="string">
+ <desc>The string <code>"keyup"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "keyup", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/keyboard-events"/>
+ <category slug="version/1.0"/>
+</entry>
+
+</entries>
diff --git a/entries/last-child-selector.xml b/entries/last-child-selector.xml
index 8e5d81e35..06d8e61b1 100644
--- a/entries/last-child-selector.xml
+++ b/entries/last-child-selector.xml
@@ -7,7 +7,7 @@
</signature>
<desc>Selects all elements that are the last child of their parent.</desc>
<longdesc>
- <p>While <a href="/https/github.com/last-selector/">:last</a> matches only a single element, <code>:last-child</code> can match more than one: one for each parent.</p>
+ <p>While <a href="/https/github.com/last/"><code>.last()</code></a> matches only a single element, <code>:last-child</code> can match more than one: one for each parent.</p>
</longdesc>
<example>
<desc>Find the last span in each matched div and add some css plus a hover state.</desc>
diff --git a/entries/last-selector.xml b/entries/last-selector.xml
index 2cbd886f5..128eec49c 100644
--- a/entries/last-selector.xml
+++ b/entries/last-selector.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="selector" name="last" return="">
+<entry type="selector" name="last" return="" deprecated="3.4">
<title>:last Selector</title>
<sample>:last</sample>
<signature>
@@ -7,13 +7,16 @@
</signature>
<desc>Selects the last matched element.</desc>
<longdesc>
+ <div class="warning">
+ <p><strong>As of jQuery 3.4</strong>, the <code>:last</code> pseudo-class is deprecated. Remove it from your selectors and filter the results later using <a href="/https/github.com/last/"><code>.last()</code></a>.</p>
+ </div>
<p>Note that <code>:last</code> selects a single element by filtering the current jQuery collection and matching the last element within it.</p>
</longdesc>
<note id="jquery-selector-extension" type="additional" data-selector=":last"/>
<example>
<desc>Finds the last table row.</desc>
<code><![CDATA[
-$( "tr:last" ).css({ backgroundColor: "yellow", fontWeight: "bolder" });
+$( "tr" ).last().css({ backgroundColor: "yellow", fontWeight: "bolder" });
]]></code>
<html><![CDATA[
<table>
@@ -26,4 +29,5 @@ $( "tr:last" ).css({ backgroundColor: "yellow", fontWeight: "bolder" });
<category slug="selectors/basic-filter-selectors"/>
<category slug="selectors/jquery-selector-extensions"/>
<category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.4"/>
</entry>
diff --git a/entries/last.xml b/entries/last.xml
index 4f9b59df4..73ddafa5d 100644
--- a/entries/last.xml
+++ b/entries/last.xml
@@ -24,17 +24,22 @@ $( "li" ).last().css( "background-color", "red" );
<p>The result of this call is a red background for the final item.</p>
</longdesc>
<example>
- <desc>Highlight the last span in a paragraph.</desc>
+ <desc>Highlight the last item in a list.</desc>
<css><![CDATA[
.highlight {
background-color: yellow;
}
]]></css>
<code><![CDATA[
-$( "p span" ).last().addClass( "highlight" );
+$( "ul li" ).last().addClass( "highlight" );
]]></code>
<html><![CDATA[
-<p><span>Look:</span> <span>This is some text in a paragraph.</span> <span>This is a note about it.</span></p>
+<ul>
+ <li>Look:</li>
+ <li>This is some text in a list.</li>
+ <li>This is a note about it.</li>
+ <li>This is another note about it.</li>
+</ul>
]]></html>
</example>
<category slug="traversing/filtering"/>
diff --git a/entries/length.xml b/entries/length.xml
index 105f23d84..37a2d54cf 100644
--- a/entries/length.xml
+++ b/entries/length.xml
@@ -12,12 +12,12 @@
<desc>Count the divs. Click to add more.</desc>
<code><![CDATA[
$( document.body )
- .click(function() {
+ .on( "click", function() {
$( document.body ).append( $( "<div>" ) );
var n = $( "div" ).length;
$( "span" ).text( "There are " + n + " divs." +
"Click to add more.");
- })
+ } )
// Trigger the click to start
.trigger( "click" );
]]></code>
diff --git a/entries/live.xml b/entries/live.xml
index 049322e27..0943af956 100644
--- a/entries/live.xml
+++ b/entries/live.xml
@@ -32,7 +32,9 @@
</argument>
</signature>
<longdesc>
- <p><strong>As of jQuery 1.7</strong>, the <code>.live()</code> method is deprecated. Use <a href="/https/github.com/on/"><code>.on()</code></a> to attach event handlers. Users of older versions of jQuery should use <a href="/https/github.com/delegate/"><code>.delegate()</code></a> in preference to <code>.live()</code>.</p>
+ <div class="warning">
+ <p>Note: This API has been removed in jQuery 1.9; please use <a href="/https/github.com/on/"><code>on()</code></a> instead.</p>
+ </div>
<p>This method provides a means to attach delegated event handlers to the <code>document</code> element of a page, which simplifies the use of event handlers when content is dynamically added to a page. See the discussion of direct versus delegated events in the <a href="/https/github.com/on/"><code>.on()</code></a> method for more information. </p>
<p>Rewriting the <code>.live()</code> method in terms of its successors is straightforward; these are templates for equivalent calls for all three event attachment methods:</p>
<pre><code>
@@ -102,7 +104,7 @@ $( "p" ).live( "myCustomEvent", function( event, myName, myValue ) {
.fadeIn( 30 )
.fadeOut( 1000 );
});
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "p" ).trigger( "myCustomEvent" );
});
]]></code>
diff --git a/entries/load-event.xml b/entries/load-event.xml
index e3739cb71..f7dbc65a7 100644
--- a/entries/load-event.xml
+++ b/entries/load-event.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="load" return="jQuery" deprecated="1.8" removed="3.0">
- <title>.load()</title>
- <desc>Bind an event handler to the "load" JavaScript event.</desc>
+<entries>
+<desc>Bind an event handler to the "load" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>load event</title>
+ <desc>Bind an event handler to the "load" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute when the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""load"" type="string">
+ <desc>The string <code>"load"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -20,7 +19,9 @@
</argument>
</signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "load", handler )</code>.</p>
+ <div class="warning">
+ <p>This page describes the <code>load</code> event. For the <code>.load()</code> method removed in jQuery 3.0, see <a href="/https/github.com/load-shorthand/"><code>.load()</code></a>.</p>
+ </div>
<p>The <code>load</code> event is sent to an element when it and all sub-elements have been completely loaded. This event can be sent to any element associated with a URL: images, scripts, frames, iframes, and the <code>window</code> object.</p>
<p>For example, consider a page with a simple image:</p>
<pre><code>
@@ -28,20 +29,17 @@
</code></pre>
<p>The event handler can be bound to the image:</p>
<pre><code>
-$( "#book" ).load(function() {
- // Handler for .load() called.
-});
+$( "#book" ).on( "load", function() {
+ // Handler for `load` called.
+} );
</code></pre>
<p>As soon as the image has been loaded, the handler is called.</p>
<p>In general, it is not necessary to wait for all images to be fully loaded. If code can be executed earlier, it is usually best to place it in a handler sent to the <code>.ready()</code> method.
</p>
- <div class="warning">
- <p>The Ajax module also has a method named <code><a href="/https/github.com/load/">.load()</a></code>. Which one is fired depends on the set of arguments passed.</p>
- </div>
<div class="warning">
<p>
<b>Caveats of the <code>load</code> event when used with images</b>
- <p>A common challenge developers attempt to solve using the <code>.load()</code> shortcut is to execute a function when an image (or collection of images) have completely loaded. There are several known caveats with this that should be noted. These are:</p>
+ <p>A common challenge developers attempt to solve using the <code>load</code> shortcut is to execute a function when an image (or collection of images) have completely loaded. There are several known caveats with this that should be noted. These are:</p>
<ul>
<li>It doesn't work consistently nor reliably cross-browser</li>
<li>It doesn't fire correctly in WebKit if the image src is set to the same src as before</li>
@@ -57,24 +55,40 @@ $( "#book" ).load(function() {
<example>
<desc>Run a function when the page is fully loaded including graphics.</desc>
<code><![CDATA[
-$( window ).load(function() {
+$( window ).on( "load", function() {
// Run code
-});
+} );
]]></code>
</example>
<example>
<desc>Add the class bigImg to all images with height greater than 100 upon each image load.</desc>
<code><![CDATA[
-$( "img.userIcon" ).load(function() {
+$( "img.userIcon" ).on( "load", function() {
if ( $( this ).height() > 100) {
$( this ).addClass( "bigImg" );
}
-});
+} );
]]></code>
</example>
<category slug="events/document-loading"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
- <category slug="deprecated/deprecated-1.8"/>
- <category slug="removed"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>load event</title>
+ <desc>Trigger the "load" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""load"" type="string">
+ <desc>The string <code>"load"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "load", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/document-loading"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/load-shorthand.xml b/entries/load-shorthand.xml
new file mode 100644
index 000000000..1c5873cb0
--- /dev/null
+++ b/entries/load-shorthand.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0"?>
+<entry type="method" name="load" return="jQuery" deprecated="1.8" removed="3.0">
+ <title>.load()</title>
+ <desc>Bind an event handler to the "load" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API has been removed in jQuery 3.0.</p>
+ <p>Instead of <code>.load( handler )</code> or <code>.load( eventData, handler )</code>, use <a href="/https/github.com/load-event/#on1"><code>.on( "load", handler )</code></a> or <a href="/https/github.com/load-event/#on1"><code>.on( "load", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.load()</code>, use <a href="/https/github.com/load-event/#trigger2"><code>.trigger( "load" )</code></a>.</p>
+ </div>
+ <div class="warning">
+ <p>The Ajax module also has a method named <code><a href="/https/github.com/load/">.load()</a></code>. Which one is fired depends on the set of arguments passed.</p>
+ </div>
+ </longdesc>
+ <category slug="events/document-loading"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-1.8"/>
+ <category slug="removed"/>
+</entry>
diff --git a/entries/lt-selector.xml b/entries/lt-selector.xml
index b85b5f777..703c427f1 100644
--- a/entries/lt-selector.xml
+++ b/entries/lt-selector.xml
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry type="selector" name="lt" return="">
+<entry type="selector" name="lt" return="" deprecated="3.4">
<title>:lt() Selector</title>
<signature>
<sample>:lt(index)</sample>
@@ -17,6 +17,9 @@
</signature>
<desc>Select all elements at an index less than <code>index</code> within the matched set.</desc>
<longdesc>
+ <div class="warning">
+ <p><strong>As of jQuery 3.4</strong>, the <code>:lt</code> pseudo-class is deprecated. Remove it from your selectors and filter the results later using <a href="/https/github.com/slice/"><code>.slice()</code></a>. For example, <code>:lt(3)</code> can be replaced with a call to <code>.slice( 0, 3 )</code>.</p>
+ </div>
<p>
<strong>index-related selectors</strong>
</p>
@@ -42,4 +45,5 @@ $( "td:lt(-2)" ).css( "color", "red" );
<category slug="selectors/basic-filter-selectors"/>
<category slug="selectors/jquery-selector-extensions"/>
<category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.4"/>
</entry>
diff --git a/entries/map.xml b/entries/map.xml
index c151e8313..101fa001b 100644
--- a/entries/map.xml
+++ b/entries/map.xml
@@ -135,9 +135,9 @@ $.fn.equalizeHeights = function() {
return this.height( Math.max.apply( this, maxHeight ) );
};
-$( "input" ).click(function() {
+$( "input" ).on( "click", function() {
$( "div" ).equalizeHeights();
-});
+} );
]]></code>
<css><![CDATA[
div {
diff --git a/entries/mousedown-shorthand.xml b/entries/mousedown-shorthand.xml
new file mode 100644
index 000000000..d5de95b1b
--- /dev/null
+++ b/entries/mousedown-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="mousedown" return="jQuery" deprecated="3.3">
+ <title>.mousedown()</title>
+ <desc>Bind an event handler to the "mousedown" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.mousedown( handler )</code> or <code>.mousedown( eventData, handler )</code>, use <a href="/https/github.com/mousedown/#on1"><code>.on( "mousedown", handler )</code></a> or <a href="/https/github.com/mousedown/#on1"><code>.on( "mousedown", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.mousedown()</code>, use <a href="/https/github.com/mousedown/#trigger2"><code>.trigger( "mousedown" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/mousedown.xml b/entries/mousedown.xml
index ea8d9a0e9..5ce0e273d 100644
--- a/entries/mousedown.xml
+++ b/entries/mousedown.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="mousedown" return="jQuery">
- <title>.mousedown()</title>
- <desc>Bind an event handler to the "mousedown" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+<desc>Bind an event handler to the "mousedown" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>mousedown event</title>
+ <desc>Bind an event handler to the "mousedown" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""mousedown"" type="string">
+ <desc>The string <code>"mousedown"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "mousedown", handler)</code> in the first variation, and <code>.trigger( "mousedown" )</code> in the second.</p>
+ <div class="warning">
+ <p>This page describes the <code>mousedown</code> event. For the deprecated <code>.mousedown()</code> method, see <a href="/https/github.com/mousedown-shorthand/"><code>.mousedown()</code></a>.</p>
+ </div>
<p>The <code>mousedown</code> event is sent to an element when the mouse pointer is over the element, and the mouse button is pressed. Any HTML element can receive this event.</p>
<p>For example, consider the HTML:</p>
<pre><code><div id="target">
@@ -39,36 +37,35 @@
</figure>
<p>The event handler can be bound to any <code><div></code>:</p>
<pre><code>
-$( "#target" ).mousedown(function() {
- alert( "Handler for .mousedown() called." );
-});
+$( "#target" ).on( "mousedown", function() {
+ alert( "Handler for `mousedown` called." );
+} );
</code></pre>
<p>Now if we click on this element, the alert is displayed:</p>
<p>
- <samp>Handler for .mousedown() called.</samp>
+ <samp>Handler for `mousedown` called.</samp>
</p>
<p>We can also trigger the event when a different element is clicked:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#target" ).mousedown();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "mousedown" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also alert the message.</p>
<p>The <code>mousedown</code> event is sent when any mouse button is clicked. To act only on specific buttons, we can use the event object's <code>which</code> property. Not all browsers support this property (Internet Explorer uses button instead), but jQuery normalizes the property so that it is safe to use in any browser. The value of <code>which</code> will be 1 for the left button, 2 for the middle button, or 3 for the right button.</p>
<p>This event is primarily useful for ensuring that the primary button was used to begin a drag operation; if ignored, strange results can occur when the user attempts to use a context menu. While the middle and right buttons can be detected with these properties, this is not reliable. In Opera and Safari, for example, right mouse button clicks are not detectable by default.</p>
<p>If the user clicks on an element, drags away from it, and releases the button, this is still counted as a <code>mousedown</code> event. This sequence of actions is treated as a "canceling" of the button press in most user interfaces, so it is usually better to use the <code>click</code> event unless we know that the <code>mousedown</code> event is preferable for a particular situation.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="mousedown"/>
<example>
<desc>Show texts when mouseup and mousedown event triggering.</desc>
<code><![CDATA[
$( "p" )
- .mouseup(function() {
+ .on( "mouseup", function() {
$( this ).append( "<span style='color:#f00;'>Mouse up.</span>" );
- })
- .mousedown(function() {
+ } )
+ .on( "mousedown", function() {
$( this ).append( "<span style='color:#00f;'>Mouse down.</span>" );
- });
+ } );
]]></code>
<html><![CDATA[
<p>Press mouse and release here.</p>
@@ -76,5 +73,23 @@ $( "p" )
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>mousedown event</title>
+ <desc>Trigger the "mousedown" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""mousedown"" type="string">
+ <desc>The string <code>"mousedown"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "mousedown", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/mouseenter-shorthand.xml b/entries/mouseenter-shorthand.xml
new file mode 100644
index 000000000..49b2285a3
--- /dev/null
+++ b/entries/mouseenter-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="mouseenter" return="jQuery" deprecated="3.3">
+ <title>.mouseenter()</title>
+ <desc>Bind an event handler to the "mouseenter" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.mouseenter( handler )</code> or <code>.mouseenter( eventData, handler )</code>, use <a href="/https/github.com/mouseenter/#on1"><code>.on( "mouseenter", handler )</code></a> or <a href="/https/github.com/mouseenter/#on1"><code>.on( "mouseenter", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.mouseenter()</code>, use <a href="/https/github.com/mouseenter/#trigger2"><code>.trigger( "mouseenter" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/mouseenter.xml b/entries/mouseenter.xml
index f9c396973..d22329266 100644
--- a/entries/mouseenter.xml
+++ b/entries/mouseenter.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="mouseenter" return="jQuery">
- <title>.mouseenter()</title>
- <desc>Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element.</desc>
+<entries>
+<desc>Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>mouseenter event</title>
+ <desc>Bind an event handler to be fired when the mouse enters an element.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""mouseenter"" type="string">
+ <desc>The string <code>"mouseenter"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "mouseenter", handler )</code> in the first two variations, and <code>.trigger( "mouseenter" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>mouseenter</code> event. For the deprecated <code>.mouseenter()</code> method, see <a href="/https/github.com/mouseenter-shorthand/"><code>.mouseenter()</code></a>.</p>
+ </div>
<p>The <code>mouseenter</code> JavaScript event is proprietary to Internet Explorer. Because of the event's general utility, jQuery simulates this event so that it can be used regardless of browser. This event is sent to an element when the mouse pointer enters the element. Any HTML element can receive this event.</p>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -43,20 +41,19 @@
</figure>
<p>The event handler can be bound to any element:</p>
<pre><code>
-$( "#outer" ).mouseenter(function() {
- $( "#log" ).append( "<div>Handler for .mouseenter() called.</div>" );
-});
+$( "#outer" ).on( "mouseenter", function() {
+ $( "#log" ).append( "<div>Handler for `mouseenter` called.</div>" );
+} );
</code></pre>
<p>Now when the mouse pointer moves over the <samp>Outer</samp> <code><div></code>, the message is appended to <code><div id="log"></code>. You can also trigger the event when another element is clicked:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#outer" ).mouseenter();
-});
+$( "#other" ).on( "click", function() {
+ $( "#outer" ).trigger( "mouseenter" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also append the message.</p>
<p>The <code>mouseenter</code> event differs from <code>mouseover</code> in the way it handles event bubbling. If <code>mouseover</code> were used in this example, then when the mouse pointer moved over the <samp>Inner</samp> element, the handler would be triggered. This is usually undesirable behavior. The <code>mouseenter</code> event, on the other hand, only triggers its handler when the mouse enters the element it is bound to, not a descendant. So in this example, the handler is triggered when the mouse enters the <samp>Outer</samp> element, but not the <samp>Inner</samp> element.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="mouseenter"/>
<example>
<desc>Show texts when mouseenter and mouseout event triggering.
<code>mouseover</code> fires when the pointer moves into the child element as well, while <code>mouseenter</code> fires only when the pointer moves into the bound element.</desc>
@@ -83,23 +80,23 @@ $( "#other" ).click(function() {
<code><![CDATA[
var i = 0;
$( "div.overout" )
- .mouseover(function() {
- $( "p:first", this ).text( "mouse over" );
- $( "p:last", this ).text( ++i );
- })
- .mouseout(function() {
- $( "p:first", this ).text( "mouse out" );
- });
+ .on( "mouseover", function() {
+ $( "p", this ).first().text( "mouse over" );
+ $( "p", this ).last().text( ++i );
+ } )
+ .on( "mouseout", function() {
+ $( "p", this ).first().text( "mouse out" );
+ } );
var n = 0;
$( "div.enterleave" )
- .mouseenter(function() {
- $( "p:first", this ).text( "mouse enter" );
- $( "p:last", this ).text( ++n );
- })
- .mouseleave(function() {
- $( "p:first", this ).text( "mouse leave" );
- });
+ .on( "mouseenter", function() {
+ $( "p", this ).first().text( "mouse enter" );
+ $( "p", this ).last().text( ++n );
+ } )
+ .on( "mouseleave", function() {
+ $( "p", this ).first().text( "mouse leave" );
+ } );
]]></code>
<html><![CDATA[
<div class="out overout">
@@ -117,5 +114,23 @@ $( "div.enterleave" )
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>mouseenter event</title>
+ <desc>Trigger the "mouseenter" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""mouseenter"" type="string">
+ <desc>The string <code>"mouseenter"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "mouseenter", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+</entry>
+
+</entries>
diff --git a/entries/mouseleave-shorthand.xml b/entries/mouseleave-shorthand.xml
new file mode 100644
index 000000000..9ff235eb8
--- /dev/null
+++ b/entries/mouseleave-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="mouseleave" return="jQuery" deprecated="3.3">
+ <title>.mouseleave()</title>
+ <desc>Bind an event handler to the "mouseleave" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.mouseleave( handler )</code> or <code>.mouseleave( eventData, handler )</code>, use <a href="/https/github.com/mouseleave/#on1"><code>.on( "mouseleave", handler )</code></a> or <a href="/https/github.com/mouseleave/#on1"><code>.on( "mouseleave", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.mouseleave()</code>, use <a href="/https/github.com/mouseleave/#trigger2"><code>.trigger( "mouseleave" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/mouseleave.xml b/entries/mouseleave.xml
index edb8fa441..98c1ff971 100644
--- a/entries/mouseleave.xml
+++ b/entries/mouseleave.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="mouseleave" return="jQuery">
- <title>.mouseleave()</title>
- <desc>Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element.</desc>
+<entries>
+<desc>Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>mouseleave event</title>
+ <desc>Bind an event handler to be fired when the mouse leaves an element.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""mouseleave"" type="string">
+ <desc>The string <code>"mouseleave"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on('mouseleave', handler)</code> in the first two variations, and <code>.trigger('mouseleave')</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>mouseleave</code> event. For the deprecated <code>.mouseleave()</code> method, see <a href="/https/github.com/mouseleave-shorthand/"><code>.mouseleave()</code></a>.</p>
+ </div>
<p>The <code>mouseleave</code> JavaScript event is proprietary to Internet Explorer. Because of the event's general utility, jQuery simulates this event so that it can be used regardless of browser. This event is sent to an element when the mouse pointer leaves the element. Any HTML element can receive this event.</p>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -43,20 +41,19 @@
</figure>
<p>The event handler can be bound to any element:</p>
<pre><code>
-$( "#outer" ).mouseleave(function() {
- $( "#log" ).append( "<div>Handler for .mouseleave() called.</div>" );
-});
+$( "#outer" ).on( "mouseleave", function() {
+ $( "#log" ).append( "<div>Handler for `mouseleave` called.</div>" );
+} );
</code></pre>
<p>Now when the mouse pointer moves out of the <samp>Outer</samp> <code><div></code>, the message is appended to <code><div id="log"></code>. You can also trigger the event when another element is clicked:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#outer" ).mouseleave();
-});
+$( "#other" ).on( "click", function() {
+ $( "#outer" ).trigger( "mouseleave" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also append the message.</p>
<p>The <code>mouseleave</code> event differs from <code>mouseout</code> in the way it handles event bubbling. If <code>mouseout</code> were used in this example, then when the mouse pointer moved out of the <samp>Inner</samp> element, the handler would be triggered. This is usually undesirable behavior. The <code>mouseleave</code> event, on the other hand, only triggers its handler when the mouse leaves the element it is bound to, not a descendant. So in this example, the handler is triggered when the mouse leaves the <samp>Outer</samp> element, but not the <samp>Inner</samp> element.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="mouseleave"/>
<example>
<desc>Show number of times mouseout and mouseleave events are triggered. <code>mouseout</code> fires when the pointer moves out of child element as well, while <code>mouseleave</code> fires only when the pointer moves out of the bound element.</desc>
<css><![CDATA[
@@ -82,23 +79,23 @@ $( "#other" ).click(function() {
<code><![CDATA[
var i = 0;
$( "div.overout" )
- .mouseover(function() {
- $( "p:first", this ).text( "mouse over" );
- })
- .mouseout(function() {
- $( "p:first", this ).text( "mouse out" );
- $( "p:last", this ).text( ++i );
- });
+ .on( "mouseover", function() {
+ $( "p", this ).first().text( "mouse over" );
+ } )
+ .on( "mouseout", function() {
+ $( "p", this ).first().text( "mouse out" );
+ $( "p", this ).last().text( ++i );
+ } );
var n = 0;
$( "div.enterleave" )
- .mouseenter(function() {
- $( "p:first", this ).text( "mouse enter" );
- })
- .mouseleave(function() {
- $( "p:first", this ).text( "mouse leave" );
- $( "p:last", this ).text( ++n );
- });
+ .on( "mouseenter", function() {
+ $( "p", this ).first().text( "mouse enter" );
+ } )
+ .on( "mouseleave", function() {
+ $( "p", this ).first().text( "mouse leave" );
+ $( "p", this ).last().text( ++n );
+ } );
]]></code>
<html><![CDATA[
<div class="out overout">
@@ -115,5 +112,23 @@ $( "div.enterleave" )
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>mouseleave event</title>
+ <desc>Trigger the "mouseleave" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""mouseleave"" type="string">
+ <desc>The string <code>"mouseleave"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "mouseleave", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+</entry>
+
+</entries>
diff --git a/entries/mousemove-shorthand.xml b/entries/mousemove-shorthand.xml
new file mode 100644
index 000000000..7b5e5c314
--- /dev/null
+++ b/entries/mousemove-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="mousemove" return="jQuery" deprecated="3.3">
+ <title>.mousemove()</title>
+ <desc>Bind an event handler to the "mousemove" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.mousemove( handler )</code> or <code>.mousemove( eventData, handler )</code>, use <a href="/https/github.com/mousemove/#on1"><code>.on( "mousemove", handler )</code></a> or <a href="/https/github.com/mousemove/#on1"><code>.on( "mousemove", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.mousemove()</code>, use <a href="/https/github.com/mousemove/#trigger2"><code>.trigger( "mousemove" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/mousemove.xml b/entries/mousemove.xml
index b22b014ac..5aaeef0b6 100644
--- a/entries/mousemove.xml
+++ b/entries/mousemove.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="mousemove" return="jQuery">
- <title>.mousemove()</title>
- <desc>Bind an event handler to the "mousemove" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+<desc>Bind an event handler to the "mousemove" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>mousemove event</title>
+ <desc>Bind an event handler to the "mousemove" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""mousemove"" type="string">
+ <desc>The string <code>"mousemove"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "mousemove", handler )</code> in the first two variations, and <code>.trigger( "mousemove" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>mousemove</code> event. For the deprecated <code>.mousemove()</code> method, see <a href="/https/github.com/mousemove-shorthand/"><code>.mousemove()</code></a>.</p>
+ </div>
<p>The <code>mousemove</code> event is sent to an element when the mouse pointer moves inside the element. Any HTML element can receive this event.</p>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -37,47 +35,46 @@
</code></pre>
<p>The event handler can be bound to the target:</p>
<pre><code>
-$( "#target" ).mousemove(function( event ) {
- var msg = "Handler for .mousemove() called at ";
+$( "#target" ).on( "mousemove", function( event ) {
+ var msg = "Handler for `mousemove` called at ";
msg += event.pageX + ", " + event.pageY;
$( "#log" ).append( "<div>" + msg + "</div>" );
-});
+} );
</code></pre>
<p>Now when the mouse pointer moves within the target button, the messages are appended to <div id="log">:</p>
<p>
- <samp>Handler for .mousemove() called at (399, 48)</samp>
+ <samp>Handler for `mousemove` called at (399, 48)</samp>
<br/>
- <samp>Handler for .mousemove() called at (398, 46)</samp>
+ <samp>Handler for `mousemove` called at (398, 46)</samp>
<br/>
- <samp>Handler for .mousemove() called at (397, 44)</samp>
+ <samp>Handler for `mousemove` called at (397, 44)</samp>
<br/>
- <samp>Handler for .mousemove() called at (396, 42)</samp>
+ <samp>Handler for `mousemove` called at (396, 42)</samp>
<br/>
</p>
- <p>To trigger the event manually, apply <code>.mousemove()</code> without an argument:</p>
+ <p>To trigger the event manually, use <code>.trigger( "mousemove" )</code>:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#target" ).mousemove();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "mousemove" );
+} );
</code></pre>
<p>After this code executes, clicks on the Trigger button will also append the message:</p>
<p>
- <samp>Handler for .mousemove() called at (undefined, undefined)</samp>
+ <samp>Handler for `mousemove` called at (undefined, undefined)</samp>
</p>
<p>When tracking mouse movement, you usually need to know the actual position of the mouse pointer. The event object that is passed to the handler contains some information about the mouse coordinates. Properties such as <code>.clientX</code>, <code>.offsetX</code>, and <code>.pageX</code> are available, but support for them differs between browsers. Fortunately, jQuery normalizes the <code>.pageX</code> and <code>.pageY</code> properties so that they can be used in all browsers. These properties provide the X and Y coordinates of the mouse pointer relative to the top-left corner of the document, as illustrated in the example output above.</p>
<p>Keep in mind that the <code>mousemove</code> event is triggered whenever the mouse pointer moves, even for a pixel. This means that hundreds of events can be generated over a very small amount of time. If the handler has to do any significant processing, or if multiple handlers for the event exist, this can be a serious performance drain on the browser. It is important, therefore, to optimize <code>mousemove </code>handlers as much as possible, and to unbind them as soon as they are no longer needed.</p>
- <p>A common pattern is to bind the <code>mousemove</code> handler from within a <code>mousedown</code> hander, and to unbind it from a corresponding <code>mouseup</code> handler. If implementing this sequence of events, remember that the <code>mouseup</code> event might be sent to a different HTML element than the <code>mousemove</code> event was. To account for this, the <code>mouseup</code> handler should typically be bound to an element high up in the DOM tree, such as <code><body></code>.</p>
+ <p>A common pattern is to bind the <code>mousemove</code> handler from within a <code>mousedown</code> handler, and to unbind it from a corresponding <code>mouseup</code> handler. If implementing this sequence of events, remember that the <code>mouseup</code> event might be sent to a different HTML element than the <code>mousemove</code> event was. To account for this, the <code>mouseup</code> handler should typically be bound to an element high up in the DOM tree, such as <code><body></code>.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="mousemove"/>
<example>
<desc>Show the mouse coordinates when the mouse is moved over the yellow div. Coordinates are relative to the window, which in this case is the iframe.</desc>
<code><![CDATA[
-$( "div" ).mousemove(function( event ) {
+$( "div" ).on( "mousemove", function( event ) {
var pageCoords = "( " + event.pageX + ", " + event.pageY + " )";
var clientCoords = "( " + event.clientX + ", " + event.clientY + " )";
- $( "span:first" ).text( "( event.pageX, event.pageY ) : " + pageCoords );
- $( "span:last" ).text( "( event.clientX, event.clientY ) : " + clientCoords );
-});
+ $( "span" ).first().text( "( event.pageX, event.pageY ) : " + pageCoords );
+ $( "span" ).last().text( "( event.clientX, event.clientY ) : " + clientCoords );
+} );
]]></code>
<height>300</height>
<css><![CDATA[
@@ -113,5 +110,23 @@ $( "div" ).mousemove(function( event ) {
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>mousemove event</title>
+ <desc>Trigger the "mousemove" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""mousemove"" type="string">
+ <desc>The string <code>"mousemove"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "mousemove", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/mouseout-shorthand.xml b/entries/mouseout-shorthand.xml
new file mode 100644
index 000000000..25761ce44
--- /dev/null
+++ b/entries/mouseout-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="mouseout" return="jQuery" deprecated="3.3">
+ <title>.mouseout()</title>
+ <desc>Bind an event handler to the "mouseout" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.mouseout( handler )</code> or <code>.mouseout( eventData, handler )</code>, use <a href="/https/github.com/mouseout/#on1"><code>.on( "mouseout", handler )</code></a> or <a href="/https/github.com/mouseout/#on1"><code>.on( "mouseout", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.mouseout()</code>, use <a href="/https/github.com/mouseout/#trigger2"><code>.trigger( "mouseout" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/mouseout.xml b/entries/mouseout.xml
index 57304cb1d..3b0148287 100644
--- a/entries/mouseout.xml
+++ b/entries/mouseout.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="mouseout" return="jQuery">
- <title>.mouseout()</title>
- <desc>Bind an event handler to the "mouseout" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+<desc>Bind an event handler to the "mouseout" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>mouseout event</title>
+ <desc>Bind an event handler to the "mouseout" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""mouseout"" type="string">
+ <desc>The string <code>"mouseout"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "mouseout", handler )</code> in the first two variation, and <code>.trigger( "mouseout" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>mouseout</code> event. For the deprecated <code>.mouseout()</code> method, see <a href="/https/github.com/mouseout-shorthand/"><code>.mouseout()</code></a>.</p>
+ </div>
<p>The <code>mouseout</code> event is sent to an element when the mouse pointer leaves the element. Any HTML element can receive this event.</p>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -44,20 +42,19 @@
</figure>
<p>The event handler can be bound to any element:</p>
<pre><code>
-$( "#outer" ).mouseout(function() {
- $( "#log" ).append( "Handler for .mouseout() called." );
-});
+$( "#outer" ).on( "mouseout", function() {
+ $( "#log" ).append( "Handler for `mouseout` called." );
+} );
</code></pre>
- <p>Now when the mouse pointer moves out of the <samp>Outer</samp> <code><div></code>, the message is appended to <code><div id="log"></code>. To trigger the event manually, apply <code>.mouseout()</code> without an argument::</p>
+ <p>Now when the mouse pointer moves out of the <samp>Outer</samp> <code><div></code>, the message is appended to <code><div id="log"></code>. To trigger the event manually, use <code>.trigger( "mouseout" )</code>:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#outer" ).mouseout();
-});
+$( "#other" ).on( "click", function() {
+ $( "#outer" ).trigger( "mouseout" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also append the message.</p>
<p>This event type can cause many headaches due to event bubbling. For instance, when the mouse pointer moves out of the <samp>Inner</samp> element in this example, a <code>mouseout</code> event will be sent to that, then trickle up to <samp>Outer</samp>. This can trigger the bound <code>mouseout</code> handler at inopportune times. See the discussion for <code>.<a href="/https/github.com/mouseleave/">mouseleave</a>()</code> for a useful alternative.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="mouseout"/>
<example>
<desc>Show the number of times mouseout and mouseleave events are triggered.
<code>mouseout</code> fires when the pointer moves out of the child element as well, while <code>mouseleave</code> fires only when the pointer moves out of the bound element.</desc>
@@ -84,23 +81,23 @@ $( "#other" ).click(function() {
<code><![CDATA[
var i = 0;
$( "div.overout" )
- .mouseout(function() {
- $( "p:first", this ).text( "mouse out" );
- $( "p:last", this ).text( ++i );
- })
- .mouseover(function() {
- $( "p:first", this ).text( "mouse over" );
- });
+ .on( "mouseout", function() {
+ $( "p", this ).first().text( "mouse out" );
+ $( "p", this ).last().text( ++i );
+ } )
+ .on( "mouseover", function() {
+ $( "p", this ).first().text( "mouse over" );
+ } );
var n = 0;
$( "div.enterleave" )
.on( "mouseenter", function() {
- $( "p:first", this ).text( "mouse enter" );
- })
+ $( "p", this ).first().text( "mouse enter" );
+ } )
.on( "mouseleave", function() {
- $( "p:first", this ).text( "mouse leave" );
- $( "p:last", this ).text( ++n );
- });
+ $( "p", this ).first().text( "mouse leave" );
+ $( "p", this ).last().text( ++n );
+ } );
]]></code>
<html><![CDATA[
<div class="out overout">
@@ -118,5 +115,23 @@ $( "div.enterleave" )
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>mouseout event</title>
+ <desc>Trigger the "mouseout" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""mouseout"" type="string">
+ <desc>The string <code>"mouseout"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "mouseout", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+</entry>
+
+</entries>
diff --git a/entries/mouseover-shorthand.xml b/entries/mouseover-shorthand.xml
new file mode 100644
index 000000000..25bc4c013
--- /dev/null
+++ b/entries/mouseover-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="mouseover" return="jQuery" deprecated="3.3">
+ <title>.mouseover()</title>
+ <desc>Bind an event handler to the "mouseover" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.mouseover( handler )</code> or <code>.mouseover( eventData, handler )</code>, use <a href="/https/github.com/mouseover/#on1"><code>.on( "mouseover", handler )</code></a> or <a href="/https/github.com/mouseover/#on1"><code>.on( "mouseover", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.mouseover()</code>, use <a href="/https/github.com/mouseover/#trigger2"><code>.trigger( "mouseover" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/mouseover.xml b/entries/mouseover.xml
index 88ddb981e..6897db069 100644
--- a/entries/mouseover.xml
+++ b/entries/mouseover.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="mouseover" return="jQuery">
- <title>.mouseover()</title>
- <desc>Bind an event handler to the "mouseover" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+<desc>Bind an event handler to the "mouseover" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>mouseover event</title>
+ <desc>Bind an event handler to the "mouseover" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""mouseover"" type="string">
+ <desc>The string <code>"mouseover"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "mouseover", handler )</code> in the first two variations, and <code>.trigger( "mouseover" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>mouseover</code> event. For the deprecated <code>.mouseover()</code> method, see <a href="/https/github.com/mouseover-shorthand/"><code>.mouseover()</code></a>.</p>
+ </div>
<p>The <code>mouseover</code> event is sent to an element when the mouse pointer enters the element. Any HTML element can receive this event.</p>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -44,20 +42,19 @@
</figure>
<p>The event handler can be bound to any element:</p>
<pre><code>
-$( "#outer" ).mouseover(function() {
- $( "#log" ).append( "<div>Handler for .mouseover() called.</div>" );
-});
+$( "#outer" ).on( "mouseover", function() {
+ $( "#log" ).append( "<div>Handler for `mouseover` called.</div>" );
+} );
</code></pre>
<p>Now when the mouse pointer moves over the <samp>Outer</samp> <code><div></code>, the message is appended to <code><div id="log"></code>. We can also trigger the event when another element is clicked:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#outer" ).mouseover();
-});
+$( "#other" ).on( "click", function() {
+ $( "#outer" ).trigger( "mouseover" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also append the message.</p>
<p>This event type can cause many headaches due to event bubbling. For instance, when the mouse pointer moves over the <samp>Inner</samp> element in this example, a <code>mouseover</code> event will be sent to that, then trickle up to <samp>Outer</samp>. This can trigger our bound <code>mouseover</code> handler at inopportune times. See the discussion for <code>.mouseenter()</code> for a useful alternative.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="mouseover"/>
<example>
<desc>Show the number of times mouseover and mouseenter events are triggered.
<code>mouseover</code> fires when the pointer moves into the child element as well, while <code>mouseenter</code> fires only when the pointer moves into the bound element.</desc>
@@ -84,23 +81,23 @@ $( "#other" ).click(function() {
<code><![CDATA[
var i = 0;
$( "div.overout" )
- .mouseover(function() {
+ .on( "mouseover", function() {
i += 1;
$( this ).find( "span" ).text( "mouse over x " + i );
- })
- .mouseout(function() {
+ } )
+ .on( "mouseout", function() {
$( this ).find( "span" ).text( "mouse out " );
- });
+ } );
var n = 0;
$( "div.enterleave" )
- .mouseenter(function() {
+ .on( "mouseenter", function() {
n += 1;
$( this ).find( "span" ).text( "mouse enter x " + n );
- })
- .mouseleave(function() {
+ } )
+ .on( "mouseleave", function() {
$( this ).find( "span" ).text( "mouse leave" );
- });
+ } );
]]></code>
<html><![CDATA[
<div class="out overout">
@@ -118,5 +115,23 @@ $( "div.enterleave" )
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>mouseover event</title>
+ <desc>Trigger the "mouseover" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""mouseover"" type="string">
+ <desc>The string <code>"mouseover"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "mouseover", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/mouseup-shorthand.xml b/entries/mouseup-shorthand.xml
new file mode 100644
index 000000000..edbf836c5
--- /dev/null
+++ b/entries/mouseup-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="mouseup" return="jQuery" deprecated="3.3">
+ <title>.mouseup()</title>
+ <desc>Bind an event handler to the "mouseup" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.mouseup( handler )</code> or <code>.mouseup( eventData, handler )</code>, use <a href="/https/github.com/mouseup/#on1"><code>.on( "mouseup", handler )</code></a> or <a href="/https/github.com/mouseup/#on1"><code>.on( "mouseup", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.mouseup()</code>, use <a href="/https/github.com/mouseup/#trigger2"><code>.trigger( "mouseup" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/mouseup.xml b/entries/mouseup.xml
index e18080a6d..205c0794e 100644
--- a/entries/mouseup.xml
+++ b/entries/mouseup.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="mouseup" return="jQuery">
- <title>.mouseup()</title>
- <desc>Bind an event handler to the "mouseup" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+<desc>Bind an event handler to the "mouseup" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>mouseup event</title>
+ <desc>Bind an event handler to the "mouseup" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""mouseup"" type="string">
+ <desc>The string <code>"mouseup"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on('mouseup', handler)</code> in the first variation, and <code>.trigger('mouseup')</code> in the second.</p>
+ <div class="warning">
+ <p>This page describes the <code>mouseup</code> event. For the deprecated <code>.mouseup()</code> method, see <a href="/https/github.com/mouseup-shorthand/"><code>.mouseup()</code></a>.</p>
+ </div>
<p>The <code>mouseup</code> event is sent to an element when the mouse pointer is over the element, and the mouse button is released. Any HTML element can receive this event.</p>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -40,34 +38,33 @@
</figure>
<p>The event handler can be bound to any <code><div></code>:</p>
<pre><code>
-$( "#target" ).mouseup(function() {
- alert( "Handler for .mouseup() called." );
-});
+$( "#target" ).on( "mouseup", function() {
+ alert( "Handler for `mouseup` called." );
+} );
</code></pre>
<p>Now if we click on this element, the alert is displayed:</p>
<p>
- <samp>Handler for .mouseup() called.</samp>
+ <samp>Handler for `mouseup` called.</samp>
</p>
<p>We can also trigger the event when a different element is clicked:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#target" ).mouseup();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "mouseup" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also alert the message.</p>
<p>If the user clicks outside an element, drags onto it, and releases the button, this is still counted as a <code>mouseup</code> event. This sequence of actions is not treated as a button press in most user interfaces, so it is usually better to use the <code>click</code> event unless we know that the <code>mouseup</code> event is preferable for a particular situation.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="mouseup"/>
<example>
<desc>Show texts when mouseup and mousedown event triggering.</desc>
<code><![CDATA[
$( "p" )
- .mouseup(function() {
+ .on( "mouseup", function() {
$( this ).append( "<span style='color:#f00;'>Mouse up.</span>" );
- })
- .mousedown(function() {
+ } )
+ .on( "mousedown", function() {
$( this ).append( "<span style='color:#00f;'>Mouse down.</span>" );
- });
+ } );
]]></code>
<html><![CDATA[
<p>Press mouse and release here.</p>
@@ -75,5 +72,23 @@ $( "p" )
</example>
<category slug="events/mouse-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>mouseup event</title>
+ <desc>Trigger the "mouseup" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""mouseup"" type="string">
+ <desc>The string <code>"mouseup"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "mouseup", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/mouse-events"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/nextAll.xml b/entries/nextAll.xml
index 8965aab67..e60220934 100644
--- a/entries/nextAll.xml
+++ b/entries/nextAll.xml
@@ -30,7 +30,7 @@ $( "li.third-item" ).nextAll().css( "background-color", "red" );
<example>
<desc>Locate all the divs after the first and give them a class.</desc>
<code><![CDATA[
-$( "div:first" ).nextAll().addClass( "after" );
+$( "div" ).first().nextAll().addClass( "after" );
]]></code>
<css><![CDATA[
div {
diff --git a/entries/not.xml b/entries/not.xml
index a9a0880d7..8a41ddf1c 100644
--- a/entries/not.xml
+++ b/entries/not.xml
@@ -40,9 +40,9 @@
</code></pre>
<p>We can apply this method to the set of list items:</p>
<pre><code>
-$( "li" ).not( ":even" ).css( "background-color", "red" );
+$( "li" ).not( ":nth-child(2n)" ).css( "background-color", "red" );
</code></pre>
- <p>The result of this call is a red background for items 2 and 4, as they do not match the selector (recall that :even and :odd use 0-based indexing).</p>
+ <p>The result of this call is a red background for items 1, 3 and 5, as they do not match the selector.</p>
<h4>Removing Specific Elements</h4>
<p>The second version of the <code>.not()</code> method allows us to remove elements from the matched set, assuming we have found those elements previously by some other means. For example, suppose our list had an id applied to one of its items:</p>
<pre><code>
diff --git a/entries/nth-child-selector.xml b/entries/nth-child-selector.xml
index 68da261d0..8a5efc4c0 100644
--- a/entries/nth-child-selector.xml
+++ b/entries/nth-child-selector.xml
@@ -10,8 +10,8 @@
</signature>
<desc>Selects all elements that are the nth-child of their parent.</desc>
<longdesc>
- <p>Because jQuery's implementation of <code>:nth-</code> selectors is strictly derived from the CSS specification, the value of <code>n</code> is "1-indexed", meaning that the counting starts at 1. For other selector expressions such as <code>:eq()</code> or <code>:even</code> jQuery follows JavaScript's "0-indexed" counting. Given a single <code><ul></code> containing two <code><li></code>s, <code>$( "li:nth-child(1)" )</code> selects the first <code><li></code> while <code>$( "li:eq(1)" )</code> selects the second.</p>
- <p>The <code>:nth-child(n)</code> pseudo-class is easily confused with <code>:eq(n)</code>, even though the two can result in dramatically different matched elements. With <code>:nth-child(n)</code>, all children are counted, regardless of what they are, and the specified element is selected only if it matches the selector attached to the pseudo-class. With <code>:eq(n)</code> only the selector attached to the pseudo-class is counted, not limited to children of any other element, and the (n+1)th one (n is 0-based) is selected.</p>
+ <p>Because jQuery's implementation of <code>:nth-</code> selectors is strictly derived from the CSS specification, the value of <code>n</code> is "1-indexed", meaning that the counting starts at 1. jQuery methods like <a href="/https/github.com/first/"><code>.first()</code></a> or <a href="/https/github.com/eq/"><code>.eq()</code></a> jQuery follows JavaScript's "0-indexed" counting. Given a single <code><ul></code> containing two <code><li></code>s, <code>$( "li:nth-child(1)" )</code> selects the first <code><li></code> while <code>$( "li" ).eq( 1 )</code> selects the second.</p>
+ <p>The <code>:nth-child(n)</code> pseudo-class is easily confused with the <code>.eq( n )</code> call, even though the two can result in dramatically different matched elements. With <code>:nth-child(n)</code>, all children are counted, regardless of what they are, and the specified element is selected only if it matches the selector attached to the pseudo-class. With the <code>.eq( n )</code> call only the selector attached to the pseudo-class is counted, not limited to children of any other element, and the (n+1)th one (n is 0-based) is selected.</p>
<p>Further discussion of this unusual usage can be found in the <a href="https://www.w3.org/TR/css3-selectors/#nth-child-pseudo">W3C CSS specification</a>.</p>
</longdesc>
<example>
@@ -51,12 +51,17 @@ $( "ul li:nth-child(2)" ).append( "<span> - 2nd!</span>" );
]]></html>
</example>
<example>
- <desc>This is a playground to see how the selector works with different strings. Notice that this is different from the :even and :odd which have no regard for parent and just filter the list of elements to every other one. The :nth-child, however, counts the index of the child to its particular parent. In any case, it's easier to see than explain so...</desc>
+ <desc>This is a playground to see how the selector works with different strings. Notice that this is different from the <a href="/https/github.com/even/"><code>even</code></a> and <a href="/https/github.com/odd/"><code>odd</code></a> which have no regard for parent and just filter the list of elements to every other one. The :nth-child, however, counts the index of the child to its particular parent. In any case, it's easier to see than explain so...</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
var str = $( this ).text();
+ var method = $( this ).attr( "data-method" );
$( "tr" ).css( "background", "white" );
- $( "tr" + str ).css( "background", "#ff0000" );
+ if ( method ) {
+ $( "tr" )[ method ]().css( "background", "#ff0000" );
+ } else {
+ $( "tr" + str ).css( "background", "#ff0000" );
+ }
$( "#inner" ).text( str );
});
]]></code>
@@ -94,8 +99,8 @@ $( "button" ).click(function() {
<div>
<button>:nth-child(3n+1)</button>
<button>:nth-child(3n+2)</button>
- <button>:even</button>
- <button>:odd</button>
+ <button data-method="even">.even()</button>
+ <button data-method="odd">.odd()</button>
</div>
<div>
diff --git a/entries/nth-last-child-selector.xml b/entries/nth-last-child-selector.xml
index 9d63636a3..def39a3bd 100644
--- a/entries/nth-last-child-selector.xml
+++ b/entries/nth-last-child-selector.xml
@@ -10,7 +10,7 @@
</signature>
<desc>Selects all elements that are the nth-child of their parent, counting from the last element to the first.</desc>
<longdesc>
- <p>Because jQuery's implementation of <code>:nth-</code> selectors is strictly derived from the CSS specification, the value of <code>n</code> is "1-indexed", meaning that the counting starts at 1. For other selector expressions such as <code>:eq()</code> or <code>:even</code> jQuery follows JavaScript's "0-indexed" counting. Given a single <code><ul></code> containing three <code><li></code>s, <code>$( "li:nth-last-child(1)" )</code> selects the third, last, <code><li></code>.</p>
+ <p>Because jQuery's implementation of <code>:nth-</code> selectors is strictly derived from the CSS specification, the value of <code>n</code> is "1-indexed", meaning that the counting starts at 1. For other selector expressions such as <a href="/https/github.com/first/"><code>.first()</code></a> or <a href="/https/github.com/eq/"><code>.eq()</code></a> jQuery follows JavaScript's "0-indexed" counting. Given a single <code><ul></code> containing three <code><li></code>s, <code>$( "li:nth-last-child(1)" )</code> selects the third, last, <code><li></code>.</p>
<p>Further discussion of this usage can be found in the <a href="https://www.w3.org/TR/css3-selectors/#nth-last-child-pseudo">W3C CSS specification</a>.</p>
</longdesc>
<example>
@@ -51,7 +51,7 @@ $( "ul li:nth-last-child(2)" ).append( "<span> - 2nd to last!</span>" );
<example>
<desc>This is a playground to see how the selector works with different strings. </desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
var str = $( this ).text();
$( "tr" ).css( "background", "white" );
$( "tr" + str ).css( "background", "#ff0000" );
diff --git a/entries/nth-last-of-type-selector.xml b/entries/nth-last-of-type-selector.xml
index 602d430ad..8b517e5e7 100644
--- a/entries/nth-last-of-type-selector.xml
+++ b/entries/nth-last-of-type-selector.xml
@@ -10,7 +10,7 @@
</signature>
<desc>Selects all the elements that are the nth-child of their parent in relation to siblings with the same element name, counting from the last element to the first.</desc>
<longdesc>
- <p>Because jQuery's implementation of <code>:nth-</code> selectors is strictly derived from the CSS specification, the value of <code>n</code> is "1-indexed", meaning that the counting starts at 1. For other selector expressions such as <code>:eq()</code> or <code>:even</code> jQuery follows JavaScript's "0-indexed" counting. Given a single <code><ul></code> containing three <code><li></code>s, <code>$('li:nth-last-of-type(1)')</code> selects the third, last, <code><li></code>.</p>
+ <p>Because jQuery's implementation of <code>:nth-</code> selectors is strictly derived from the CSS specification, the value of <code>n</code> is "1-indexed", meaning that the counting starts at 1. For other selector expressions such as <a href="/https/github.com/first/"><code>.first()</code></a> or <a href="/https/github.com/eq/"><code>.eq()</code></a> jQuery follows JavaScript's "0-indexed" counting. Given a single <code><ul></code> containing three <code><li></code>s, <code>$('li:nth-last-of-type(1)')</code> selects the third, last, <code><li></code>.</p>
<p>Further discussion of this usage can be found in the <a href="https://www.w3.org/TR/css3-selectors/#nth-last-of-type-pseudo">W3C CSS specification</a>.</p>
</longdesc>
<example>
@@ -52,7 +52,7 @@ $( "ul li:nth-last-of-type(2)" ).append( "<span> - 2nd to last!</span>" );
<example>
<desc>This is a playground to see how the selector works with different strings. </desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
var str = $( this ).text();
$( "tr" ).css( "background", "white" );
$( "tr" + str ).css( "background", "#ff0000" );
diff --git a/entries/nth-of-type-selector.xml b/entries/nth-of-type-selector.xml
index 89e6d452c..0d93ab8cc 100644
--- a/entries/nth-of-type-selector.xml
+++ b/entries/nth-of-type-selector.xml
@@ -10,7 +10,7 @@
</signature>
<desc>Selects all elements that are the nth child of their parent in relation to siblings with the same element name.</desc>
<longdesc>
- <p>Because jQuery's implementation of <code>:nth-</code> selectors is strictly derived from the CSS specification, the value of <code>n</code> is "1-indexed", meaning that the counting starts at 1. For other selector expressions such as <code>:eq()</code> or <code>:even</code> jQuery follows JavaScript's "0-indexed" counting. </p>
+ <p>Because jQuery's implementation of <code>:nth-</code> selectors is strictly derived from the CSS specification, the value of <code>n</code> is "1-indexed", meaning that the counting starts at 1. For other selector expressions such as <a href="/https/github.com/first/"><code>.first()</code></a> or <a href="/https/github.com/eq/"><code>.eq()</code></a> jQuery follows JavaScript's "0-indexed" counting. </p>
<p>Further discussion of this usage can be found in the <a href="https://www.w3.org/TR/css3-selectors/#nth-of-type-pseudo">W3C CSS specification</a>.</p>
</longdesc>
<example>
diff --git a/entries/odd-selector.xml b/entries/odd-selector.xml
index 12a75cb84..8b907e15d 100644
--- a/entries/odd-selector.xml
+++ b/entries/odd-selector.xml
@@ -1,12 +1,15 @@
<?xml version="1.0"?>
-<entry type="selector" name="odd" return="">
+<entry type="selector" name="odd" return="" deprecated="3.4">
<title>:odd Selector</title>
<sample>:odd</sample>
<signature>
<added>1.0</added>
</signature>
- <desc>Selects odd elements, zero-indexed. See also <a href="/https/github.com/even-selector/">even</a>.</desc>
+ <desc>Selects odd elements, zero-indexed. See also <a href="/https/github.com/even-selector/"><code>:even</code></a>.</desc>
<longdesc>
+ <div class="warning">
+ <p><strong>As of jQuery 3.4</strong>, the <code>:odd</code> pseudo-class is deprecated. Remove it from your selectors and filter the results later using <a href="/https/github.com/odd/"><code>.odd()</code></a> (available in jQuery 3.5.0 or newer).</p>
+ </div>
<p>In particular, note that the <em>0-based indexing</em> means that, counter-intuitively, <code>:odd</code> selects the second element, fourth element, and so on within the matched set.</p>
</longdesc>
<note id="jquery-selector-extension" type="additional" data-selector=":odd"/>
@@ -33,4 +36,5 @@ $( "tr:odd" ).css( "background-color", "#bbbbff" );
<category slug="selectors/basic-filter-selectors"/>
<category slug="selectors/jquery-selector-extensions"/>
<category slug="version/1.0"/>
+ <category slug="deprecated/deprecated-3.4"/>
</entry>
diff --git a/entries/odd.xml b/entries/odd.xml
new file mode 100644
index 000000000..52fe3baf6
--- /dev/null
+++ b/entries/odd.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0"?>
+<entry type="method" name="odd" return="jQuery">
+ <title>.odd()</title>
+ <signature>
+ <added>3.5</added>
+ </signature>
+ <desc>Reduce the set of matched elements to the odd ones in the set, numbered from zero.</desc>
+ <longdesc>
+ <p>Given a jQuery object that represents a set of DOM elements, the <code>.odd()</code> method constructs a new jQuery object from the odd elements in that set. Counting starts from zero!</p>
+ <p>Consider a page with a simple list on it:</p>
+ <pre><code>
+<ul>
+ <li>list item 1</li>
+ <li>list item 2</li>
+ <li>list item 3</li>
+ <li>list item 4</li>
+ <li>list item 5</li>
+</ul>
+ </code></pre>
+ <p>We can apply this method to the set of list items:</p>
+ <pre><code>
+$( "li" ).odd().css( "background-color", "red" );
+ </code></pre>
+ <p>The result of this call is a red background for the second & 4th items.</p>
+ </longdesc>
+ <example>
+ <desc>Highlight the odd items in a list.</desc>
+ <css><![CDATA[
+ .highlight {
+ background-color: yellow;
+ }
+]]></css>
+ <code><![CDATA[
+$( "ul li" ).odd().addClass( "highlight" );
+]]></code>
+ <html><![CDATA[
+<ul>
+ <li>Look:</li>
+ <li>This is some text in a list.</li>
+ <li>This is a note about it.</li>
+ <li>This is another note about it.</li>
+</ul>
+]]></html>
+ </example>
+ <category slug="traversing/filtering"/>
+ <category slug="version/3.5"/>
+</entry>
diff --git a/entries/off.xml b/entries/off.xml
index 2c711a68d..fba3925c0 100644
--- a/entries/off.xml
+++ b/entries/off.xml
@@ -46,13 +46,13 @@
function flash() {
$( "div" ).show().fadeOut( "slow" );
}
-$( "#bind" ).click(function() {
+$( "#bind" ).on( "click", function() {
$( "body" )
.on( "click", "#theone", flash )
.find( "#theone" )
.text( "Can Click!" );
});
-$( "#unbind" ).click(function() {
+$( "#unbind" ).on( "click", function() {
$( "body" )
.off( "click", "#theone", flash )
.find( "#theone" )
diff --git a/entries/offset.xml b/entries/offset.xml
index 9a588ca25..819232879 100644
--- a/entries/offset.xml
+++ b/entries/offset.xml
@@ -11,15 +11,15 @@
<p>The <code>.offset()</code> method allows us to retrieve the current position of an element (specifically its border box, which excludes margins) <em>relative to the document</em>. Contrast this with <code><a href="/https/github.com/position/">.position()</a></code>, which retrieves the current position <em>relative to the offset parent</em>. When positioning a new element on top of an existing one for global manipulation (in particular, for implementing drag-and-drop), <code>.offset()</code> is more useful.</p>
<p><code>.offset()</code> returns an object containing the properties <code>top</code> and <code>left</code>.</p>
<div class="warning">
- <p><strong>Note:</strong> jQuery does not support getting the offset coordinates of hidden elements or accounting for margins set on the <code><html></code> document element.</p>
+ <p><strong>Note:</strong> jQuery does not support getting the offset coordinates of hidden elements or accounting for margins set on the <code><html></code> document element.</p>
<p>While it is possible to get the coordinates of elements with <code>visibility:hidden</code> set, <code>display:none</code> is excluded from the rendering tree and thus has a position that is undefined.</p>
</div>
</longdesc>
- <note id="dimensions-number" type="additional" data-title=".offset()"/>
+ <note id="dimensions-number" type="additional" data-title=".offset()"/>
<example>
<desc>Access the offset of the second paragraph:</desc>
<code><![CDATA[
-var p = $( "p:last" );
+var p = $( "p" ).last();
var offset = p.offset();
p.html( "left: " + offset.left + ", top: " + offset.top );
]]></code>
@@ -35,7 +35,7 @@ p.html( "left: " + offset.left + ", top: " + offset.top );
<example>
<desc>Click to see the offset.</desc>
<code><![CDATA[
-$( "*", document.body ).click(function( event ) {
+$( "*", document.body ).on( "click", function( event ) {
var offset = $( this ).offset();
event.stopPropagation();
$( "#result" ).text( this.tagName +
@@ -90,7 +90,7 @@ $( "*", document.body ).click(function( event ) {
<argument name="function" type="Function">
<argument name="index" type="Integer" />
<argument name="coords" type="PlainObject" />
- <return type="PlainObject" />
+ <return type="PlainObject" />
<desc>A function to return the coordinates to set. Receives the index of the element in the collection as the first argument and the current coordinates as the second argument. The function should return an object with the new <code>top</code> and <code>left</code> properties.</desc>
</argument>
</signature>
@@ -101,7 +101,7 @@ $( "*", document.body ).click(function( event ) {
<example>
<desc>Set the offset of the second paragraph:</desc>
<code><![CDATA[
-$( "p:last" ).offset({ top: 10, left: 30 });
+$( "p" ).last().offset({ top: 10, left: 30 });
]]></code>
<css><![CDATA[
p {
diff --git a/entries/on.xml b/entries/on.xml
index 735f82b40..c874c4b68 100644
--- a/entries/on.xml
+++ b/entries/on.xml
@@ -41,9 +41,9 @@
<p>The majority of browser events <em>bubble</em>, or <em>propagate</em>, from the deepest, innermost element (the <strong>event target</strong>) in the document where they occur all the way up to the body and the <code>document</code> element. In Internet Explorer 8 and lower, a few events such as <code>change</code> and <code>submit</code> do not natively bubble but jQuery patches these to bubble and create consistent cross-browser behavior.</p>
<p>If <code>selector</code> is omitted or is null, the event handler is referred to as <em>direct</em> or <em>directly-bound</em>. The handler is called every time an event occurs on the selected elements, whether it occurs directly on the element or bubbles from a descendant (inner) element.</p>
<p>When a <code>selector</code> is provided, the event handler is referred to as <em>delegated</em>. The handler is not called when the event occurs directly on the bound element, but only for descendants (inner elements) that match the selector. jQuery bubbles the event from the event target up to the element where the handler is attached (i.e., innermost to outermost element) and runs the handler for any elements along that path matching the selector.</p>
- <p><strong>Event handlers are bound only to the currently selected elements; they must exist at the time your code makes the call to <code>.on()</code></strong>. To ensure the elements are present and can be selected, place scripts after the elements in the HTML markup or perform event binding inside a document ready handler. Alternatively, use delegated events to attach event handlers.</p>
- <p><strong>Delegated event handlers</strong> have the advantage that they can process events from <em>descendant elements</em> that are added to the document at a later time. By picking an element that is guaranteed to be present at the time the delegated event handler is attached, you can use delegated events to avoid the need to frequently attach and remove event handlers. This element could be the container element of a view in a Model-View-Controller design, for example, or <code>document</code> if the event handler wants to monitor all bubbling events in the document. The <code>document</code> element is available in the <code>head</code> of the document before loading any other HTML, so it is safe to attach events there without waiting for the document to be ready.</p>
- <p>In addition to their ability to handle events on descendant elements not yet created, another advantage of delegated events is their potential for much lower overhead when many elements must be monitored. On a data table with 1,000 rows in its <code>tbody</code>, this example attaches a handler to 1,000 elements:</p>
+ <p><strong>Event handlers are bound only to the currently selected elements; they must exist at the time your code makes the call to <code>.on()</code></strong>. To ensure the elements are present and can be selected, place scripts after the elements in the HTML markup or perform event binding inside a document ready handler. Alternatively, use delegated event handlers to attach event handlers.</p>
+ <p><strong>Delegated event handlers</strong> have the advantage that they can process events from <em>descendant elements</em> that are added to the document at a later time. By picking an element that is guaranteed to be present at the time the delegated event handler is attached, you can use delegated event handlers to avoid the need to frequently attach and remove event handlers. This element could be the container element of a view in a Model-View-Controller design, for example, or <code>document</code> if the event handler wants to monitor all bubbling events in the document. The <code>document</code> element is available in the <code>head</code> of the document before loading any other HTML, so it is safe to attach events there without waiting for the document to be ready.</p>
+ <p>In addition to their ability to handle events on descendant elements not yet created, another advantage of delegated event handlers is their potential for much lower overhead when many elements must be monitored. On a data table with 1,000 rows in its <code>tbody</code>, this example attaches a handler to 1,000 elements:</p>
<pre><code>
$( "#dataTable tbody tr" ).on( "click", function() {
console.log( $( this ).text() );
@@ -90,7 +90,7 @@ $( "button" ).on( "click", {
<p>Attaching many delegated event handlers near the top of the document tree can degrade performance. Each time the event occurs, jQuery must compare all selectors of all attached events of that type to every element in the path from the event target up to the top of the document. For best performance, attach delegated events at a document location as close as possible to the target elements. Avoid excessive use of <code>document</code> or <code>document.body</code> for delegated events on large documents.</p>
<p>jQuery can process simple selectors of the form <code>tag#id.class</code> very quickly when they are used to filter delegated events. So, <code>"#myForm"</code>, <code>"a.external"</code>, and <code>"button"</code> are all fast selectors. Delegated events that use more complex selectors, particularly hierarchical ones, can be several times slower--although they are still fast enough for most applications. Hierarchical selectors can often be avoided simply by attaching the handler to a more appropriate point in the document. For example, instead of <code>$( "body" ).on( "click", "#commentForm .addNew", addComment )</code> use <code>$( "#commentForm" ).on( "click", ".addNew", addComment )</code>.</p>
<h2 id="additional-notes">Additional notes</h2>
- <p>There are shorthand methods for some events such as <a href="/https/github.com/click/"><code>.click()</code></a> that can be used to attach or trigger event handlers. For a complete list of shorthand methods, see the <a href="/https/github.com/category/events/">events category</a>.</p>
+ <p>Some events have dedicated pages, describing specifics of their usage. For a complete list of those events, see the <a href="/https/github.com/category/events/">events category</a>.</p>
<p><em>Deprecated in jQuery 1.8, removed in 1.9:</em> The name <code>"hover"</code> used as a shorthand for the string <code>"mouseenter mouseleave"</code>. It attaches a <em>single event handler</em> for those two events, and the handler must examine <code>event.type</code> to determine whether the event is <code>mouseenter</code> or <code>mouseleave</code>. Do not confuse the "hover" pseudo-event-name with the <a href="/https/github.com/hover/"><code>.hover()</code></a> method, which accepts <em>one or two</em> functions.</p>
<p>jQuery's event system requires that a DOM element allow attaching data via a property on the element, so that events can be tracked and delivered. The <code>object</code>, <code>embed</code>, and <code>applet</code> elements cannot attach data, and therefore cannot have jQuery events bound to them.</p>
<p>The <code>focus</code> and <code>blur</code> events are specified by the W3C to not bubble, but jQuery defines cross-browser <code>focusin</code> and <code>focusout</code> events that do bubble. When <code>focus</code> and <code>blur</code> are used to attach delegated event handlers, jQuery maps the names and delivers them as <code>focusin</code> and <code>focusout</code> respectively. For consistency and clarity, use the bubbling event type names.</p>
@@ -161,7 +161,7 @@ $( "div" ).trigger( "click", { name: "Jim" } );
]]></code>
</example>
<example>
- <desc>Use the the second argument of <code>.trigger()</code> to pass an array of data to the event handler</desc>
+ <desc>Use the second argument of <code>.trigger()</code> to pass an array of data to the event handler</desc>
<code><![CDATA[
$( "div" ).on( "click", function( event, salutation, name ) {
alert( salutation + ", " + name );
diff --git a/entries/outerHeight.xml b/entries/outerHeight.xml
index e1caaf556..dc53bcb38 100644
--- a/entries/outerHeight.xml
+++ b/entries/outerHeight.xml
@@ -18,13 +18,13 @@
<figcaption>Figure 1 - Illustration of the measured height</figcaption>
</figure>
</longdesc>
- <note id="dimensions-number" type="additional" data-title=".outerHeight()"/>
+ <note id="dimensions-number" type="additional" data-title=".outerHeight()"/>
<note id="hidden-element-dimensions" type="additional" data-title=".outerHeight()"/>
<example>
<desc>Get the outerHeight of a paragraph.</desc>
<code><![CDATA[
-var p = $( "p:first" );
-$( "p:last" ).text(
+var p = $( "p" ).first();
+$( "p" ).last().text(
"outerHeight:" + p.outerHeight() +
" , outerHeight( true ):" + p.outerHeight( true ) );
]]></code>
@@ -47,15 +47,18 @@ $( "p:last" ).text(
<entry type="method" name="outerHeight" return="jQuery">
<signature>
- <added>1.8.0</added>
+ <added>1.8</added>
<argument name="value">
<type name="String"/>
<type name="Number"/>
<desc>A number representing the number of pixels, or a number along with an optional unit of measure appended (as a string).</desc>
</argument>
+ <argument name="includeMargin" optional="true" type="Boolean" default="false">
+ <desc>A Boolean indicating whether to new value should account for the element's margin.</desc>
+ </argument>
</signature>
<signature>
- <added>1.8.0</added>
+ <added>1.8</added>
<argument name="function" type="Function">
<argument name="index" type="Integer" />
<argument name="height" type="Number" />
diff --git a/entries/outerWidth.xml b/entries/outerWidth.xml
index 4e613cc19..2c5856bea 100644
--- a/entries/outerWidth.xml
+++ b/entries/outerWidth.xml
@@ -18,13 +18,13 @@
<figcaption>Figure 1 - Illustration of the measured width</figcaption>
</figure>
</longdesc>
- <note id="dimensions-number" type="additional" data-title=".outerWidth()"/>
+ <note id="dimensions-number" type="additional" data-title=".outerWidth()"/>
<note id="hidden-element-dimensions" type="additional" data-title=".outerWidth()"/>
<example>
<desc>Get the outerWidth of a paragraph.</desc>
<code><![CDATA[
-var p = $( "p:first" );
-$( "p:last" ).text(
+var p = $( "p" ).first();
+$( "p" ).last().text(
"outerWidth:" + p.outerWidth() +
" , outerWidth( true ):" + p.outerWidth( true ) );
]]></code>
@@ -47,15 +47,18 @@ $( "p:last" ).text(
<entry type="method" name="outerWidth" return="jQuery">
<signature>
- <added>1.8.0</added>
+ <added>1.8</added>
<argument name="value">
<type name="String"/>
<type name="Number"/>
<desc>A number representing the number of pixels, or a number along with an optional unit of measure appended (as a string).</desc>
</argument>
+ <argument name="includeMargin" optional="true" type="Boolean" default="false">
+ <desc>A Boolean indicating whether to new value should account for the element's margin.</desc>
+ </argument>
</signature>
<signature>
- <added>1.8.0</added>
+ <added>1.8</added>
<argument name="function" type="Function">
<argument name="index" type="Integer" />
<argument name="width" type="Number" />
diff --git a/entries/parents.xml b/entries/parents.xml
index 403b23936..ab51cde99 100644
--- a/entries/parents.xml
+++ b/entries/parents.xml
@@ -82,7 +82,7 @@ function showParents() {
.length;
$( "b" ).text( "Unique div parents: " + len );
}
-$( "span" ).click(function() {
+$( "span" ).on( "click", function() {
$( this ).toggleClass( "selected" );
showParents();
});
diff --git a/entries/password-selector.xml b/entries/password-selector.xml
index 8d632b8f6..053e0dc29 100644
--- a/entries/password-selector.xml
+++ b/entries/password-selector.xml
@@ -13,18 +13,18 @@
<example>
<desc>Finds all password inputs.</desc>
<code><![CDATA[
-var input = $( "input:password" ).css({
+var input = $( "input:password" ).css( {
background: "yellow",
border: "3px red solid"
-});
+} );
$( "div" )
.text( "For this type jQuery found " + input.length + "." )
.css( "color", "red" );
// Prevent form submission
-$( "form" ).submit(function() {
+$( "form" ).on( "submit", function() {
return false;
-});
+} );
]]></code>
<css><![CDATA[
textarea {
diff --git a/entries/position.xml b/entries/position.xml
index 3eed46b4e..565f64afe 100644
--- a/entries/position.xml
+++ b/entries/position.xml
@@ -12,13 +12,13 @@
<p><strong>Note:</strong> jQuery does not support getting the position coordinates of hidden elements or accounting for margins set on the <code><html></code> document element.</p>
</div>
</longdesc>
- <note id="dimensions-number" type="additional" data-title=".position()"/>
+ <note id="dimensions-number" type="additional" data-title=".position()"/>
<example>
<desc>Access the position of the second paragraph:</desc>
<code><![CDATA[
-var p = $( "p:first" );
+var p = $( "p" ).first();
var position = p.position();
-$( "p:last" ).text( "left: " + position.left + ", top: " + position.top );
+$( "p" ).last().text( "left: " + position.left + ", top: " + position.top );
]]></code>
<css><![CDATA[
div {
diff --git a/entries/prev.xml b/entries/prev.xml
index 7ee31594f..11a03f94e 100644
--- a/entries/prev.xml
+++ b/entries/prev.xml
@@ -34,7 +34,7 @@ $( "li.third-item" ).prev().css( "background-color", "red" );
<code><![CDATA[
var $curr = $( "#start" );
$curr.css( "background", "#f99" );
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$curr = $curr.prev();
$( "div" ).css( "background", "" );
$curr.css( "background", "#f99" );
diff --git a/entries/prevAll.xml b/entries/prevAll.xml
index e54530806..d3eeca031 100644
--- a/entries/prevAll.xml
+++ b/entries/prevAll.xml
@@ -7,7 +7,7 @@
<desc>A string containing a selector expression to match elements against.</desc>
</argument>
</signature>
- <desc>Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector.</desc>
+ <desc>Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector, in the reverse document order.</desc>
<longdesc>
<p>Given a jQuery object that represents a set of DOM elements, the <code>.prevAll()</code> method searches through the predecessors of these elements in the DOM tree and construct a new jQuery object from the matching elements; the elements are returned in order beginning with the closest sibling.</p>
<p>The method optionally accepts a selector expression of the same type that we can pass to the <code>$()</code> function. If the selector is supplied, the elements will be filtered by testing whether they match it.</p>
@@ -26,11 +26,48 @@
$( "li.third-item" ).prevAll().css( "background-color", "red" );
</code></pre>
<p>The result of this call is a red background behind items 1 and 2. Since we do not supply a selector expression, these preceding elements are unequivocally included as part of the object. If we had supplied one, the elements would be tested for a match before they were included.</p>
+ <p><strong>Note:</strong> Many APIs, like <code><a href="/https/github.com/append/">append</a></code> or <code><a href="/https/github.com/wrapAll/">wrapAll</a></code> process node in the order in which they appear in the jQuery object. This can pose issues with APIs like <code>.prevAll()</code> in which the reverse document order is used. Consider the following example:</p>
+ <pre><code>
+<div>
+ <div>First</div>
+ <div>Second</div>
+ <div class="last-item">Last</div>
+</div>
+ </code></pre>
+ <p>The following call:</p>
+ <pre><code>
+$( ".last-item" )
+ .prevAll()
+ .wrapAll( "<div class='wrapper'></div>" );
+ </code></pre>
+ <p>would result in the following HTML:</p>
+ <pre><code>
+<div>
+ <div class="wrapper">
+ <div>Second</div>
+ <div>First</div>
+ </div>
+ <div class="last-item">Last</div>
+</div>
+ </code></pre>
+ <p>because "Item 2" gets appended to the wrapper div first. To work around the issue, you may use <code><a href="/https/github.com/uniqueSort/">.uniqueSort()</a></code> on the <code>.prevAll()</code> output first:</p>
+ <pre><code>
+$( ".last-item" )
+ .prevAll()
+ .uniqueSort()
+ .wrapAll( "<div class='wrapper'></div>" );
+ </code></pre>
+ <p>Note that the <code><a href="/https/github.com/uniqueSort/">.uniqueSort()</a></code> method is only available in jQuery 3.7.0 or newer. In older versions, you will need to use <code><a href="/https/github.com/jQuery.uniqueSort/">$.uniqueSort()</a></code> to achieve a similar effect:</p>
+ <pre><code>
+var prevSiblings = $( ".last-item" ).prevAll();
+$.uniqueSort( prevSiblings );
+prevSiblings.wrapAll( "<div class='wrapper'></div>" );
+ </code></pre>
</longdesc>
<example>
<desc>Locate all the divs preceding the last div and give them a class.</desc>
<code><![CDATA[
-$( "div:last" ).prevAll().addClass( "before" );
+$( "div" ).last().prevAll().addClass( "before" );
]]></code>
<css><![CDATA[
div {
@@ -50,6 +87,69 @@ $( "div:last" ).prevAll().addClass( "before" );
<div></div>
<div></div>
<div></div>
+]]></html>
+ </example>
+ <example>
+ <desc>Locate all the divs preceding the last item and wrap them with a div with class <code>wrapper</code> - with or without <code><a href="/https/github.com/uniqueSort/">.uniqueSort()</a></code>.</desc>
+ <code><![CDATA[
+$( "#container-1" )
+ .find( ".item" )
+ .last()
+ .prevAll()
+ .wrapAll( "<div class='wrapper' data-content='No uniqueSort'></div>" );
+
+$( "#container-2" )
+ .find( ".item" )
+ .last()
+ .prevAll()
+ .uniqueSort()
+ .wrapAll( "<div class='wrapper' data-content='With uniqueSort'></div>" );
+]]></code>
+ <css><![CDATA[
+ body {
+ display: flex;
+ }
+ .container {
+ display: flex;
+ margin: 10px 50px 10px 10px;
+ }
+ .wrapper {
+ position: relative;
+ display: flex;
+ padding: 30px 10px 10px 10px;
+ background: #def;
+ border: 2px solid black;
+ }
+ .wrapper::before {
+ content: attr(data-content);
+ position: absolute;
+ top: 15px;
+ left: 15px;
+ }
+ .item {
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ width: 70px;
+ height: 70px;
+ background: #abc;
+ border: 2px solid black;
+ margin: 10px;
+ font-size: 50px;
+ }
+]]></css>
+ <html><![CDATA[
+<div class="container" id="container-1">
+ <div class="item">1</div>
+ <div class="item">2</div>
+ <div class="item">3</div>
+</div>
+
+<div class="container" id="container-2">
+ <div class="item">1</div>
+ <div class="item">2</div>
+ <div class="item">3</div>
+</div>
]]></html>
</example>
<category slug="traversing/tree-traversal"/>
diff --git a/entries/prop.xml b/entries/prop.xml
index 49cccedae..5506d40b9 100644
--- a/entries/prop.xml
+++ b/entries/prop.xml
@@ -42,17 +42,10 @@
<tr>
<th>
<code>$( elem ).attr( "checked" )</code>
- <em>(1.6)</em>
+ <em>(1.6+)</em>
</th>
<td><code>"checked"</code> (String) Initial state of the checkbox; does not change</td>
</tr>
- <tr>
- <th>
- <code>$( elem ).attr( "checked" )</code>
- <em>(1.6.1+)</em>
- </th>
- <td><code>"checked"</code> (String) Will change with checkbox state</td>
- </tr>
<tr>
<th>
<code>$( elem ).attr( "checked" )</code>
@@ -81,13 +74,13 @@
<example>
<desc>Display the checked property and attribute of a checkbox as it changes.</desc>
<code><![CDATA[
-$( "input" ).change(function() {
+$( "input" ).on( "change", function() {
var $input = $( this );
$( "p" ).html(
".attr( \"checked\" ): <b>" + $input.attr( "checked" ) + "</b><br>" +
".prop( \"checked\" ): <b>" + $input.prop( "checked" ) + "</b><br>" +
".is( \":checked\" ): <b>" + $input.is( ":checked" ) + "</b>" );
-}).change();
+} ).trigger( "change" );
]]></code>
<css><![CDATA[
p {
@@ -144,7 +137,7 @@ $( "input" ).prop( "disabled", false );
$( "input" ).prop( "checked", true );
$( "input" ).val( "someValue" );
</code></pre>
- <p><strong>Important:</strong> the <code><a href="/https/github.com/removeProp/">.removeProp()</a></code> method should not be used to set these properties to false. Once a native property is removed, it cannot be added again. See <code><a href="/https/github.com/removeProp/">.removeProp()</a></code> for more information.</p>
+ <p><strong>Important:</strong> the <code><a href="/https/github.com/removeProp/">.removeProp()</a></code> method should not be used to remove native properties. This will lead to unexpected behavior. See <code><a href="/https/github.com/removeProp/">.removeProp()</a></code> for more information.</p>
<h4 id="computed-prop-values">Computed property values</h4>
<p>By using a function to set properties, you can compute the value based on other properties of the element. For example, to toggle all checkboxes based off their individual values:</p>
<pre><code>
diff --git a/entries/queue.xml b/entries/queue.xml
index 08c5f09aa..ec66c39fd 100644
--- a/entries/queue.xml
+++ b/entries/queue.xml
@@ -119,19 +119,19 @@ $( "#test" ).queue(function( next ) {
<example>
<desc>Queue a custom function.</desc>
<code><![CDATA[
-$( document.body ).click(function() {
+$( document.body ).on( "click", function() {
$( "div" )
.show( "slow" )
- .animate({ left: "+=200" }, 2000 )
+ .animate( { left: "+=200" }, 2000 )
.queue(function() {
$( this ).addClass( "newcolor" ).dequeue();
})
- .animate({ left: "-=200" }, 500 )
+ .animate( { left: "-=200" }, 500 )
.queue(function() {
$( this ).removeClass( "newcolor" ).dequeue();
- })
+ } )
.slideUp();
-});
+} );
]]></code>
<css><![CDATA[
div {
@@ -156,7 +156,7 @@ Click here...
<example>
<desc>Set a queue array to delete the queue.</desc>
<code><![CDATA[
-$( "#start" ).click(function() {
+$( "#start" ).on( "click", function() {
$( "div" )
.show( "slow" )
.animate({ left: "+=200" }, 5000 )
@@ -169,7 +169,7 @@ $( "#start" ).click(function() {
})
.slideUp();
});
-$( "#stop" ).click(function() {
+$( "#stop" ).on( "click", function() {
$( "div" )
.queue( "fx", [] )
.stop();
diff --git a/entries/radio-selector.xml b/entries/radio-selector.xml
index dc1944369..6b508d86e 100644
--- a/entries/radio-selector.xml
+++ b/entries/radio-selector.xml
@@ -17,19 +17,19 @@
var input = $( "form input:radio" )
.wrap( "<span></span>" )
.parent()
- .css({
+ .css( {
background: "yellow",
border: "3px red solid"
- });
+ } );
$( "div" )
.text( "For this type jQuery found " + input.length + "." )
.css( "color", "red" );
// Prevent form submission
-$( "form" ).submit(function( event ) {
+$( "form" ).on( "submit", function( event ) {
event.preventDefault();
-});
+} );
]]></code>
<css><![CDATA[
textarea {
diff --git a/entries/remove.xml b/entries/remove.xml
index 6c85e9b4e..4a7ab41cb 100644
--- a/entries/remove.xml
+++ b/entries/remove.xml
@@ -42,9 +42,9 @@ $( "div" ).remove( ".hello" );
<example>
<desc>Removes all paragraphs from the DOM</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "p" ).remove();
-});
+} );
]]></code>
<css><![CDATA[
p {
@@ -62,7 +62,7 @@ how are
<example>
<desc>Removes all paragraphs that contain "Hello" from the DOM. Analogous to doing <code>$("p").filter(":contains('Hello')").remove()</code>.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "p" ).remove( ":contains('Hello')" );
});
]]></code>
diff --git a/entries/removeAttr.xml b/entries/removeAttr.xml
index 92a92b228..6df348209 100644
--- a/entries/removeAttr.xml
+++ b/entries/removeAttr.xml
@@ -22,7 +22,7 @@ console.log( "onclick property: ", $element[ 0 ].onclick );
<code><![CDATA[
(function() {
var inputTitle = $( "input" ).attr( "title" );
- $( "button" ).click(function() {
+ $( "button" ).on( "click", function() {
var input = $( this ).next();
if ( input.attr( "title" ) === inputTitle ) {
diff --git a/entries/removeClass.xml b/entries/removeClass.xml
index a35954e9e..d66b98919 100644
--- a/entries/removeClass.xml
+++ b/entries/removeClass.xml
@@ -1,131 +1,195 @@
<?xml version="1.0"?>
-<entry type="method" name="removeClass" return="jQuery">
- <title>.removeClass()</title>
- <signature>
- <added>1.0</added>
- <argument name="className" optional="true" type="String">
- <desc>One or more space-separated classes to be removed from the class attribute of each matched element.</desc>
- </argument>
- </signature>
- <signature>
- <added>1.4</added>
- <argument name="function" type="Function">
- <argument name="index" type="Integer" />
- <argument name="className" type="String" />
- <return type="String" />
- <desc>A function returning one or more space-separated class names to be removed. Receives the index position of the element in the set and the old class value as arguments.</desc>
- </argument>
- </signature>
+<entries>
<desc>Remove a single class, multiple classes, or all classes from each element in the set of matched elements.</desc>
- <longdesc>
- <p>If a class name is included as a parameter, then only that class will be removed from the set of matched elements. If no class names are specified in the parameter, all classes will be removed.</p>
- <p>Before jQuery version 1.12/2.2, the <code>.removeClass()</code> method manipulated the <code>className</code> <em>property</em> of the selected elements, not the <code>class</code> <em>attribute</em>. Once the property was changed, it was the browser that updated the attribute accordingly. This means that when the <code>class</code> attribute was updated and the last class name was removed, the browser might have set the attribute's value to an empty string instead of removing the attribute completely. An implication of this behavior was that this method only worked for documents with HTML DOM semantics (e.g., not pure XML documents).</p>
- <p>As of jQuery 1.12/2.2, this behavior is changed to improve the support for XML documents, including SVG. Starting from this version, the <code>class</code> <em>attribute</em> is used instead. So, <code>.removeClass()</code> can be used on XML or SVG documents.</p>
- <p>More than one class may be removed at a time, separated by a space, from the set of matched elements, like so:</p>
- <pre><code>
-$( "p" ).removeClass( "myClass yourClass" )
- </code></pre>
- <p>This method is often used with <code>.addClass()</code> to switch elements' classes from one to another, like so:</p>
- <pre><code>
-$( "p" ).removeClass( "myClass noClass" ).addClass( "yourClass" );
- </code></pre>
- <p>Here, the <code>myClass</code> and <code>noClass</code> classes are removed from all paragraphs, while <code>yourClass</code> is added.</p>
- <p>To replace all existing classes with another class, we can use <code>.attr( "class", "newClass" )</code> instead.</p>
- <p>As of jQuery 1.4, the <code>.removeClass()</code> method allows us to indicate the class to be removed by passing in a function.</p>
- <pre><code>
-$( "li:last" ).removeClass(function() {
- return $( this ).prev().attr( "class" );
-});
- </code></pre>
- <p>This example removes the class name of the penultimate <code><li></code> from the last <code><li></code>.</p>
- </longdesc>
- <example>
- <desc>Remove the class 'blue' from the matched elements.</desc>
- <code><![CDATA[
-$( "p:even" ).removeClass( "blue" );
-]]></code>
- <css><![CDATA[
- p {
- margin: 4px;
- font-size: 16px;
- font-weight: bolder;
- }
- .blue {
- color: blue;
- }
- .under {
- text-decoration: underline;
- }
- .highlight {
- background: yellow;
- }
-]]></css>
- <html><![CDATA[
-<p class="blue under">Hello</p>
-<p class="blue under highlight">and</p>
-<p class="blue under">then</p>
-<p class="blue under">Goodbye</p>
-]]></html>
- </example>
- <example>
- <desc>Remove the class 'blue' and 'under' from the matched elements.</desc>
- <code><![CDATA[
-$( "p:odd" ).removeClass( "blue under" );
-]]></code>
- <css><![CDATA[
- p {
- margin: 4px;
- font-size: 16px;
- font-weight: bolder;
- }
- .blue {
- color: blue;
- }
- .under {
- text-decoration: underline;
- }
- .highlight {
- background: yellow;
- }
-]]></css>
- <html><![CDATA[
-<p class="blue under">Hello</p>
-<p class="blue under highlight">and</p>
-<p class="blue under">then</p>
-<p class="blue under">Goodbye</p>
-]]></html>
- </example>
- <example>
- <desc>Remove all the classes from the matched elements.</desc>
- <code><![CDATA[
-$( "p:eq(1)" ).removeClass();
-]]></code>
- <css><![CDATA[
- p {
- margin: 4px;
- font-size: 16px;
- font-weight: bolder;
- }
- .blue {
- color: blue;
- }
- .under {
- text-decoration: underline;
- }
- .highlight {
- background: yellow;
- }
-]]></css>
- <html><![CDATA[
-<p class="blue under">Hello</p>
-<p class="blue under highlight">and</p>
-<p class="blue under">then</p>
-<p class="blue under">Goodbye</p>
-]]></html>
- </example>
- <category slug="attributes"/>
- <category slug="manipulation/class-attribute"/>
- <category slug="css"/>
- <category slug="version/1.0"/>
- <category slug="version/1.4"/>
-</entry>
+ <entry type="method" name="removeClass" return="jQuery">
+ <title>.removeClass()</title>
+ <signature>
+ <added>1.0</added>
+ <argument name="className" type="String">
+ <desc>One or more space-separated classes to be removed from the class attribute of each matched element.</desc>
+ </argument>
+ </signature>
+ <signature>
+ <added>3.3</added>
+ <argument name="classNames" type="Array">
+ <desc>An array of classes to be removed from the class attribute of each matched element.</desc>
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4</added>
+ <argument name="function" type="Function">
+ <argument name="index" type="Integer" />
+ <argument name="className" type="String" />
+ <return type="String" />
+ <desc>A function returning one or more space-separated class names to be removed. Receives the index position of the element in the set and the old class value as arguments.</desc>
+ </argument>
+ </signature>
+ <signature>
+ <added>3.3</added>
+ <argument name="function" type="Function">
+ <argument name="index" type="Integer" />
+ <argument name="className" type="String" />
+ <return type="String" />
+ <return type="Array" />
+ <desc>A function returning one or more space-separated class names or an array of class names to be removed. Receives the index position of the element in the set and the old class value as arguments.</desc>
+ </argument>
+ </signature>
+ <desc>Remove a single class or multiple classes from each element in the set of matched elements.</desc>
+ <longdesc>
+ <p>Before jQuery version 1.12/2.2, the <code>.removeClass()</code> method manipulated the <code>className</code> <em>property</em> of the selected elements, not the <code>class</code> <em>attribute</em>. Once the property was changed, it was the browser that updated the attribute accordingly. This means that when the <code>class</code> attribute was updated and the last class name was removed, the browser might have set the attribute's value to an empty string instead of removing the attribute completely. An implication of this behavior was that this method only worked for documents with HTML DOM semantics (e.g., not pure XML documents).</p>
+ <p>As of jQuery 1.12/2.2, this behavior is changed to improve the support for XML documents, including SVG. Starting from this version, the <code>class</code> <em>attribute</em> is used instead. So, <code>.removeClass()</code> can be used on XML or SVG documents.</p>
+ <p>More than one class may be removed at a time, separated by a space, from the set of matched elements, like so:</p>
+ <pre><code>
+ $( "p" ).removeClass( "myClass yourClass" )
+ </code></pre>
+ <p>This method is often used with <code>.addClass()</code> to switch elements' classes from one to another, like so:</p>
+ <pre><code>
+ $( "p" ).removeClass( "myClass noClass" ).addClass( "yourClass" );
+ </code></pre>
+ <p>Here, the <code>myClass</code> and <code>noClass</code> classes are removed from all paragraphs, while <code>yourClass</code> is added.</p>
+ <p>To replace all existing classes with another class, we can use <code>.attr( "class", "newClass" )</code> instead.</p>
+ <p>As of jQuery 1.4, the <code>.removeClass()</code> method allows us to indicate the class to be removed by passing in a function.</p>
+ <pre><code>
+ $( "li" ).last().removeClass(function() {
+ return $( this ).prev().attr( "class" );
+ });
+ </code></pre>
+ <p>This example removes the class name of the penultimate <code><li></code> from the last <code><li></code>.</p>
+ </longdesc>
+ <example>
+ <desc>Remove the class 'blue' from the matched elements.</desc>
+ <code><![CDATA[
+ $( "p" ).even().removeClass( "blue" );
+ ]]></code>
+ <css><![CDATA[
+ p {
+ margin: 4px;
+ font-size: 16px;
+ font-weight: bolder;
+ }
+ .blue {
+ color: blue;
+ }
+ .under {
+ text-decoration: underline;
+ }
+ .highlight {
+ background: yellow;
+ }
+ ]]></css>
+ <html><![CDATA[
+ <p class="blue under">Hello</p>
+ <p class="blue under highlight">and</p>
+ <p class="blue under">then</p>
+ <p class="blue under">Goodbye</p>
+ ]]></html>
+ </example>
+ <example>
+ <desc>Remove the class 'blue' and 'under' from the matched elements.</desc>
+ <code><![CDATA[
+ $( "p" ).odd().removeClass( "blue under" );
+ ]]></code>
+ <css><![CDATA[
+ p {
+ margin: 4px;
+ font-size: 16px;
+ font-weight: bolder;
+ }
+ .blue {
+ color: blue;
+ }
+ .under {
+ text-decoration: underline;
+ }
+ .highlight {
+ background: yellow;
+ }
+ ]]></css>
+ <html><![CDATA[
+ <p class="blue under">Hello</p>
+ <p class="blue under highlight">and</p>
+ <p class="blue under">then</p>
+ <p class="blue under">Goodbye</p>
+ ]]></html>
+ </example>
+ <example>
+ <desc>Remove the class 'blue' and 'under' from the matched elements (3.3+ syntax).</desc>
+ <code><![CDATA[
+ $( "p" ).odd().removeClass( [ "blue", "under" ] );
+ ]]></code>
+ <css><![CDATA[
+ p {
+ margin: 4px;
+ font-size: 16px;
+ font-weight: bolder;
+ }
+ .blue {
+ color: blue;
+ }
+ .under {
+ text-decoration: underline;
+ }
+ .highlight {
+ background: yellow;
+ }
+ ]]></css>
+ <html><![CDATA[
+ <p class="blue under">Hello</p>
+ <p class="blue under highlight">and</p>
+ <p class="blue under">then</p>
+ <p class="blue under">Goodbye</p>
+ ]]></html>
+ </example>
+ <category slug="attributes"/>
+ <category slug="manipulation/class-attribute"/>
+ <category slug="css"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4"/>
+ <category slug="version/1.12-and-2.2"/>
+ <category slug="version/3.3"/>
+ </entry>
+
+ <entry type="method" name="removeClass" return="jQuery">
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <desc>Remove all classes from each matched element.</desc>
+ <longdesc>
+ <p>Before jQuery version 1.12/2.2, the <code>.removeClass()</code> method manipulated the <code>className</code> <em>property</em> of the selected elements, not the <code>class</code> <em>attribute</em>. Once the property was changed, it was the browser that updated the attribute accordingly. This means that when the <code>class</code> attribute was updated and the last class name was removed, the browser might have set the attribute's value to an empty string instead of removing the attribute completely. An implication of this behavior was that this method only worked for documents with HTML DOM semantics (e.g., not pure XML documents).</p>
+ <p>As of jQuery 1.12/2.2, this behavior is changed to improve the support for XML documents, including SVG. Starting from this version, the <code>class</code> <em>attribute</em> is used instead. So, <code>.removeClass()</code> can be used on XML or SVG documents.</p>
+ </longdesc>
+ <example>
+ <desc>Remove all the classes from the matched elements.</desc>
+ <code><![CDATA[
+ $( "p" ).eq( 1 ).removeClass();
+ ]]></code>
+ <css><![CDATA[
+ p {
+ margin: 4px;
+ font-size: 16px;
+ font-weight: bolder;
+ }
+ .blue {
+ color: blue;
+ }
+ .under {
+ text-decoration: underline;
+ }
+ .highlight {
+ background: yellow;
+ }
+ ]]></css>
+ <html><![CDATA[
+ <p class="blue under">Hello</p>
+ <p class="blue under highlight">and</p>
+ <p class="blue under">then</p>
+ <p class="blue under">Goodbye</p>
+ ]]></html>
+ </example>
+ <category slug="attributes"/>
+ <category slug="manipulation/class-attribute"/>
+ <category slug="css"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.12-and-2.2"/>
+ </entry>
+</entries>
diff --git a/entries/removeData.xml b/entries/removeData.xml
index 3c2cf8ff4..e4dd08b1f 100644
--- a/entries/removeData.xml
+++ b/entries/removeData.xml
@@ -28,13 +28,13 @@
<example>
<desc>Set a data store for 2 names then remove one of them.</desc>
<code><![CDATA[
-$( "span:eq(0)" ).text( "" + $( "div" ).data( "test1" ) );
+$( "span" ).eq( 0 ).text( "" + $( "div" ).data( "test1" ) );
$( "div" ).data( "test1", "VALUE-1" );
$( "div" ).data( "test2", "VALUE-2" );
-$( "span:eq(1)" ).text( "" + $( "div").data( "test1" ) );
+$( "span" ).eq( 1 ).text( "" + $( "div").data( "test1" ) );
$( "div" ).removeData( "test1" );
-$( "span:eq(2)" ).text( "" + $( "div" ).data( "test1" ) );
-$( "span:eq(3)" ).text( "" + $( "div" ).data( "test2" ) );
+$( "span" ).eq( 2 ).text( "" + $( "div" ).data( "test1" ) );
+$( "span" ).eq( 3 ).text( "" + $( "div" ).data( "test2" ) );
]]></code>
<css><![CDATA[
div {
diff --git a/entries/removeProp.xml b/entries/removeProp.xml
index 987ab339b..cc918d297 100644
--- a/entries/removeProp.xml
+++ b/entries/removeProp.xml
@@ -10,8 +10,8 @@
<desc>Remove a property for the set of matched elements.</desc>
<longdesc>
<p>The <code>.removeProp()</code> method removes properties set by the <code><a href="/https/github.com/prop/">.prop()</a></code> method.</p>
- <p>With some built-in properties of a DOM element or <code>window</code> object, browsers may generate an error if an attempt is made to remove the property. jQuery first assigns the value <code>undefined</code> to the property and ignores any error the browser generates. In general, it is only necessary to remove custom properties that have been set on an object, and not built-in (native) properties.</p>
- <p><strong>Note:</strong> Do not use this method to remove native properties such as checked, disabled, or selected. This will remove the property completely and, once removed, cannot be added again to element. Use <code><a href="/https/github.com/prop/">.prop()</a></code> to set these properties to <code>false</code> instead.</p>
+ <p><strong>Note:</strong>This method should not be used to remove built-in (native) properties such as "checked", "disabled", "selected", or others. This can lead to unexpected behavior.</p>
+ <p>It's almost always better to use <code><a href="/https/github.com/prop/">.prop()</a></code> to set native properties to <code>false</code> instead of removing them.</p>
</longdesc>
<note id="prop-memory-leaks" type="additional"/>
<example>
diff --git a/entries/replaceWith.xml b/entries/replaceWith.xml
index dfdd39a79..219e3e640 100644
--- a/entries/replaceWith.xml
+++ b/entries/replaceWith.xml
@@ -69,7 +69,7 @@ $( "div.third" ).replaceWith( $( ".first" ) );
<example>
<desc>On click, replace the button with a div containing the same word.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( this ).replaceWith( "<div>" + $( this ).text() + "</div>" );
});
]]></code>
@@ -108,7 +108,7 @@ $( "p" ).replaceWith( "<b>Paragraph. </b>" );
<example>
<desc>On click, replace each paragraph with a div that is already in the DOM and selected with the <code>$()</code> function. Notice it doesn't clone the object but rather moves it to replace the paragraph.</desc>
<code><![CDATA[
-$( "p" ).click(function() {
+$( "p" ).on( "click", function() {
$( this ).replaceWith( $( "div" ) );
});
]]></code>
diff --git a/entries/reset-selector.xml b/entries/reset-selector.xml
index 301b0e5e2..db5586086 100644
--- a/entries/reset-selector.xml
+++ b/entries/reset-selector.xml
@@ -13,18 +13,18 @@
<example>
<desc>Finds all reset inputs.</desc>
<code><![CDATA[
-var input = $( "input:reset" ).css({
+var input = $( "input:reset" ).css( {
background: "yellow",
border: "3px red solid"
-});
+} );
$( "div" )
.text( "For this type jQuery found " + input.length + "." )
.css( "color", "red" );
// Prevent form submission
-$( "form" ).submit(function( event ) {
+$( "form" ).on( "submit", function( event ) {
event.preventDefault();
-});
+} );
]]></code>
<css><![CDATA[
textarea {
diff --git a/entries/resize-shorthand.xml b/entries/resize-shorthand.xml
new file mode 100644
index 000000000..31f69a5d0
--- /dev/null
+++ b/entries/resize-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="resize" return="jQuery" deprecated="3.3">
+ <title>.resize()</title>
+ <desc>Bind an event handler to the "resize" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.resize( handler )</code> or <code>.resize( eventData, handler )</code>, use <a href="/https/github.com/resize/#on1"><code>.on( "resize", handler )</code></a> or <a href="/https/github.com/resize/#on1"><code>.on( "resize", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.resize()</code>, use <a href="/https/github.com/resize/#trigger2"><code>.trigger( "resize" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/browser-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/resize.xml b/entries/resize.xml
index 3c4f844d3..74cc61fe8 100644
--- a/entries/resize.xml
+++ b/entries/resize.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="resize" return="jQuery">
- <title>.resize()</title>
- <desc>Bind an event handler to the "resize" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+
+<desc>Bind an event handler to the "resize" event, or trigger that event on an element.</desc>
+<entry type="method" name="on" return="jQuery">
+ <title>resize event</title>
+ <desc>Bind an event handler to the "resize" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""resize"" type="string">
+ <desc>The string <code>"resize"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,30 +18,46 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on('resize', handler)</code> in the first and second variations, and <code>.trigger( "resize" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>resize</code> event. For the deprecated <code>.resize()</code> method, see <a href="/https/github.com/resize-shorthand/"><code>.resize()</code></a>.</p>
+ </div>
<p>The <code>resize</code> event is sent to the <code>window</code> element when the size of the browser window changes:</p>
<pre><code>
-$( window ).resize(function() {
- $( "#log" ).append( "<div>Handler for .resize() called.</div>" );
-});
+$( window ).on( "resize", function() {
+ $( "#log" ).append( "<div>Handler for `resize` called.</div>" );
+} );
</code></pre>
<p>Now whenever the browser window's size is changed, the message is appended to <div id="log"> one or more times, depending on the browser.</p>
<p>Code in a <code>resize</code> handler should never rely on the number of times the handler is called. Depending on implementation, <code>resize</code> events can be sent continuously as the resizing is in progress (the typical behavior in Internet Explorer and WebKit-based browsers such as Safari and Chrome), or only once at the end of the resize operation (the typical behavior in some other browsers such as Opera).</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="resize"/>
<example>
<desc>To see the window width while (or after) it is resized, try:</desc>
<code><![CDATA[
-$( window ).resize(function() {
+$( window ).on( "resize", function() {
$( "body" ).prepend( "<div>" + $( window ).width() + "</div>" );
-});
+} );
]]></code>
</example>
<category slug="events/browser-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>resize event</title>
+ <desc>Trigger the "resize" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""resize"" type="string">
+ <desc>The string <code>"resize"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "resize", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/browser-events"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/scroll-shorthand.xml b/entries/scroll-shorthand.xml
new file mode 100644
index 000000000..67b7997ed
--- /dev/null
+++ b/entries/scroll-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="scroll" return="jQuery" deprecated="3.3">
+ <title>.scroll()</title>
+ <desc>Bind an event handler to the "scroll" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.scroll( handler )</code> or <code>.scroll( eventData, handler )</code>, use <a href="/https/github.com/scroll/#on1"><code>.on( "scroll", handler )</code></a> or <a href="/https/github.com/scroll/#on1"><code>.on( "scroll", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.scroll()</code>, use <a href="/https/github.com/scroll/#trigger2"><code>.trigger( "scroll" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/browser-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/scroll.xml b/entries/scroll.xml
index 8529cb0c7..5f46ddfe0 100644
--- a/entries/scroll.xml
+++ b/entries/scroll.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="scroll" return="jQuery">
- <title>.scroll()</title>
- <desc>Bind an event handler to the "scroll" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+
+<desc>Bind an event handler to the "scroll" event, or trigger that event on an element.</desc>
+<entry type="method" name="on" return="jQuery">
+ <title>scroll event</title>
+ <desc>Bind an event handler to the "scroll" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""scroll"" type="string">
+ <desc>The string <code>"scroll"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "scroll", handler )</code> in the first and second variations, and <code>.trigger( "scroll" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>scroll</code> event. For the deprecated <code>.scroll()</code> method, see <a href="/https/github.com/scroll-shorthand/"><code>.scroll()</code></a>.</p>
+ </div>
<p>The <code>scroll</code> event is sent to an element when the user scrolls to a different place in the element. It applies to <code>window</code> objects, but also to scrollable frames and elements with the <code>overflow </code>CSS property set to <code>scroll</code> (or <code>auto</code> when the element's explicit height or width is less than the height or width of its contents).</p>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -41,7 +39,7 @@
Trigger the handler
</div>
<div id="log"></div>
-</code></pre>
+ </code></pre>
<p>The style definition is present to make the target element small enough to be scrollable:</p>
<figure>
<img src="/https/github.com/resources/0042_05_11.png" alt=""/>
@@ -49,33 +47,32 @@
</figure>
<p>The <code>scroll</code> event handler can be bound to this element:</p>
<pre><code>
-$( "#target" ).scroll(function() {
- $( "#log" ).append( "<div>Handler for .scroll() called.</div>" );
-});
+$( "#target" ).on( "scroll", function() {
+ $( "#log" ).append( "<div>Handler for `scroll` called.</div>" );
+} );
</code></pre>
<p>Now when the user scrolls the text up or down, one or more messages are appended to <code><div id="log"></div></code>:</p>
<p>
- <samp>Handler for .scroll() called.</samp>
+ <samp>Handler for `scroll` called.</samp>
</p>
- <p>To trigger the event manually, apply <code>.scroll()</code> without an argument:</p>
+ <p>To trigger the event manually, use <code>.trigger( "scroll" )</code>:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#target" ).scroll();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "scroll" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also append the message.</p>
<p>A <code>scroll</code> event is sent whenever the element's scroll position changes, regardless of the cause. A mouse click or drag on the scroll bar, dragging inside the element, pressing the arrow keys, or using the mouse's scroll wheel could cause this event.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="scroll"/>
<example>
<desc>To do something when your page is scrolled:</desc>
<code><![CDATA[
$( "p" ).clone().appendTo( document.body );
$( "p" ).clone().appendTo( document.body );
$( "p" ).clone().appendTo( document.body );
-$( window ).scroll(function() {
+$( window ).on( "scroll", function() {
$( "span" ).css( "display", "inline" ).fadeOut( "slow" );
-});
+} );
]]></code>
<css><![CDATA[
div {
@@ -96,5 +93,23 @@ $( window ).scroll(function() {
</example>
<category slug="events/browser-events"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>scroll event</title>
+ <desc>Trigger the "scroll" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""scroll"" type="string">
+ <desc>The string <code>"scroll"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "scroll", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/browser-events"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/scrollLeft.xml b/entries/scrollLeft.xml
index 2b53896bd..7fe21491a 100644
--- a/entries/scrollLeft.xml
+++ b/entries/scrollLeft.xml
@@ -16,8 +16,8 @@
<example>
<desc>Get the scrollLeft of a paragraph.</desc>
<code><![CDATA[
-var p = $( "p:first" );
-$( "p:last" ).text( "scrollLeft:" + p.scrollLeft() );
+var p = $( "p" ).first();
+$( "p" ).last().text( "scrollLeft:" + p.scrollLeft() );
]]></code>
<css><![CDATA[
p {
diff --git a/entries/scrollTop.xml b/entries/scrollTop.xml
index 9f0ec14e5..18250efae 100644
--- a/entries/scrollTop.xml
+++ b/entries/scrollTop.xml
@@ -12,8 +12,8 @@
<example>
<desc>Get the scrollTop of a paragraph.</desc>
<code><![CDATA[
-var p = $( "p:first" );
-$( "p:last" ).text( "scrollTop:" + p.scrollTop() );
+var p = $( "p" ).first();
+$( "p" ).last().text( "scrollTop:" + p.scrollTop() );
]]></code>
<css><![CDATA[
p {
diff --git a/entries/select-shorthand.xml b/entries/select-shorthand.xml
new file mode 100644
index 000000000..e3fb02279
--- /dev/null
+++ b/entries/select-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="select" return="jQuery" deprecated="3.3">
+ <title>.select()</title>
+ <desc>Bind an event handler to the "select" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.select( handler )</code> or <code>.select( eventData, handler )</code>, use <a href="/https/github.com/select/#on1"><code>.on( "select", handler )</code></a> or <a href="/https/github.com/select/#on1"><code>.on( "select", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.select()</code>, use <a href="/https/github.com/select/#trigger2"><code>.trigger( "select" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/select.xml b/entries/select.xml
index 244cee7cb..605738810 100644
--- a/entries/select.xml
+++ b/entries/select.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="select" return="jQuery">
- <title>.select()</title>
- <desc>Bind an event handler to the "select" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+<desc>Bind an event handler to the "select" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>select event</title>
+ <desc>Bind an event handler to the "select" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""select"" type="string">
+ <desc>The string <code>"select"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "select", handler )</code> in the first two variations, and <code>.trigger( "select" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>select</code> event. For the deprecated <code>.select()</code> method, see <a href="/https/github.com/select-shorthand/"><code>.select()</code></a>.</p>
+ </div>
<p>The <code>select</code> event is sent to an element when the user makes a text selection inside it. This event is limited to <code><input type="text"></code> fields and <code><textarea></code> boxes.</p>
<p>For example, consider the HTML:</p>
<pre><code>
@@ -35,32 +33,31 @@
</div></code></pre>
<p>The event handler can be bound to the text input:</p>
<pre><code>
-$( "#target" ).select(function() {
- alert( "Handler for .select() called." );
-});
+$( "#target" ).on( "select", function() {
+ alert( "Handler for `select` called." );
+} );
</code></pre>
- <p>Now when any portion of the text is selected, the alert is displayed. Merely setting the location of the insertion point will not trigger the event. To trigger the event manually, apply <code>.select()</code> without an argument:</p>
+ <p>Now when any portion of the text is selected, the alert is displayed. Merely setting the location of the insertion point will not trigger the event. To trigger the event manually, use <code>.trigger( "select" )</code>:</p>
<pre><code>
-$( "#other").click(function() {
- $( "#target" ).select();
-});
+$( "#other").on( "click", function() {
+ $( "#target" ).trigger( "select" );
+} );
</code></pre>
<p>After this code executes, clicks on the Trigger button will also alert the message:</p>
<p>
- <samp>Handler for .select() called.</samp>
+ <samp>Handler for `select` called.</samp>
</p>
<p>In addition, the default <code>select</code> action on the field will be fired, so the entire text field will be selected.</p>
<div class="warning">
<p>The method for retrieving the current selected text differs from one browser to another. A number of jQuery plug-ins offer cross-platform solutions.</p>
</div>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="select"/>
<example>
<desc>To do something when text in input boxes is selected:</desc>
<code><![CDATA[
-$( ":input" ).select(function() {
+$( ":input" ).on( "select", function() {
$( "div" ).text( "Something was selected" ).show().fadeOut( 1000 );
-});
+} );
]]></code>
<css><![CDATA[
p {
@@ -80,11 +77,29 @@ $( ":input" ).select(function() {
<example>
<desc>To trigger the select event on all input elements, try:</desc>
<code><![CDATA[
-$( "input" ).select();
+$( "input" ).trigger( "select" );
]]></code>
</example>
<category slug="events/form-events"/>
<category slug="forms"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>select event</title>
+ <desc>Trigger the "select" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""select"" type="string">
+ <desc>The string <code>"select"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "select", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/selected-selector.xml b/entries/selected-selector.xml
index c96bf422f..5eb6cef8d 100644
--- a/entries/selected-selector.xml
+++ b/entries/selected-selector.xml
@@ -14,13 +14,13 @@
<desc>Attaches a change event to the select that gets the text for each selected option and writes them in the div. It then triggers the event for the initial text draw.</desc>
<code><![CDATA[
$( "select" )
- .change(function() {
+ .on( "change", function() {
var str = "";
$( "select option:selected" ).each(function() {
str += $( this ).text() + " ";
- });
+ } );
$( "div" ).text( str );
- })
+ } )
.trigger( "change" );
]]></code>
<css><![CDATA[
diff --git a/entries/selector.xml b/entries/selector.xml
index d64fc0aa1..229e674b9 100644
--- a/entries/selector.xml
+++ b/entries/selector.xml
@@ -6,7 +6,9 @@
</signature>
<desc>A selector representing selector passed to jQuery(), if any, when creating the original set.</desc>
<longdesc>
- <p>The <code>.selector</code> property was deprecated in jQuery 1.7 and is only maintained to the extent needed for supporting <code>.live()</code> in the jQuery Migrate plugin. It may be removed without notice in a future version. The property was never a reliable indicator of the selector that could be used to obtain the set of elements currently contained in the jQuery set where it was a property, since subsequent traversal methods may have changed the set. Plugins that need to use a selector string within their plugin can require it as a parameter of the method. For example, a "foo" plugin could be written as <code>$.fn.foo = function( selector, options ) { /* plugin code goes here */ };</code>, and the person using the plugin would write <code>$( "div.bar" ).foo( "div.bar", {dog: "bark"} );</code> with the <code>"div.bar"</code> selector repeated as the first argument of <code>.foo()</code>.</p>
+ <div class="warning">
+ <p>Note: This API has been removed in jQuery 3.0. The property was never a reliable indicator of the selector that could be used to obtain the set of elements currently contained in the jQuery set where it was a property, since subsequent traversal methods may have changed the set. Plugins that need to use a selector string within their plugin can require it as a parameter of the method. For example, a "foo" plugin could be written as <code>$.fn.foo = function( selector, options ) { /* plugin code goes here */ };</code>, and the person using the plugin would write <code>$( "div.bar" ).foo( "div.bar", {dog: "bark"} );</code> with the <code>"div.bar"</code> selector repeated as the first argument of <code>.foo()</code>.</p>
+ </div>
</longdesc>
<category slug="internals"/>
<category slug="properties/jquery-object-instance-properties"/>
diff --git a/entries/serializeArray.xml b/entries/serializeArray.xml
index b2df233e1..09125d062 100644
--- a/entries/serializeArray.xml
+++ b/entries/serializeArray.xml
@@ -31,10 +31,10 @@
<p>The <code>.serializeArray()</code> method uses the standard W3C rules for <a href="https://www.w3.org/TR/html401/interact/forms.html#h-17.13.2">successful controls</a> to determine which elements it should include; in particular the element cannot be disabled and must contain a <code>name</code> attribute. No submit button value is serialized since the form was not submitted using a button. Data from file select elements is not serialized. Elements that do not contain a <code>value</code> attribute are represented with the empty string value.</p>
<p>This method can act on a jQuery object that has selected individual form controls, such as <code><input></code>, <code><textarea></code>, and <code><select></code>. However, it is typically easier to select the <code><form></code> element itself for serialization:</p>
<pre><code>
-$( "form" ).submit(function( event ) {
+$( "form" ).on( "submit", function( event ) {
console.log( $( this ).serializeArray() );
event.preventDefault();
-});
+} );
</code></pre>
<p>This produces the following data structure (provided that the browser supports <code>console.log</code>):</p>
<pre><code>
@@ -70,11 +70,11 @@ $( "form" ).submit(function( event ) {
$( "#results" ).empty();
jQuery.each( fields, function( i, field ) {
$( "#results" ).append( field.value + " " );
- });
+ } );
}
- $( ":checkbox, :radio" ).click( showValues );
- $( "select" ).change( showValues );
+ $( ":checkbox, :radio" ).on( "click", showValues );
+ $( "select" ).on( "change", showValues );
showValues();
]]></code>
<css><![CDATA[
diff --git a/entries/show.xml b/entries/show.xml
index c47faccc6..2ce1c4a4c 100644
--- a/entries/show.xml
+++ b/entries/show.xml
@@ -49,7 +49,7 @@ $( ".target" ).show();
</div>
<img id="book" src="book.png" alt="" width="100" height="123">
With the element initially hidden, we can show it slowly:
-$( "#clickme" ).click(function() {
+$( "#clickme" ).on( "click", function() {
$( "#book" ).show( "slow", function() {
// Animation complete.
});
@@ -67,7 +67,7 @@ $( "#clickme" ).click(function() {
<example>
<desc>Animates all hidden paragraphs to show slowly, completing the animation within 600 milliseconds.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "p" ).show( "slow" );
});
]]></code>
@@ -84,13 +84,13 @@ $( "button" ).click(function() {
<example>
<desc>Show the first div, followed by each next adjacent sibling div in order, with a 200ms animation. Each animation starts when the previous sibling div's animation ends.</desc>
<code><![CDATA[
-$( "#showr" ).click(function() {
+$( "#showr" ).on( "click", function() {
$( "div" ).first().show( "fast", function showNext() {
$( this ).next( "div" ).show( "fast", showNext );
});
});
-$( "#hidr" ).click(function() {
+$( "#hidr" ).on( "click", function() {
$( "div" ).hide( 1000 );
});
]]></code>
@@ -120,19 +120,19 @@ function doIt() {
$( "span,div" ).show( "slow" );
}
// Can pass in function name
-$( "button" ).click( doIt );
+$( "button" ).on( "click", doIt );
-$( "form" ).submit(function( event ) {
+$( "form" ).on( "submit", function( event ) {
if ( $( "input" ).val() === "yes" ) {
$( "p" ).show( 4000, function() {
$( this ).text( "Ok, DONE! (now showing)" );
- });
+ } );
}
$( "span,div" ).hide( "fast" );
// Prevent form submission
event.preventDefault();
-});
+} );
]]></code>
<css><![CDATA[
span {
diff --git a/entries/size.xml b/entries/size.xml
index e7dd1223f..a6e03e46f 100644
--- a/entries/size.xml
+++ b/entries/size.xml
@@ -6,7 +6,9 @@
</signature>
<desc>Return the number of elements in the jQuery object.</desc>
<longdesc>
- <p>The <code>.size()</code> method is deprecated as of jQuery 1.8. Use the <code><a href="/https/github.com/length/">.length</a></code> property instead.</p>
+ <div class="warning">
+ <p>Note: This method has been removed in jQuery 3.0. Use the <code><a href="/https/github.com/length/">.length</a></code> property instead.</p>
+ </div>
<p>The <code>.size()</code> method is functionally equivalent to the <code><a href="/https/github.com/length/">.length</a></code> property; however, <strong>the <code>.length</code> property is preferred</strong> because it does not have the overhead of a function call.</p>
<p>Given a simple unordered list on the page:</p>
@@ -30,38 +32,18 @@ alert( "Size: " + $( "li" ).length );
</p>
</longdesc>
<example>
- <desc>Count the divs. Click to add more.</desc>
+ <desc>Count the divs.</desc>
<code><![CDATA[
$( document.body )
- .click(function() {
+ .on( "click", function() {
$( this ).append( $( "<div>" ) );
var n = $( "div" ).size();
$( "span" ).text( "There are " + n + " divs. Click to add more." );
- })
+ } )
// Trigger the click to start
- .click();
+ .trigger( "click" );
]]></code>
- <css><![CDATA[
- body {
- cursor: pointer;
- min-height: 100px;
- }
- div {
- width: 50px;
- height: 30px;
- margin: 5px;
- float: left;
- background: blue;
- }
- span {
- color: red;
- }
-]]></css>
- <html><![CDATA[
-<span></span>
-<div></div>
-]]></html>
</example>
<category slug="miscellaneous/dom-element-methods"/>
<category slug="version/1.0"/>
diff --git a/entries/slice.xml b/entries/slice.xml
index 81d76c989..8f94ce16a 100644
--- a/entries/slice.xml
+++ b/entries/slice.xml
@@ -62,7 +62,7 @@ function colorEm() {
").css( 'background', 'yellow' );" );
}
-$( "button" ).click( colorEm );
+$( "button" ).on( "click", colorEm );
]]></code>
<css><![CDATA[
div {
diff --git a/entries/slideDown.xml b/entries/slideDown.xml
index d4f275446..e70c81f79 100644
--- a/entries/slideDown.xml
+++ b/entries/slideDown.xml
@@ -30,7 +30,7 @@
</code></pre>
<p>With the element initially hidden, we can show it slowly:</p>
<pre><code>
-$( "#clickme" ).click(function() {
+$( "#clickme" ).on( "click", function() {
$( "#book" ).slideDown( "slow", function() {
// Animation complete.
});
@@ -54,13 +54,13 @@ $( "#clickme" ).click(function() {
<example>
<desc>Animates all divs to slide down and show themselves over 600 milliseconds.</desc>
<code><![CDATA[
-$( document.body ).click(function () {
- if ( $( "div:first" ).is( ":hidden" ) ) {
+$( document.body ).on( "click", function () {
+ if ( $( "div" ).first().is( ":hidden" ) ) {
$( "div" ).slideDown( "slow" );
} else {
$( "div" ).hide();
}
-});
+} );
]]></code>
<css><![CDATA[
div {
@@ -82,20 +82,20 @@ Click me!
<example>
<desc>Animates all inputs to slide down, completing the animation within 1000 milliseconds. Once the animation is done, the input look is changed especially if it is the middle input which gets the focus.</desc>
<code><![CDATA[
-$( "div" ).click(function() {
- $( this ).css({
+$( "div" ).on( "click", function() {
+ $( this ).css( {
borderStyle: "inset",
cursor: "wait"
- });
+ } );
$( "input" ).slideDown( 1000, function() {
$( this )
.css( "border", "2px red inset" )
.filter( ".middle" )
.css( "background", "yellow" )
- .focus();
+ .trigger( "focus" );
$( "div" ).css( "visibility", "hidden" );
- });
-});
+ } );
+} );
]]></code>
<css><![CDATA[
diff --git a/entries/slideToggle.xml b/entries/slideToggle.xml
index ecf801a6e..9a91bed87 100644
--- a/entries/slideToggle.xml
+++ b/entries/slideToggle.xml
@@ -30,7 +30,7 @@
</code></pre>
<p>We will cause <code>.slideToggle()</code> to be called when another element is clicked:</p>
<pre><code>
-$( "#clickme" ).click(function() {
+$( "#clickme" ).on( "click", function() {
$( "#book" ).slideToggle( "slow", function() {
// Animation complete.
});
@@ -63,7 +63,7 @@ $( "#clickme" ).click(function() {
<example>
<desc>Animates all paragraphs to slide up or down, completing the animation within 600 milliseconds.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "p" ).slideToggle( "slow" );
});
]]></code>
@@ -84,7 +84,7 @@ $( "button" ).click(function() {
<example>
<desc>Animates divs between dividers with a toggle that makes some appear and some disappear.</desc>
<code><![CDATA[
-$( "#aa" ).click(function() {
+$( "#aa" ).on( "click", function() {
$( "div:not(.still)" ).slideToggle( "slow", function() {
var n = parseInt( $( "span" ).text(), 10 );
$( "span" ).text( n + 1 );
diff --git a/entries/slideUp.xml b/entries/slideUp.xml
index 648665c93..c0d5f8ebf 100644
--- a/entries/slideUp.xml
+++ b/entries/slideUp.xml
@@ -30,7 +30,7 @@
</code></pre>
<p>With the element initially shown, we can hide it slowly:</p>
<pre><code>
-$( "#clickme" ).click(function() {
+$( "#clickme" ).on( "click", function() {
$( "#book" ).slideUp( "slow", function() {
// Animation complete.
});
@@ -54,13 +54,13 @@ $( "#clickme" ).click(function() {
<example>
<desc>Animates all divs to slide up, completing the animation within 400 milliseconds.</desc>
<code><![CDATA[
-$( document.body ).click(function() {
- if ( $( "div:first" ).is( ":hidden" ) ) {
+$( document.body ).on( "click", function() {
+ if ( $( "div" ).first().is( ":hidden" ) ) {
$( "div" ).show( "slow" );
} else {
$( "div" ).slideUp();
}
-});
+} );
]]></code>
<css><![CDATA[
div {
@@ -83,7 +83,7 @@ Click me!
<example>
<desc>Animates the parent paragraph to slide up, completing the animation within 200 milliseconds. Once the animation is done, it displays an alert.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( this ).parent().slideUp( "slow", function() {
$( "#msg" ).text( $( "button", this ).text() + " has completed." );
});
diff --git a/entries/stop.xml b/entries/stop.xml
index c0f173483..60062614a 100644
--- a/entries/stop.xml
+++ b/entries/stop.xml
@@ -53,17 +53,17 @@ $( "#hoverme-stop-2" ).hover(function() {
<desc>Click the Go button once to start the animation, then click the STOP button to stop it where it's currently positioned. Another option is to click several buttons to queue them up and see that stop just kills the currently playing one.</desc>
<code><![CDATA[
// Start animation
-$( "#go" ).click(function() {
+$( "#go" ).on( "click", function() {
$( ".block" ).animate({ left: "+=100px" }, 2000 );
});
// Stop animation when button is clicked
-$( "#stop" ).click(function() {
+$( "#stop" ).on( "click", function() {
$( ".block" ).stop();
});
// Start animation in the opposite direction
-$( "#back" ).click(function() {
+$( "#back" ).on( "click", function() {
$( ".block" ).animate({ left: "-=100px" }, 2000 );
});
]]></code>
diff --git a/entries/submit-selector.xml b/entries/submit-selector.xml
index a4c9aa01d..f6c48b8ff 100644
--- a/entries/submit-selector.xml
+++ b/entries/submit-selector.xml
@@ -15,25 +15,25 @@
<code><![CDATA[
var submitEl = $( "td :submit" )
.parent( "td" )
- .css({
+ .css( {
background: "yellow",
border: "3px red solid"
- })
+ } )
.end();
$( "#result" ).text( "jQuery matched " + submitEl.length + " elements." );
// Prevent form submission
-$( "form" ).submit(function( event ) {
+$( "form" ).on( "submit", function( event ) {
event.preventDefault();
-});
+} );
// Extra JS to make the HTML easier to edit (None of this is relevant to the ':submit' selector)
$( "#exampleTable" ).find( "td" ).each(function( i, el ) {
var inputEl = $( el ).children(),
inputType = inputEl.attr( "type" ) ? " type='" + inputEl.attr( "type" ) + "'" : "" ;
$( el ).before( "<td>" + inputEl[ 0 ].nodeName + inputType + "</td>" );
-})
+} );
]]></code>
<css><![CDATA[
textarea {
diff --git a/entries/submit-shorthand.xml b/entries/submit-shorthand.xml
new file mode 100644
index 000000000..20d9a0788
--- /dev/null
+++ b/entries/submit-shorthand.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<entry type="method" name="submit" return="jQuery" deprecated="3.3">
+ <title>.submit()</title>
+ <desc>Bind an event handler to the "submit" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API is deprecated.</p>
+ <p>Instead of <code>.submit( handler )</code> or <code>.submit( eventData, handler )</code>, use <a href="/https/github.com/submit/#on1"><code>.on( "submit", handler )</code></a> or <a href="/https/github.com/submit/#on1"><code>.on( "submit", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.submit()</code>, use <a href="/https/github.com/submit/#trigger2"><code>.trigger( "submit" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-3.3"/>
+</entry>
diff --git a/entries/submit.xml b/entries/submit.xml
index 2bae27644..42a32ea11 100644
--- a/entries/submit.xml
+++ b/entries/submit.xml
@@ -1,16 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="submit" return="jQuery">
- <title>.submit()</title>
- <desc>Bind an event handler to the "submit" JavaScript event, or trigger that event on an element.</desc>
+<entries>
+<desc>Bind an event handler to the "submit" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>submit event</title>
+ <desc>Bind an event handler to the "submit" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute each time the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""submit"" type="string">
+ <desc>The string <code>"submit"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>An object containing data that will be passed to the event handler.</desc>
</argument>
@@ -19,11 +18,10 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <signature>
- <added>1.0</added>
- </signature>
<longdesc>
- <p>This method is a shortcut for <code>.on( "submit", handler )</code> in the first variation, and <code>.trigger( "submit" )</code> in the third.</p>
+ <div class="warning">
+ <p>This page describes the <code>submit</code> event. For the deprecated <code>.submit()</code> method, see <a href="/https/github.com/submit-shorthand/"><code>.submit()</code></a>.</p>
+ </div>
<p>The <code>submit</code> event is sent to an element when the user is attempting to submit a form. It can only be attached to <code><form></code> elements. Forms can be submitted either by clicking an explicit <code><input type="submit"></code>, <code><input type="image"></code>, or <code><button type="submit"></code>, or by pressing <kbd>Enter</kbd> when certain form elements have focus.</p>
<div class="warning">
<p>Depending on the browser, the Enter key may only cause a form submission if the form has exactly one text field, or only when there is a submit button present. The interface should not rely on a particular behavior for this key unless the issue is forced by observing the keypress event for presses of the Enter key.</p>
@@ -39,34 +37,33 @@
</div></code></pre>
<p>The event handler can be bound to the form:</p>
<pre><code>
-$( "#target" ).submit(function( event ) {
- alert( "Handler for .submit() called." );
+$( "#target" ).on( "submit", function( event ) {
+ alert( "Handler for `submit` called." );
event.preventDefault();
});
</code></pre>
<p>Now when the form is submitted, the message is alerted. This happens prior to the actual submission, so we can cancel the submit action by calling <code>.preventDefault()</code> on the event object or by returning <code>false</code> from our handler. We can trigger the event manually when another element is clicked:</p>
<pre><code>
-$( "#other" ).click(function() {
- $( "#target" ).submit();
-});
+$( "#other" ).on( "click", function() {
+ $( "#target" ).trigger( "submit" );
+} );
</code></pre>
<p>After this code executes, clicks on <samp>Trigger the handler</samp> will also display the message. In addition, the default <code>submit</code> action on the form will be fired, so the form will be submitted.</p>
<p>The JavaScript <code>submit</code> event does not bubble in Internet Explorer. However, scripts that rely on event delegation with the <code>submit</code> event will work consistently across browsers as of jQuery 1.4, which has normalized the event's behavior. </p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="submit"/>
<note id="domlint" type="additional"/>
<example>
<desc>If you'd like to prevent forms from being submitted unless a flag variable is set, try:</desc>
<code><![CDATA[
-$( "form" ).submit(function( event ) {
- if ( $( "input:first" ).val() === "correct" ) {
+$( "form" ).on( "submit", function( event ) {
+ if ( $( "input" ).first().val() === "correct" ) {
$( "span" ).text( "Validated..." ).show();
return;
}
$( "span" ).text( "Not valid!" ).show().fadeOut( 1000 );
event.preventDefault();
-});
+} );
]]></code>
<css><![CDATA[
p {
@@ -94,19 +91,37 @@ $( "form" ).submit(function( event ) {
<example>
<desc>If you'd like to prevent forms from being submitted unless a flag variable is set, try:</desc>
<code><![CDATA[
-$( "form" ).submit(function() {
+$( "form" ).on( "submit", function() {
return this.some_flag_variable;
-});
+} );
]]></code>
</example>
<example>
<desc>To trigger the submit event on the first form on the page, try:</desc>
<code><![CDATA[
-$( "form:first" ).submit();
+$( "form" ).first().trigger( "submit" );
]]></code>
</example>
<category slug="events/form-events"/>
<category slug="forms"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
+ <category slug="version/1.7"/>
</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>submit event</title>
+ <desc>Trigger the "submit" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""submit"" type="string">
+ <desc>The string <code>"submit"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "submit", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/form-events"/>
+ <category slug="version/1.0"/>
+</entry>
+
+</entries>
diff --git a/entries/text-selector.xml b/entries/text-selector.xml
index 9af4dc445..4886c3a50 100644
--- a/entries/text-selector.xml
+++ b/entries/text-selector.xml
@@ -19,19 +19,19 @@ $( "<input>" ).is( ":text" ); // true
<example>
<desc>Finds all text inputs.</desc>
<code><![CDATA[
-var input = $( "form input:text" ).css({
+var input = $( "form input:text" ).css( {
background: "yellow",
border: "3px red solid"
-});
+} );
$( "div" )
.text( "For this type jQuery found " + input.length + "." )
.css( "color", "red" );
// Prevent form submission
-$( "form" ).submit(function( event ) {
+$( "form" ).on( "submit", function( event ) {
event.preventDefault();
-});
+} );
]]></code>
<css><![CDATA[
textarea {
diff --git a/entries/text.xml b/entries/text.xml
index 3752dd10c..616b8a2cf 100644
--- a/entries/text.xml
+++ b/entries/text.xml
@@ -22,14 +22,14 @@
<p>
<code>Demonstration Box list item 1 list item 2</code>
</p>
- <p>The <code>.text()</code> method cannot be used on form inputs or scripts. To set or get the text value of <code>input</code> or <code>textarea</code> elements, use the <a href="/https/github.com/val/"><code>.val()</code></a> method. To get the value of a script element, use the <a href="/https/github.com/html/"><code>.html()</code></a> method.</p>
+ <p>The <code>.text()</code> method should not be used on form inputs or scripts. To set or get the text value of <code>input</code> or <code>textarea</code> elements, use the <a href="/https/github.com/val/"><code>.val()</code></a> method. To get the value of a script element, use the <a href="/https/github.com/html/"><code>.html()</code></a> method.</p>
<p>As of jQuery 1.4, the <code>.text()</code> method returns the value of text and CDATA nodes as well as element nodes.</p>
</longdesc>
<example>
<desc>Find the text in the first paragraph (stripping out the html), then set the html of the last paragraph to show it is just text (the red bold is gone).</desc>
<code><![CDATA[
-var str = $( "p:first" ).text();
-$( "p:last" ).html( str );
+var str = $( "p" ).first().text();
+$( "p" ).last().html( str );
]]></code>
<css><![CDATA[
p {
@@ -91,7 +91,7 @@ $( "p:last" ).html( str );
<pre><code>
<p>This is a test</p>
</code></pre>
- <p>The <code>.text()</code> method cannot be used on input elements. For input field text, use the <a href="/https/github.com/val/">.val()</a> method.</p>
+ <p>The <code>.text()</code> method should not be used on input elements. For input field text, use the <a href="/https/github.com/val/">.val()</a> method.</p>
<p>As of jQuery 1.4, the <code>.text()</code> method allows us to set the text content by passing in a function.</p>
<pre><code>
$( "ul li" ).text(function( index ) {
diff --git a/entries/toggle.xml b/entries/toggle.xml
index deb0224dd..7d74577fe 100644
--- a/entries/toggle.xml
+++ b/entries/toggle.xml
@@ -51,7 +51,7 @@ $( ".target" ).toggle();
</code></pre>
<p>We will cause <code>.toggle()</code> to be called when another element is clicked:</p>
<pre><code>
-$( "#clickme" ).click(function() {
+$( "#clickme" ).on( "click", function() {
$( "#book" ).toggle( "slow", function() {
// Animation complete.
});
@@ -92,9 +92,9 @@ if ( display === true ) {
<example>
<desc>Toggles all paragraphs.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "p" ).toggle();
-});
+} );
]]></code>
<html><![CDATA[
<button>Toggle</button>
@@ -105,7 +105,7 @@ $( "button" ).click(function() {
<example>
<desc>Animates all paragraphs to be shown if they are hidden and hidden if they are visible, completing the animation within 600 milliseconds.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "p" ).toggle( "slow" );
});
]]></code>
@@ -126,7 +126,7 @@ $( "button" ).click(function() {
<desc>Shows all paragraphs, then hides them all, back and forth.</desc>
<code><![CDATA[
var flip = 0;
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
$( "p" ).toggle( flip++ % 2 === 0 );
});
]]></code>
diff --git a/entries/toggleClass.xml b/entries/toggleClass.xml
index 51bdf7465..b42f23290 100644
--- a/entries/toggleClass.xml
+++ b/entries/toggleClass.xml
@@ -5,16 +5,31 @@
<signature>
<added>1.0</added>
<argument name="className" type="String">
- <desc>One or more class names (separated by spaces) to be toggled for each element in the matched set.</desc>
+ <desc>One or more classes (separated by spaces) to be toggled for each element in the matched set.</desc>
</argument>
</signature>
<signature>
<added>1.3</added>
<argument name="className" type="String">
- <desc>One or more class names (separated by spaces) to be toggled for each element in the matched set.</desc>
+ <desc>One or more classes (separated by spaces) to be toggled for each element in the matched set.</desc>
</argument>
<argument name="state" type="Boolean">
- <desc>A Boolean (not just truthy/falsy) value to determine whether the class should be added or removed.</desc>
+ <desc>A boolean (not just truthy/falsy) value to determine whether the class should be added or removed.</desc>
+ </argument>
+ </signature>
+ <signature>
+ <added>3.3</added>
+ <argument name="classNames" type="Array">
+ <desc>An array of classes to be toggled for each element in the matched set.</desc>
+ </argument>
+ </signature>
+ <signature>
+ <added>3.3</added>
+ <argument name="classNames" type="Array">
+ <desc>An array of classes to be toggled for each element in the matched set.</desc>
+ </argument>
+ <argument name="state" type="Boolean">
+ <desc>A boolean (not just truthy/falsy) value to determine whether the class should be added or removed.</desc>
</argument>
</signature>
<signature>
@@ -24,7 +39,21 @@
<argument name="className" type="String" />
<argument name="state" type="Boolean" />
<return type="String" />
- <desc>A function that returns class names to be toggled in the class attribute of each element in the matched set. Receives the index position of the element in the set, the old class value, and the state as arguments.</desc>
+ <desc>A function returning one or more space-separated class names to be toggled in the class attribute of each element in the matched set. Receives the index position of the element in the set, the old class value, and the state as arguments.</desc>
+ </argument>
+ <argument name="state" optional="true" type="Boolean">
+ <desc>A boolean value to determine whether the class should be added or removed.</desc>
+ </argument>
+ </signature>
+ <signature>
+ <added>3.3</added>
+ <argument name="function" type="Function">
+ <argument name="index" type="Integer" />
+ <argument name="className" type="String" />
+ <argument name="state" type="Boolean" />
+ <return type="String" />
+ <return type="Array" />
+ <desc>A function returning one or more space-separated class names or an array of class names to be toggled in the class attribute of each element in the matched set. Receives the index position of the element in the set, the old class value, and the state as arguments.</desc>
</argument>
<argument name="state" optional="true" type="Boolean">
<desc>A boolean value to determine whether the class should be added or removed.</desc>
@@ -32,7 +61,7 @@
</signature>
<desc>Add or remove one or more classes from each element in the set of matched elements, depending on either the class's presence or the value of the state argument.</desc>
<longdesc>
- <p>This method takes one or more class names as its parameter. In the first version, if an element in the matched set of elements already has the class, then it is removed; if an element does not have the class, then it is added. For example, we can apply <code>.toggleClass()</code> to a simple <code><div></code>: </p>
+ <p>This method takes one or more classes as its parameter. In the first version, if an element in the matched set of elements already has the class, then it is removed; if an element does not have the class, then it is added. For example, we can apply <code>.toggleClass()</code> to a simple <code><div></code>: </p>
<pre><code>
<div class="tumble">Some text.</div>
</code></pre>
@@ -55,7 +84,7 @@ if ( addOrRemove ) {
$( "#foo" ).removeClass( className );
}
</code></pre>
- <p><strong>As of jQuery 1.4</strong>, if no arguments are passed to <code>.toggleClass()</code>, all class names on the element the first time <code>.toggleClass()</code> is called will be toggled. Also as of jQuery 1.4, the class name to be toggled can be determined by passing in a function.</p>
+ <p><strong>As of jQuery 1.4</strong>, if no arguments are passed to <code>.toggleClass()</code>, all classes on the element the first time <code>.toggleClass()</code> is called will be toggled. Also as of jQuery 1.4, the class name to be toggled can be determined by passing in a function.</p>
<pre><code>
$( "div.foo" ).toggleClass(function() {
if ( $( this ).parent().is( ".bar" ) ) {
@@ -70,7 +99,7 @@ $( "div.foo" ).toggleClass(function() {
<example>
<desc>Toggle the class 'highlight' when a paragraph is clicked.</desc>
<code><![CDATA[
-$( "p" ).click(function() {
+$( "p" ).on( "click", function() {
$( this ).toggleClass( "highlight" );
});
]]></code>
@@ -99,15 +128,15 @@ $( "p" ).click(function() {
<desc>Add the "highlight" class to the clicked paragraph on every third click of that paragraph, remove it every first and second click.</desc>
<code><![CDATA[
var count = 0;
-$( "p" ).each(function() {
+$( "p" ).each( function() {
var $thisParagraph = $( this );
var count = 0;
- $thisParagraph.click(function() {
+ $thisParagraph.on( "click", function() {
count++;
$thisParagraph.find( "span" ).text( "clicks: " + count );
$thisParagraph.toggleClass( "highlight", count % 3 === 0 );
- });
-});
+ } );
+} );
]]></code>
<css><![CDATA[
p {
@@ -197,8 +226,10 @@ $( "a" ).on( "click", function( event ) {
<category slug="version/1.0"/>
<category slug="version/1.3"/>
<category slug="version/1.4"/>
+ <category slug="version/1.12-and-2.2"/>
+ <category slug="version/3.3"/>
</entry>
- <entry type="method" name="toggleClass" return="jQuery" deprecated="3.0">
+ <entry type="method" name="toggleClass" return="jQuery" deprecated="3.0" removed="4.0">
<signature>
<added>1.4</added>
<argument name="state" optional="true" type="Boolean">
@@ -210,4 +241,4 @@ $( "a" ).on( "click", function( event ) {
</longdesc>
<category slug="deprecated/deprecated-3.0"/>
</entry>
-</entries>
\ No newline at end of file
+</entries>
diff --git a/entries/trigger.xml b/entries/trigger.xml
index 91e3c26a8..caff8cb8f 100644
--- a/entries/trigger.xml
+++ b/entries/trigger.xml
@@ -51,14 +51,14 @@ $( "#foo").trigger( "custom", [ "Custom", "Event" ] );
<example>
<desc>Clicks to button #2 also trigger a click for button #1.</desc>
<code><![CDATA[
-$( "button:first" ).click(function() {
- update( $( "span:first" ) );
-});
+$( "button" ).first().on( "click", function() {
+ update( $( "span" ).first() );
+} );
-$( "button:last" ).click(function() {
- $( "button:first" ).trigger( "click" );
- update( $( "span:last" ) );
-});
+$( "button" ).last().on( "click", function() {
+ $( "button" ).first().trigger( "click" );
+ update( $( "span" ).last() );
+} );
function update( j ) {
var n = parseInt( j.text(), 10 );
@@ -87,14 +87,14 @@ function update( j ) {
<example>
<desc>To submit the first form without using the submit() function, try:</desc>
<code><![CDATA[
-$( "form:first" ).trigger( "submit" );
+$( "form" ).first().trigger( "submit" );
]]></code>
</example>
<example>
<desc>To submit the first form without using the submit() function, try:</desc>
<code><![CDATA[
var event = jQuery.Event( "submit" );
-$( "form:first" ).trigger( event );
+$( "form" ).first().trigger( event );
if ( event.isDefaultPrevented() ) {
// Perform an action...
}
@@ -104,10 +104,10 @@ if ( event.isDefaultPrevented() ) {
<desc>To pass arbitrary data to an event:</desc>
<code><![CDATA[
$( "p" )
- .click(function( event, a, b ) {
+ .on( "click", function( event, a, b ) {
// When a normal click fires, a and b are undefined
// for a trigger like below a refers to "foo" and b refers to "bar"
- })
+ } )
.trigger( "click", [ "foo", "bar" ] );
]]></code>
</example>
diff --git a/entries/triggerHandler.xml b/entries/triggerHandler.xml
index d72516a8d..83b2a576f 100644
--- a/entries/triggerHandler.xml
+++ b/entries/triggerHandler.xml
@@ -37,15 +37,15 @@
<example>
<desc>If you called .triggerHandler() on a focus event - the browser's default focus action would not be triggered, only the event handlers bound to the focus event.</desc>
<code><![CDATA[
-$( "#old" ).click(function() {
+$( "#old" ).on( "click", function() {
$( "input" ).trigger( "focus" );
-});
-$( "#new" ).click(function() {
+} );
+$( "#new" ).on( "click", function() {
$( "input" ).triggerHandler( "focus" );
-});
-$( "input" ).focus(function() {
+} );
+$( "input" ).on( "focus", function() {
$( "<span>Focused!</span>" ).appendTo( "body" ).fadeOut( 1000 );
-});
+} );
]]></code>
<html><![CDATA[
<button id="old">.trigger( "focus" )</button>
diff --git a/entries/unbind.xml b/entries/unbind.xml
index 8b91e66a5..6a85004ec 100644
--- a/entries/unbind.xml
+++ b/entries/unbind.xml
@@ -102,12 +102,12 @@ This example is also an illustration of a closure. Since the handler refers to t
function aClick() {
$( "div" ).show().fadeOut( "slow" );
}
-$( "#bind" ).click(function() {
+$( "#bind" ).on( "click", function() {
$( "#theone" )
.bind( "click", aClick )
.text( "Can Click!" );
});
-$( "#unbind" ).click(function() {
+$( "#unbind" ).on( "click", function() {
$( "#theone" )
.unbind( "click", aClick )
.text( "Does nothing..." );
diff --git a/entries/undelegate.xml b/entries/undelegate.xml
index f97e6b01b..f3a985963 100644
--- a/entries/undelegate.xml
+++ b/entries/undelegate.xml
@@ -52,12 +52,12 @@
function aClick() {
$( "div" ).show().fadeOut( "slow" );
}
-$( "#bind" ).click(function() {
+$( "#bind" ).on( "click", function() {
$( "body" )
.delegate( "#theone", "click", aClick )
.find( "#theone" ).text( "Can Click!" );
});
-$( "#unbind" ).click(function() {
+$( "#unbind" ).on( "click", function() {
$( "body" )
.undelegate( "#theone", "click", aClick )
.find( "#theone" ).text( "Does nothing..." );
diff --git a/entries/uniqueSort.xml b/entries/uniqueSort.xml
new file mode 100644
index 000000000..999f15b0f
--- /dev/null
+++ b/entries/uniqueSort.xml
@@ -0,0 +1,112 @@
+<?xml version="1.0"?>
+<entry type="method" name="uniqueSort" return="jQuery">
+ <title>.uniqueSort()</title>
+ <signature>
+ <added>3.7</added>
+ </signature>
+ <desc>Sorts a jQuery object of DOM elements, in place, with the duplicates removed. Note that this only works on jQuery objects consisting of DOM elements, not strings or numbers.</desc>
+ <longdesc>
+ <p>The <code>.uniqueSort()</code> function searches through a jQuery object, sorting it in document order, and removing any duplicate nodes. A node is considered a duplicate if it is the <em>exact same</em> node as one already in the jQuery object; two different nodes with identical attributes are not considered to be duplicates. This function only works on jQuery objects consisting of DOM elements.</p>
+ </longdesc>
+ <example>
+ <desc>Removes any duplicate elements from the jQuery object of divs.</desc>
+ <code><![CDATA[
+var divs = $( "div" ).get();
+
+// Add 3 elements of class dup too (they are divs)
+divs = divs.concat( $( ".dup" ).get() );
+
+// Create a jQuery object from `divs`.
+var elems = $( divs );
+
+$( "div" )
+ .eq( 1 )
+ .text( "Pre-uniqueSort there are " + elems.length + " elements in the collection." );
+
+elems = elems.uniqueSort();
+
+$( "div" )
+ .eq( 2 )
+ .text( "Post-uniqueSort there are " + elems.length + " elements in the collection." )
+ .css( "color", "red" );
+]]></code>
+ <css><![CDATA[
+ div {
+ color: blue;
+ }
+]]></css>
+ <html><![CDATA[
+<div>There are 6 divs in this document.</div>
+<div></div>
+<div class="dup"></div>
+<div class="dup"></div>
+<div class="dup"></div>
+<div></div>
+]]></html>
+ </example>
+ <example>
+ <desc>Locate all the divs preceding the last item and wrap them with a div with class <code>wrapper</code> - with or without <code><a href="/https/github.com/uniqueSort/">.uniqueSort()</a></code>.</desc>
+ <code><![CDATA[
+$( "#container-1" )
+ .find( ".item" )
+ .last()
+ .prevAll()
+ .wrapAll( "<div class='wrapper' data-content='No uniqueSort'></div>" );
+
+$( "#container-2" )
+ .find( ".item" )
+ .last()
+ .prevAll()
+ .uniqueSort()
+ .wrapAll( "<div class='wrapper' data-content='With uniqueSort'></div>" );
+]]></code>
+ <css><![CDATA[
+ body {
+ display: flex;
+ }
+ .container {
+ display: flex;
+ margin: 10px 50px 10px 10px;
+ }
+ .wrapper {
+ position: relative;
+ display: flex;
+ padding: 30px 10px 10px 10px;
+ background: #def;
+ border: 2px solid black;
+ }
+ .wrapper::before {
+ content: attr(data-content);
+ position: absolute;
+ top: 15px;
+ left: 15px;
+ }
+ .item {
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ width: 70px;
+ height: 70px;
+ background: #abc;
+ border: 2px solid black;
+ margin: 10px;
+ font-size: 50px;
+ }
+]]></css>
+ <html><![CDATA[
+<div class="container" id="container-1">
+ <div class="item">1</div>
+ <div class="item">2</div>
+ <div class="item">3</div>
+</div>
+
+<div class="container" id="container-2">
+ <div class="item">1</div>
+ <div class="item">2</div>
+ <div class="item">3</div>
+</div>
+]]></html>
+ </example>
+ <category slug="utilities"/>
+ <category slug="version/3.7"/>
+</entry>
diff --git a/entries/unload-shorthand.xml b/entries/unload-shorthand.xml
new file mode 100644
index 000000000..693768ecd
--- /dev/null
+++ b/entries/unload-shorthand.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<entry type="method" name="unload" return="jQuery" deprecated="1.8" removed="3.0">
+ <title>.unload()</title>
+ <desc>Bind an event handler to the "unload" event, or trigger that event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.4.3</added>
+ <argument name="eventData" type="Anything" optional="true">
+ <desc>An object containing data that will be passed to the event handler.</desc>
+ </argument>
+ <argument name="handler" type="Function">
+ <desc>A function to execute each time the event is triggered.</desc>
+ <argument name="eventObject" type="Event" />
+ </argument>
+ </signature>
+ <signature>
+ <added>1.0</added>
+ </signature>
+ <longdesc>
+ <div class="warning">
+ <p>This API has been removed in jQuery 3.0.</p>
+ <p>Instead of <code>.unload( handler )</code> or <code>.unload( eventData, handler )</code>, use <a href="/https/github.com/unload/#on1"><code>.on( "unload", handler )</code></a> or <a href="/https/github.com/unload/#on1"><code>.on( "unload", eventData, handler )</code></a>, respectively.</p>
+ <p>Instead of <code>.unload()</code>, use <a href="/https/github.com/unload/#trigger2"><code>.trigger( "unload" )</code></a>.</p>
+ </div>
+ </longdesc>
+ <category slug="events/document-loading"/>
+ <category slug="version/1.0"/>
+ <category slug="version/1.4.3"/>
+ <category slug="deprecated/deprecated-1.8"/>
+ <category slug="removed"/>
+</entry>
diff --git a/entries/unload.xml b/entries/unload.xml
index 1306ddd6d..05d1c27a4 100644
--- a/entries/unload.xml
+++ b/entries/unload.xml
@@ -1,15 +1,15 @@
<?xml version="1.0"?>
-<entry type="method" name="unload" return="jQuery" deprecated="1.8" removed="3.0">
- <title>.unload()</title>
+<entries>
+<desc>Bind an event handler to the "unload" event, or trigger that event on an element.</desc>
+
+<entry type="method" name="on" return="jQuery">
+ <title>unload event</title>
+ <desc>Bind an event handler to the "unload" event.</desc>
<signature>
- <added>1.0</added>
- <argument name="handler" type="Function">
- <desc>A function to execute when the event is triggered.</desc>
- <argument name="eventObject" type="Event" />
+ <added>1.7</added>
+ <argument name=""unload"" type="string">
+ <desc>The string <code>"unload"</code>.</desc>
</argument>
- </signature>
- <signature>
- <added>1.4.3</added>
<argument name="eventData" type="Anything" optional="true">
<desc>A plain object of data that will be passed to the event handler.</desc>
</argument>
@@ -18,33 +18,49 @@
<argument name="eventObject" type="Event" />
</argument>
</signature>
- <desc>Bind an event handler to the "unload" JavaScript event.</desc>
<longdesc>
- <p>This method is a shortcut for <code>.on( "unload", handler )</code>.</p>
+ <div class="warning">
+ <p>This page describes the <code>unload</code> event. For the <code>.unload()</code> method removed in jQuery 3.0, see <a href="/https/github.com/unload-shorthand/"><code>.unload()</code></a>.</p>
+ </div>
<p>The <code>unload</code> event is sent to the <code>window</code> element when the user navigates away from the page. This could mean one of many things. The user could have clicked on a link to leave the page, or typed in a new URL in the address bar. The forward and back buttons will trigger the event. Closing the browser window will cause the event to be triggered. Even a page reload will first create an <code>unload</code> event.</p>
<div class="warning">
<p>The exact handling of the <code>unload</code> event has varied from version to version of browsers. For example, some versions of Firefox trigger the event when a link is followed, but not when the window is closed. In practical usage, behavior should be tested on all supported browsers and contrasted with the similar <code>beforeunload</code> event.</p>
</div>
<p>Any <code>unload</code> event handler should be bound to the <code>window</code> object:</p>
<pre><code>
-$( window ).unload(function() {
- return "Handler for .unload() called.";
-});
+$( window ).on( "unload", function() {
+ return "Handler for `unload` called.";
+} );
</code></pre>
<p>This event is available so that scripts can perform cleanup when the user leaves the page. Most browsers will ignore calls to <code>alert()</code>, <code>confirm()</code> and <code>prompt()</code> inside the event handler. The string you return may be used in a confirmation dialog, but not all browsers support this. It is not possible to cancel the <code>unload</code> event with <code>.preventDefault()</code>.</p>
</longdesc>
- <note id="detach-shorthand" type="additional" data-event="unload"/>
<example>
<desc>To display an alert when a page is unloaded:</desc>
<code><![CDATA[
-$( window ).unload(function() {
+$( window ).on( "unload", function() {
return "Bye now!";
-});
+} );
]]></code>
</example>
<category slug="events/document-loading"/>
<category slug="version/1.0"/>
- <category slug="version/1.4.3"/>
- <category slug="deprecated/deprecated-1.8"/>
- <category slug="removed"/>
+ <category slug="version/1.7"/>
+</entry>
+
+<entry type="method" name="trigger" return="jQuery">
+ <title>unload event</title>
+ <desc>Trigger the "unload" event on an element.</desc>
+ <signature>
+ <added>1.0</added>
+ <argument name=""unload"" type="string">
+ <desc>The string <code>"unload"</code>.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>See the description for <a href="#on1"><code>.on( "unload", ... )</code></a>.</p>
+ </longdesc>
+ <category slug="events/document-loading"/>
+ <category slug="version/1.0"/>
</entry>
+
+</entries>
diff --git a/entries/unwrap.xml b/entries/unwrap.xml
index ff6d6100d..b2dde6046 100644
--- a/entries/unwrap.xml
+++ b/entries/unwrap.xml
@@ -18,7 +18,7 @@
<desc>Wrap/unwrap a div around each of the paragraphs.</desc>
<code><![CDATA[
var pTags = $( "p" );
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
if ( pTags.parent().is( "div" ) ) {
pTags.unwrap();
} else {
diff --git a/entries/val.xml b/entries/val.xml
index 56ef9e347..4965b2b24 100644
--- a/entries/val.xml
+++ b/entries/val.xml
@@ -50,7 +50,7 @@ function displayVals() {
" <b>Multiple:</b> " + multipleValues.join( ", " ) );
}
-$( "select" ).change( displayVals );
+$( "select" ).on( "change", displayVals );
displayVals();
]]></code>
<css><![CDATA[
@@ -81,11 +81,11 @@ displayVals();
<desc>Find the value of an input box.</desc>
<code><![CDATA[
$( "input" )
- .keyup(function() {
+ .on( "keyup", function() {
var value = $( this ).val();
$( "p" ).text( value );
- })
- .keyup();
+ } )
+ .trigger( "keyup" );
]]></code>
<css><![CDATA[
p {
@@ -139,7 +139,7 @@ $( "input[type=text].tags" ).val(function( index, value ) {
<example>
<desc>Set the value of an input box.</desc>
<code><![CDATA[
-$( "button" ).click(function() {
+$( "button" ).on( "click", function() {
var text = $( this ).text();
$( "input" ).val( text );
});
diff --git a/entries/visible-selector.xml b/entries/visible-selector.xml
index 45c5b9735..b315cc15e 100644
--- a/entries/visible-selector.xml
+++ b/entries/visible-selector.xml
@@ -21,12 +21,12 @@
<example>
<desc>Make all visible divs turn yellow on click.</desc>
<code><![CDATA[
-$( "div:visible" ).click(function() {
+$( "div:visible" ).on( "click", function() {
$( this ).css( "background", "yellow" );
-});
-$( "button" ).click(function() {
+} );
+$( "button" ).on( "click", function() {
$( "div:hidden" ).show( "fast" );
-});
+} );
]]></code>
<css><![CDATA[
div {
diff --git a/entries/width.xml b/entries/width.xml
index c197119c9..c8afa4224 100644
--- a/entries/width.xml
+++ b/entries/width.xml
@@ -26,7 +26,7 @@ $( document ).width();
<p><strong>Note:</strong> Although <code>style</code> and <code>script</code> tags will report a value for <code>.width()</code> or <code>height()</code> when absolutely positioned and given <code>display:block</code>, it is strongly discouraged to call those methods on these tags. In addition to being a bad practice, the results may also prove unreliable.</p>
</div>
</longdesc>
- <note id="dimensions-number" type="additional" data-title=".width()"/>
+ <note id="dimensions-number" type="additional" data-title=".width()"/>
<note id="hidden-element-dimensions" type="additional" data-title=".width()"/>
<example>
<desc>Show various widths. Note the values are from the iframe so might be smaller than you expected. The yellow highlight shows the iframe body.</desc>
@@ -34,15 +34,15 @@ $( document ).width();
function showWidth( ele, w ) {
$( "div" ).text( "The width for the " + ele + " is " + w + "px." );
}
-$( "#getp" ).click(function() {
+$( "#getp" ).on( "click", function() {
showWidth( "paragraph", $( "p" ).width() );
-});
-$( "#getd" ).click(function() {
+} );
+$( "#getd" ).on( "click", function() {
showWidth( "document", $( document ).width() );
-});
-$("#getw").click(function() {
+} );
+$("#getw").on( "click", function() {
showWidth( "window", $( window ).width() );
-});
+} );
]]></code>
<css><![CDATA[
body {
diff --git a/entries2html.xsl b/entries2html.xsl
index fe2dc09bc..a1a199827 100755
--- a/entries2html.xsl
+++ b/entries2html.xsl
@@ -12,7 +12,7 @@
<meta charset="utf-8">
<title><xsl:value-of select="//entry/@name"/> demo</title><xsl:if test="css">
<style><xsl:value-of select="css/text()"/> </style></xsl:if>
- <script src="https://code.jquery.com/jquery-1.10.2.js"></script><xsl:if test="code/@location='head'">
+ <script src="https://code.jquery.com/jquery-3.7.1.js"></script><xsl:if test="code/@location='head'">
<script>
<xsl:copy-of select="code/text()"/>
</script>
diff --git a/includes/complete-argument.xml b/includes/complete-argument.xml
index 5d109f39e..4ef06fa39 100644
--- a/includes/complete-argument.xml
+++ b/includes/complete-argument.xml
@@ -1,4 +1,4 @@
<?xml version="1.0"?>
<argument name="complete" type="Function" optional="true">
- <desc>A function to call once the animation is complete, called once per matched element.</desc>
+ <desc>A function to call once the animation is complete, called once per matched element.</desc>
</argument>
diff --git a/includes/duration-argument.xml b/includes/duration-argument.xml
index 1a1c5c5e3..8fcfb7f30 100644
--- a/includes/duration-argument.xml
+++ b/includes/duration-argument.xml
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<argument name="duration" default="400" optional="true">
- <desc>A string or number determining how long the animation will run.</desc>
- <type name="Number"/>
- <type name="String"/>
+ <desc>A string or number determining how long the animation will run.</desc>
+ <type name="Number"/>
+ <type name="String"/>
</argument>
diff --git a/includes/easing-argument.xml b/includes/easing-argument.xml
index b64835515..127057afe 100644
--- a/includes/easing-argument.xml
+++ b/includes/easing-argument.xml
@@ -1,4 +1,4 @@
<?xml version="1.0"?>
<argument name="easing" type="String" default="swing" optional="true">
- <desc>A string indicating which easing function to use for the transition.</desc>
+ <desc>A string indicating which easing function to use for the transition.</desc>
</argument>
diff --git a/includes/options-argument.xml b/includes/options-argument.xml
index 168e86488..cacb3286f 100644
--- a/includes/options-argument.xml
+++ b/includes/options-argument.xml
@@ -1,81 +1,81 @@
<?xml version="1.0"?>
<argument name="options" type="PlainObject">
- <desc>A map of additional options to pass to the method.</desc>
- <property name="duration" default="400">
- <desc>A string or number determining how long the animation will run.</desc>
- <type name="Number"/>
- <type name="String"/>
- </property>
- <property name="easing" type="String" default="swing">
- <desc>A string indicating which easing function to use for the transition.</desc>
- </property>
- <property name="queue" default="true">
- <desc>A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. <strong>As of jQuery 1.7</strong>, the queue option can also accept a string, in which case the animation is added to the queue represented by that string. When a custom queue name is used the animation does not automatically start; you must call <code>.dequeue("queuename")</code> to start it.</desc>
- <type name="Boolean"/>
- <type name="String"/>
- </property>
- <property name="specialEasing" type="PlainObject" added="1.4">
- <desc>An object containing one or more of the CSS properties defined by the properties argument and their corresponding easing functions.</desc>
- </property>
+ <desc>A map of additional options to pass to the method.</desc>
+ <property name="duration" default="400">
+ <desc>A string or number determining how long the animation will run.</desc>
+ <type name="Number"/>
+ <type name="String"/>
+ </property>
+ <property name="easing" type="String" default="swing">
+ <desc>A string indicating which easing function to use for the transition.</desc>
+ </property>
+ <property name="queue" default="true">
+ <desc>A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. <strong>As of jQuery 1.7</strong>, the queue option can also accept a string, in which case the animation is added to the queue represented by that string. When a custom queue name is used the animation does not automatically start; you must call <code>.dequeue("queuename")</code> to start it.</desc>
+ <type name="Boolean"/>
+ <type name="String"/>
+ </property>
+ <property name="specialEasing" type="PlainObject" added="1.4">
+ <desc>An object containing one or more of the CSS properties defined by the properties argument and their corresponding easing functions.</desc>
+ </property>
- <property name="step" type="Function">
- <desc>A function to be called for each animated property of each animated element. This function provides an opportunity to modify the Tween object to change the value of the property before it is set.</desc>
- <argument name="now" type="Number">
- <desc>The numeric value of the property being animated at each step</desc>
- </argument>
- <argument name="tween" type="Tween">
- <desc>An object of properties related to the animation and the element being animated. For information about the tween object and its properties, see <a href="/https/github.com/jQuery.Tween/">jQuery.Tween</a></desc>
- </argument>
- </property>
+ <property name="step" type="Function">
+ <desc>A function to be called for each animated property of each animated element. This function provides an opportunity to modify the Tween object to change the value of the property before it is set.</desc>
+ <argument name="now" type="Number">
+ <desc>The numeric value of the property being animated at each step</desc>
+ </argument>
+ <argument name="tween" type="Tween">
+ <desc>An object of properties related to the animation and the element being animated. For information about the tween object and its properties, see <a href="/https/github.com/jQuery.Tween/">jQuery.Tween</a></desc>
+ </argument>
+ </property>
- <property name="progress" type="Function" added="1.8">
- <desc>A function to be called after each step of the animation, only once per animated element regardless of the number of animated properties.</desc>
- <argument name="animation" type="Promise">
- <desc>An enhanced Promise object with additional properties for the animation</desc>
- </argument>
- <argument name="progress" type="Number">
- <desc>A number from 0 to 1 indicating the progress of the animation</desc>
- </argument>
- <argument name="remainingMs" type="Number">
- <desc>A number indicating the remaining number of milliseconds until the scheduled end of the animation</desc>
- </argument>
- </property>
- <property name="complete" type="Function">
- <desc>A function that is called once the animation on an element is complete.</desc>
- <!-- no parameters -->
- </property>
- <property name="start" type="Function" added="1.8">
- <desc>A function to call when the animation on an element begins.</desc>
- <argument name="animation" type="Promise">
- <desc>An enhanced Promise object with additional properties for the animation</desc>
- </argument>
- </property>
- <property name="done" type="Function" added="1.8">
- <desc>A function to be called when the animation on an element completes (its Promise object is resolved).</desc>
- <argument name="animation" type="Promise">
- <desc>An enhanced Promise object with additional properties for the animation</desc>
- </argument>
- <argument name="jumpedToEnd" type="Boolean">
- <desc>Indicates whether the animation jumped to the end</desc>
- </argument>
- </property>
- <property name="fail" type="Function" added="1.8">
- <desc>A function to be called when the animation on an element fails to complete (its Promise object is rejected).</desc>
- <argument name="animation" type="Promise">
- <desc>An enhanced Promise object with additional properties for the animation</desc>
- </argument>
- <argument name="jumpedToEnd" type="Boolean">
- <desc>Indicates whether the animation jumped to the end</desc>
- </argument>
- </property>
- <property name="always" type="Function" added="1.8">
- <desc>A function to be called when the animation on an element completes or stops without completing (its Promise object is either resolved or rejected).</desc>
- <argument name="animation" type="Promise">
- <desc>An enhanced Promise object with additional properties for the animation</desc>
- </argument>
- <argument name="jumpedToEnd" type="Boolean">
- <desc>Indicates whether the animation jumped to the end</desc>
- </argument>
- </property>
+ <property name="progress" type="Function" added="1.8">
+ <desc>A function to be called after each step of the animation, only once per animated element regardless of the number of animated properties.</desc>
+ <argument name="animation" type="Promise">
+ <desc>An enhanced Promise object with additional properties for the animation</desc>
+ </argument>
+ <argument name="progress" type="Number">
+ <desc>A number from 0 to 1 indicating the progress of the animation</desc>
+ </argument>
+ <argument name="remainingMs" type="Number">
+ <desc>A number indicating the remaining number of milliseconds until the scheduled end of the animation</desc>
+ </argument>
+ </property>
+ <property name="complete" type="Function">
+ <desc>A function that is called once the animation on an element is complete.</desc>
+ <!-- no parameters -->
+ </property>
+ <property name="start" type="Function" added="1.8">
+ <desc>A function to call when the animation on an element begins.</desc>
+ <argument name="animation" type="Promise">
+ <desc>An enhanced Promise object with additional properties for the animation</desc>
+ </argument>
+ </property>
+ <property name="done" type="Function" added="1.8">
+ <desc>A function to be called when the animation on an element completes (its Promise object is resolved).</desc>
+ <argument name="animation" type="Promise">
+ <desc>An enhanced Promise object with additional properties for the animation</desc>
+ </argument>
+ <argument name="jumpedToEnd" type="Boolean">
+ <desc>Indicates whether the animation jumped to the end</desc>
+ </argument>
+ </property>
+ <property name="fail" type="Function" added="1.8">
+ <desc>A function to be called when the animation on an element fails to complete (its Promise object is rejected).</desc>
+ <argument name="animation" type="Promise">
+ <desc>An enhanced Promise object with additional properties for the animation</desc>
+ </argument>
+ <argument name="jumpedToEnd" type="Boolean">
+ <desc>Indicates whether the animation jumped to the end</desc>
+ </argument>
+ </property>
+ <property name="always" type="Function" added="1.8">
+ <desc>A function to be called when the animation on an element completes or stops without completing (its Promise object is either resolved or rejected).</desc>
+ <argument name="animation" type="Promise">
+ <desc>An enhanced Promise object with additional properties for the animation</desc>
+ </argument>
+ <argument name="jumpedToEnd" type="Boolean">
+ <desc>Indicates whether the animation jumped to the end</desc>
+ </argument>
+ </property>
</argument>
diff --git a/notes.xsl b/notes.xsl
index cfaf9bfb3..6963dad28 100644
--- a/notes.xsl
+++ b/notes.xsl
@@ -17,7 +17,7 @@
Selected elements are in the order of their appearance in the document.
</xsl:when>
<xsl:when test="@id = 'domlint'">
- Forms and their child elements should not use input names or ids that conflict with properties of a form, such as <code>submit</code>, <code>length</code>, or <code>method</code>. Name conflicts can cause confusing failures. For a complete list of rules and to check your markup for these problems, see <a href="https://kangax.github.com/domlint/">DOMLint</a>.
+ Forms and their child elements should not use input names or ids that conflict with properties of a form, such as <code>submit</code>, <code>length</code>, or <code>method</code>. Name conflicts can cause confusing failures. For a complete list of rules and to check your markup for these problems, see <a href="https://kangax.github.io/domlint/">DOMLint</a>.
</xsl:when>
<xsl:when test="@id = 'hidden-element-dimensions'">
The value reported by <code><xsl:value-of select="@data-title" /></code> is not guaranteed to be accurate when the element or its parent is hidden. To get an accurate value, ensure the element is visible before using <code><xsl:value-of select="@data-title" /></code>. jQuery will attempt to temporarily show and then re-hide an element in order to measure its dimensions, but this is unreliable and (even when accurate) can significantly impact page performance. This show-and-rehide measurement feature may be removed in a future version of jQuery.
@@ -50,10 +50,10 @@
Script and JSONP requests are not subject to the same origin policy restrictions.
</xsl:when>
<xsl:when test="@id = 'use-ajaxerror'">
- If a request with <xsl:value-of select="@data-title"/> returns an error code, it will fail silently unless the script has also called the global <a href="/https/github.com/ajaxError/">.ajaxError() </a> method. Alternatively, as of jQuery 1.5, the <code>.error()</code> method of the <code>jqXHR</code> object returned by <xsl:value-of select="@data-title"/> is also available for error handling.
+ If a request with <xsl:value-of select="@data-title"/> returns an error code, it will fail silently unless the script has also called the global <a href="/https/github.com/ajaxError/"><code>ajaxError</code></a> event. Alternatively, as of jQuery 1.5, the <code>.error()</code> method of the <code>jqXHR</code> object returned by <xsl:value-of select="@data-title"/> is also available for error handling.
</xsl:when>
<xsl:when test="@id = 'ajax-global-false'">
- If <code><a href="/https/github.com/jQuery.Ajax/">$.ajax()</a></code> or <code><a href="/https/github.com/jQuery.ajaxSetup/">$.ajaxSetup()</a></code> is called with the <code>global</code> option set to <code>false</code>, the <code><xsl:value-of select="@data-title"/></code> method will not fire.
+ If <code><a href="/https/github.com/jQuery.ajax/">$.ajax()</a></code> or <code><a href="/https/github.com/jQuery.ajaxSetup/">$.ajaxSetup()</a></code> is called with the <code>global</code> option set to <code>false</code>, the <code><xsl:value-of select="@data-title"/></code> event will not fire.
</xsl:when>
<xsl:when test="@id = 'slide-in-ie'">
If <code><xsl:value-of select="@data-title"/></code> is called on an unordered list (<code><ul></code>) and its <code><li></code> elements have position (relative, absolute, or fixed), the effect may not work properly in IE6 through at least IE9 unless the <code><ul></code> has "layout." To remedy the problem, add the <code>position: relative;</code> and <code>zoom: 1;</code> CSS declarations to the <code>ul</code>.
@@ -64,11 +64,8 @@
<xsl:when test="@id = 'hidden-forces-layout'">
Using this selector heavily can have performance implications, as it may force the browser to re-render the page before it can determine visibility. Tracking the visibility of elements via other methods, using a class for example, can provide better performance.
</xsl:when>
- <xsl:when test="@id = 'detach-shorthand'">
- As the <code>.<xsl:value-of select="@data-event"/>()</code> method is just a shorthand for <code>.on( "<xsl:value-of select="@data-event"/>", handler )</code>, detaching is possible using <code>.off( "<xsl:value-of select="@data-event"/>" )</code>.
- </xsl:when>
<xsl:when test="@id = 'global-ajax-event'">
- As of jQuery 1.9, all the handlers for the <a href="/https/github.com/category/ajax/global-ajax-event-handlers/">jQuery global Ajax events</a>, including those added with the <code><xsl:value-of select="@data-title"/></code> method, <em>must</em> be attached to <code>document</code>.
+ As of jQuery 1.9, all the handlers for the <a href="/https/github.com/category/ajax/global-ajax-event-handlers/">jQuery global Ajax events</a>, including those added with <code>.on( "<xsl:value-of select="@data-title"/>", ... )</code>, <em>must</em> be attached to <code>document</code>.
</xsl:when>
<xsl:when test="@id = 'svg-support'">
jQuery doesn't officially support SVG. Using jQuery methods on SVG documents, unless explicitly documented for that method, might cause unexpected behaviors. Examples of methods that support SVG as of jQuery 3.0 are <code>addClass</code> and <code>removeClass</code>.
diff --git a/package-lock.json b/package-lock.json
index e3059772d..0da24ae3c 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,665 +1,1291 @@
{
"name": "api.jquery.com",
- "version": "1.12.36",
- "lockfileVersion": 1,
+ "version": "3.3.10",
+ "lockfileVersion": 3,
"requires": true,
- "dependencies": {
- "abbrev": {
+ "packages": {
+ "": {
+ "name": "api.jquery.com",
+ "version": "3.3.10",
+ "dependencies": {
+ "grunt": "1.6.1",
+ "grunt-jquery-content": "3.3.2"
+ }
+ },
+ "node_modules/abbrev": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz",
+ "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q=="
+ },
+ "node_modules/ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+ "dependencies": {
+ "color-convert": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
+ "node_modules/argparse": {
+ "version": "1.0.10",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz",
+ "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==",
+ "dependencies": {
+ "sprintf-js": "~1.0.2"
+ }
+ },
+ "node_modules/argparse/node_modules/sprintf-js": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz",
+ "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw="
+ },
+ "node_modules/array-each": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/array-each/-/array-each-1.0.1.tgz",
+ "integrity": "sha1-p5SvDAWrF1KEbudTofIRoFugxE8=",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/array-slice": {
"version": "1.1.0",
- "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.0.tgz",
- "integrity": "sha1-0FVMIlZjbi9W58LlrRg/hZQo2B8="
- },
- "argparse": {
- "version": "0.1.16",
- "resolved": "https://registry.npmjs.org/argparse/-/argparse-0.1.16.tgz",
- "integrity": "sha1-z9AeD7uj1srtBJ+9dY1A9lGW9Xw=",
- "requires": {
- "underscore": "1.7.0",
- "underscore.string": "2.4.0"
- },
- "dependencies": {
- "underscore.string": {
- "version": "2.4.0",
- "resolved": "https://registry.npmjs.org/underscore.string/-/underscore.string-2.4.0.tgz",
- "integrity": "sha1-jN2PusTi0uoefi6Al8QvRCKA+Fs="
- }
+ "resolved": "https://registry.npmjs.org/array-slice/-/array-slice-1.1.0.tgz",
+ "integrity": "sha512-B1qMD3RBP7O8o0H2KbrXDyB0IccejMF15+87Lvlor12ONPRHP6gTjXMNkt/d3ZuOGbAe66hFmaCfECI24Ufp6w==",
+ "engines": {
+ "node": ">=0.10.0"
}
},
- "async": {
- "version": "0.1.22",
- "resolved": "https://registry.npmjs.org/async/-/async-0.1.22.tgz",
- "integrity": "sha1-D8GqoIig4+8Ovi2IMbqw3PiEUGE="
+ "node_modules/async": {
+ "version": "3.2.4",
+ "resolved": "https://registry.npmjs.org/async/-/async-3.2.4.tgz",
+ "integrity": "sha512-iAB+JbDEGXhyIUavoDl9WP/Jj106Kz9DEn1DPgYw5ruDn0e3Wgi3sKFm55sASdGBNOQB8F59d9qQ7deqrHA8wQ=="
},
- "balanced-match": {
+ "node_modules/balanced-match": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
+ "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="
+ },
+ "node_modules/boolbase": {
"version": "1.0.0",
- "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz",
- "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c="
- },
- "brace-expansion": {
- "version": "1.1.8",
- "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.8.tgz",
- "integrity": "sha1-wHshHHyVLsH479Uad+8NHTmQopI=",
- "requires": {
- "balanced-match": "1.0.0",
+ "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz",
+ "integrity": "sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww=="
+ },
+ "node_modules/brace-expansion": {
+ "version": "1.1.11",
+ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
+ "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
+ "dependencies": {
+ "balanced-match": "^1.0.0",
"concat-map": "0.0.1"
}
},
- "cheerio": {
- "version": "0.17.0",
- "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-0.17.0.tgz",
- "integrity": "sha1-+lrkLMYBIRM9KW0LRtmDIV9yaOo=",
- "requires": {
- "CSSselect": "0.4.1",
- "dom-serializer": "0.0.1",
- "entities": "1.1.1",
- "htmlparser2": "3.7.3",
- "lodash": "2.4.2"
+ "node_modules/braces": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz",
+ "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==",
+ "dependencies": {
+ "fill-range": "^7.1.1"
},
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/chalk": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
+ "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
"dependencies": {
- "lodash": {
- "version": "2.4.2",
- "resolved": "https://registry.npmjs.org/lodash/-/lodash-2.4.2.tgz",
- "integrity": "sha1-+t2DS5aDBz2hebPq5tnA0VBT9z4="
- }
+ "ansi-styles": "^4.1.0",
+ "supports-color": "^7.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/chalk?sponsor=1"
}
},
- "coffee-script": {
- "version": "1.3.3",
- "resolved": "https://registry.npmjs.org/coffee-script/-/coffee-script-1.3.3.tgz",
- "integrity": "sha1-FQ1rTLUiiUNp7+1qIQHCC8f0pPQ="
+ "node_modules/cheerio": {
+ "version": "1.0.0-rc.12",
+ "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.0.0-rc.12.tgz",
+ "integrity": "sha512-VqR8m68vM46BNnuZ5NtnGBKIE/DfN0cRIzg9n40EIq9NOv90ayxLBXA8fXC5gquFRGJSTRqBq25Jt2ECLR431Q==",
+ "dependencies": {
+ "cheerio-select": "^2.1.0",
+ "dom-serializer": "^2.0.0",
+ "domhandler": "^5.0.3",
+ "domutils": "^3.0.1",
+ "htmlparser2": "^8.0.1",
+ "parse5": "^7.0.0",
+ "parse5-htmlparser2-tree-adapter": "^7.0.0"
+ },
+ "engines": {
+ "node": ">= 6"
+ },
+ "funding": {
+ "url": "https://github.com/cheeriojs/cheerio?sponsor=1"
+ }
},
- "colors": {
- "version": "0.6.2",
- "resolved": "https://registry.npmjs.org/colors/-/colors-0.6.2.tgz",
- "integrity": "sha1-JCP+ZnisDF2uiFLl0OW+CMmXq8w="
+ "node_modules/cheerio-select": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-2.1.0.tgz",
+ "integrity": "sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g==",
+ "dependencies": {
+ "boolbase": "^1.0.0",
+ "css-select": "^5.1.0",
+ "css-what": "^6.1.0",
+ "domelementtype": "^2.3.0",
+ "domhandler": "^5.0.3",
+ "domutils": "^3.0.1"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/fb55"
+ }
+ },
+ "node_modules/color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "dependencies": {
+ "color-name": "~1.1.4"
+ },
+ "engines": {
+ "node": ">=7.0.0"
+ }
},
- "concat-map": {
+ "node_modules/color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+ },
+ "node_modules/colors": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/colors/-/colors-1.1.2.tgz",
+ "integrity": "sha1-FopHAXVran9RoSzgyXv6KMCE7WM=",
+ "engines": {
+ "node": ">=0.1.90"
+ }
+ },
+ "node_modules/concat-map": {
"version": "0.0.1",
"resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
"integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s="
},
- "core-util-is": {
- "version": "1.0.2",
- "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz",
- "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac="
+ "node_modules/css-select": {
+ "version": "5.1.0",
+ "resolved": "https://registry.npmjs.org/css-select/-/css-select-5.1.0.tgz",
+ "integrity": "sha512-nwoRF1rvRRnnCqqY7updORDsuqKzqYJ28+oSMaJMMgOauh3fvwHqMS7EZpIPqK8GL+g9mKxF1vP/ZjSeNjEVHg==",
+ "dependencies": {
+ "boolbase": "^1.0.0",
+ "css-what": "^6.1.0",
+ "domhandler": "^5.0.2",
+ "domutils": "^3.0.1",
+ "nth-check": "^2.0.1"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/fb55"
+ }
},
- "CSSselect": {
- "version": "0.4.1",
- "resolved": "https://registry.npmjs.org/CSSselect/-/CSSselect-0.4.1.tgz",
- "integrity": "sha1-+Kt+H4QYzmPNput713ioXX7EkrI=",
- "requires": {
- "CSSwhat": "0.4.7",
- "domutils": "1.4.3"
+ "node_modules/css-what": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/css-what/-/css-what-6.1.0.tgz",
+ "integrity": "sha512-HTUrgRJ7r4dsZKU6GjmpfRK1O76h97Z8MfS1G0FozR+oF2kG6Vfe8JE6zwrkbxigziPHinCJ+gCPjA9EaBDtRw==",
+ "engines": {
+ "node": ">= 6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/fb55"
}
},
- "CSSwhat": {
- "version": "0.4.7",
- "resolved": "https://registry.npmjs.org/CSSwhat/-/CSSwhat-0.4.7.tgz",
- "integrity": "sha1-hn2g/zn3eGEyQsRM/qg/CqTr35s="
+ "node_modules/dateformat": {
+ "version": "4.6.3",
+ "resolved": "https://registry.npmjs.org/dateformat/-/dateformat-4.6.3.tgz",
+ "integrity": "sha512-2P0p0pFGzHS5EMnhdxQi7aJN+iMheud0UhG4dlE1DLAlvL8JHjJJTX/CSm4JXwV0Ka5nGk3zC5mcb5bUQUxxMA==",
+ "engines": {
+ "node": "*"
+ }
},
- "dateformat": {
- "version": "1.0.2-1.2.3",
- "resolved": "https://registry.npmjs.org/dateformat/-/dateformat-1.0.2-1.2.3.tgz",
- "integrity": "sha1-sCIMAt6YYXQztyhRz0fePfLNvuk="
+ "node_modules/detect-file": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/detect-file/-/detect-file-1.0.0.tgz",
+ "integrity": "sha1-8NZtA2cqglyxtzvbP+YjEMjlUrc=",
+ "engines": {
+ "node": ">=0.10.0"
+ }
},
- "dom-serializer": {
- "version": "0.0.1",
- "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-0.0.1.tgz",
- "integrity": "sha1-lYmCfx4y0iw3yCmtq9WbMkevjq8=",
- "requires": {
- "domelementtype": "1.1.3",
- "entities": "1.1.1"
- },
+ "node_modules/dom-serializer": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz",
+ "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==",
"dependencies": {
- "domelementtype": {
- "version": "1.1.3",
- "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-1.1.3.tgz",
- "integrity": "sha1-vSh3PiZCiBrsUVRJJCmcXNgiGFs="
- }
+ "domelementtype": "^2.3.0",
+ "domhandler": "^5.0.2",
+ "entities": "^4.2.0"
+ },
+ "funding": {
+ "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1"
}
},
- "domelementtype": {
- "version": "1.3.0",
- "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-1.3.0.tgz",
- "integrity": "sha1-sXrtguirWeUt2cGbF1bg/BhyBMI="
+ "node_modules/domelementtype": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.3.0.tgz",
+ "integrity": "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/fb55"
+ }
+ ]
},
- "domhandler": {
- "version": "2.2.1",
- "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-2.2.1.tgz",
- "integrity": "sha1-Wd+dzSJ+gIs2Wuc+H2aErD2Ub8I=",
- "requires": {
- "domelementtype": "1.3.0"
+ "node_modules/domhandler": {
+ "version": "5.0.3",
+ "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz",
+ "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==",
+ "dependencies": {
+ "domelementtype": "^2.3.0"
+ },
+ "engines": {
+ "node": ">= 4"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/domhandler?sponsor=1"
}
},
- "domutils": {
- "version": "1.4.3",
- "resolved": "https://registry.npmjs.org/domutils/-/domutils-1.4.3.tgz",
- "integrity": "sha1-CGVRN5bGswYDGFDhdVFrr4C3Km8=",
- "requires": {
- "domelementtype": "1.3.0"
+ "node_modules/domutils": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.1.0.tgz",
+ "integrity": "sha512-H78uMmQtI2AhgDJjWeQmHwJJ2bLPD3GMmO7Zja/ZZh84wkm+4ut+IUnUdRa8uCGX88DiVx1j6FRe1XfxEgjEZA==",
+ "dependencies": {
+ "dom-serializer": "^2.0.0",
+ "domelementtype": "^2.3.0",
+ "domhandler": "^5.0.3"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/domutils?sponsor=1"
}
},
- "entities": {
- "version": "1.1.1",
- "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.1.tgz",
- "integrity": "sha1-blwtClYhtdra7O+AuQ7ftc13cvA="
+ "node_modules/entities": {
+ "version": "4.5.0",
+ "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz",
+ "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==",
+ "engines": {
+ "node": ">=0.12"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/entities?sponsor=1"
+ }
},
- "esprima": {
- "version": "1.0.4",
- "resolved": "https://registry.npmjs.org/esprima/-/esprima-1.0.4.tgz",
- "integrity": "sha1-n1V+CPw7TSbs6d00+Pv0drYlha0="
+ "node_modules/esprima": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
+ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==",
+ "bin": {
+ "esparse": "bin/esparse.js",
+ "esvalidate": "bin/esvalidate.js"
+ },
+ "engines": {
+ "node": ">=4"
+ }
},
- "eventemitter2": {
+ "node_modules/eventemitter2": {
"version": "0.4.14",
"resolved": "https://registry.npmjs.org/eventemitter2/-/eventemitter2-0.4.14.tgz",
"integrity": "sha1-j2G3XN4BKy6esoTUVFWDtWQ7Yas="
},
- "exit": {
+ "node_modules/exit": {
"version": "0.1.2",
"resolved": "https://registry.npmjs.org/exit/-/exit-0.1.2.tgz",
- "integrity": "sha1-BjJjj42HfMghB9MKD/8aF8uhzQw="
- },
- "findup-sync": {
- "version": "0.1.3",
- "resolved": "https://registry.npmjs.org/findup-sync/-/findup-sync-0.1.3.tgz",
- "integrity": "sha1-fz56l7gjksZTvwZYm9hRkOk8NoM=",
- "requires": {
- "glob": "3.2.11",
- "lodash": "2.4.2"
- },
- "dependencies": {
- "glob": {
- "version": "3.2.11",
- "resolved": "https://registry.npmjs.org/glob/-/glob-3.2.11.tgz",
- "integrity": "sha1-Spc/Y1uRkPcV0QmH1cAP0oFevj0=",
- "requires": {
- "inherits": "2.0.3",
- "minimatch": "0.3.0"
- }
- },
- "lodash": {
- "version": "2.4.2",
- "resolved": "https://registry.npmjs.org/lodash/-/lodash-2.4.2.tgz",
- "integrity": "sha1-+t2DS5aDBz2hebPq5tnA0VBT9z4="
- },
- "minimatch": {
- "version": "0.3.0",
- "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-0.3.0.tgz",
- "integrity": "sha1-J12O2qxPG7MyZHIInnlJyDlGmd0=",
- "requires": {
- "lru-cache": "2.7.3",
- "sigmund": "1.0.1"
- }
- }
+ "integrity": "sha1-BjJjj42HfMghB9MKD/8aF8uhzQw=",
+ "engines": {
+ "node": ">= 0.8.0"
}
},
- "getobject": {
- "version": "0.1.0",
- "resolved": "https://registry.npmjs.org/getobject/-/getobject-0.1.0.tgz",
- "integrity": "sha1-BHpEl4n6Fg0Bj1SG7ZEyC27HiFw="
+ "node_modules/expand-tilde": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/expand-tilde/-/expand-tilde-2.0.2.tgz",
+ "integrity": "sha1-l+gBqgUt8CRU3kawK/YhZCzchQI=",
+ "dependencies": {
+ "homedir-polyfill": "^1.0.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
},
- "gilded-wordpress": {
- "version": "1.0.3",
- "resolved": "https://registry.npmjs.org/gilded-wordpress/-/gilded-wordpress-1.0.3.tgz",
- "integrity": "sha1-kh/iJ93yWyxAgp5QUjsOMXRDsz4=",
- "requires": {
- "async": "0.9.2",
- "glob": "4.0.6",
- "wordpress": "1.1.2"
- },
- "dependencies": {
- "async": {
- "version": "0.9.2",
- "resolved": "https://registry.npmjs.org/async/-/async-0.9.2.tgz",
- "integrity": "sha1-rqdNXmHB+JlhO/ZL2mbUx48v0X0="
- },
- "glob": {
- "version": "4.0.6",
- "resolved": "https://registry.npmjs.org/glob/-/glob-4.0.6.tgz",
- "integrity": "sha1-aVxQvdTi+1xdNwsJHziNNwfikac=",
- "requires": {
- "graceful-fs": "3.0.11",
- "inherits": "2.0.3",
- "minimatch": "1.0.0",
- "once": "1.4.0"
- }
- },
- "graceful-fs": {
- "version": "3.0.11",
- "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-3.0.11.tgz",
- "integrity": "sha1-dhPHeKGv6mLyXGMKCG1/Osu92Bg=",
- "requires": {
- "natives": "1.1.0"
- }
- },
- "minimatch": {
- "version": "1.0.0",
- "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-1.0.0.tgz",
- "integrity": "sha1-4N0hILSeG3JM6NcUxSCCKpQ4V20=",
- "requires": {
- "lru-cache": "2.7.3",
- "sigmund": "1.0.1"
- }
- }
+ "node_modules/extend": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz",
+ "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g=="
+ },
+ "node_modules/fill-range": {
+ "version": "7.1.1",
+ "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
+ "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==",
+ "dependencies": {
+ "to-regex-range": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
}
},
- "glob": {
- "version": "3.1.21",
- "resolved": "https://registry.npmjs.org/glob/-/glob-3.1.21.tgz",
- "integrity": "sha1-0p4KBV3qUTj00H7UDomC6DwgZs0=",
- "requires": {
- "graceful-fs": "1.2.3",
- "inherits": "1.0.2",
- "minimatch": "0.2.14"
+ "node_modules/findup-sync": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/findup-sync/-/findup-sync-5.0.0.tgz",
+ "integrity": "sha512-MzwXju70AuyflbgeOhzvQWAvvQdo1XL0A9bVvlXsYcFEBM87WR4OakL4OfZq+QRmr+duJubio+UtNQCPsVESzQ==",
+ "dependencies": {
+ "detect-file": "^1.0.0",
+ "is-glob": "^4.0.3",
+ "micromatch": "^4.0.4",
+ "resolve-dir": "^1.0.1"
},
+ "engines": {
+ "node": ">= 10.13.0"
+ }
+ },
+ "node_modules/fined": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/fined/-/fined-1.2.0.tgz",
+ "integrity": "sha512-ZYDqPLGxDkDhDZBjZBb+oD1+j0rA4E0pXY50eplAAOPg2N/gUBSSk5IM1/QhPfyVo19lJ+CvXpqfvk+b2p/8Ng==",
"dependencies": {
- "inherits": {
- "version": "1.0.2",
- "resolved": "https://registry.npmjs.org/inherits/-/inherits-1.0.2.tgz",
- "integrity": "sha1-ykMJ2t7mtUzAuNJH6NfHoJdb3Js="
- }
+ "expand-tilde": "^2.0.2",
+ "is-plain-object": "^2.0.3",
+ "object.defaults": "^1.1.0",
+ "object.pick": "^1.2.0",
+ "parse-filepath": "^1.0.1"
+ },
+ "engines": {
+ "node": ">= 0.10"
}
},
- "graceful-fs": {
- "version": "1.2.3",
- "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-1.2.3.tgz",
- "integrity": "sha1-FaSAaldUfLLS2/J/QuiajDRRs2Q="
- },
- "grunt": {
- "version": "0.4.5",
- "resolved": "https://registry.npmjs.org/grunt/-/grunt-0.4.5.tgz",
- "integrity": "sha1-VpN81RlDJK3/bSB2MYMqnWuk5/A=",
- "requires": {
- "async": "0.1.22",
- "coffee-script": "1.3.3",
- "colors": "0.6.2",
- "dateformat": "1.0.2-1.2.3",
- "eventemitter2": "0.4.14",
- "exit": "0.1.2",
- "findup-sync": "0.1.3",
- "getobject": "0.1.0",
- "glob": "3.1.21",
- "grunt-legacy-log": "0.1.3",
- "grunt-legacy-util": "0.2.0",
- "hooker": "0.2.3",
- "iconv-lite": "0.2.11",
- "js-yaml": "2.0.5",
- "lodash": "0.9.2",
- "minimatch": "0.2.14",
- "nopt": "1.0.10",
- "rimraf": "2.2.8",
- "underscore.string": "2.2.1",
- "which": "1.0.9"
- }
- },
- "grunt-check-modules": {
+ "node_modules/flagged-respawn": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/flagged-respawn/-/flagged-respawn-1.0.1.tgz",
+ "integrity": "sha512-lNaHNVymajmk0OJMBn8fVUAU1BtDeKIqKoVhk4xAALB57aALg6b4W0MfJ/cUE0g9YBXy5XhSlPIpYIJ7HaY/3Q==",
+ "engines": {
+ "node": ">= 0.10"
+ }
+ },
+ "node_modules/for-in": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/for-in/-/for-in-1.0.2.tgz",
+ "integrity": "sha1-gQaNKVqBQuwKxybG4iAMMPttXoA=",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/for-own": {
"version": "1.0.0",
- "resolved": "https://registry.npmjs.org/grunt-check-modules/-/grunt-check-modules-1.0.0.tgz",
- "integrity": "sha1-Y/9erkYTF5tKifaozTcfekAfd4I="
+ "resolved": "https://registry.npmjs.org/for-own/-/for-own-1.0.0.tgz",
+ "integrity": "sha1-xjMy9BXO3EsE2/5wz4NklMU8tEs=",
+ "dependencies": {
+ "for-in": "^1.0.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/fs.realpath": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
+ "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8="
+ },
+ "node_modules/function-bind": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz",
+ "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A=="
+ },
+ "node_modules/getobject": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/getobject/-/getobject-1.0.2.tgz",
+ "integrity": "sha512-2zblDBaFcb3rB4rF77XVnuINOE2h2k/OnqXAiy0IrTxUfV1iFp3la33oAQVY9pCpWU268WFYVt2t71hlMuLsOg==",
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/gilded-wordpress": {
+ "version": "1.0.7",
+ "resolved": "https://registry.npmjs.org/gilded-wordpress/-/gilded-wordpress-1.0.7.tgz",
+ "integrity": "sha512-w8g4jfs1TWywX2hZ4+LlzQoz2z/JRX/8S6OgelD3IUsNnGHxXQ1FgExoIqomwZVPAmxYs0vEu2BeA1Y4KciZlw==",
+ "dependencies": {
+ "async": "^0.9.0",
+ "wordpress": "^1.4.2"
+ }
},
- "grunt-cli": {
+ "node_modules/gilded-wordpress/node_modules/async": {
+ "version": "0.9.2",
+ "resolved": "https://registry.npmjs.org/async/-/async-0.9.2.tgz",
+ "integrity": "sha512-l6ToIJIotphWahxxHyzK9bnLR6kM4jJIIgLShZeqLY7iboHoGkdgFl7W2/Ivi4SkMJYGKqW8vSuk0uKUj6qsSw=="
+ },
+ "node_modules/glob": {
+ "version": "7.1.7",
+ "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.7.tgz",
+ "integrity": "sha512-OvD9ENzPLbegENnYP5UUfJIirTg4+XwMWGaQfQTY0JenxNvvIKP3U3/tAQSPIu/lHxXYSZmpXlUHeqAIdKzBLQ==",
+ "dependencies": {
+ "fs.realpath": "^1.0.0",
+ "inflight": "^1.0.4",
+ "inherits": "2",
+ "minimatch": "^3.0.4",
+ "once": "^1.3.0",
+ "path-is-absolute": "^1.0.0"
+ },
+ "engines": {
+ "node": "*"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/global-modules": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/global-modules/-/global-modules-1.0.0.tgz",
+ "integrity": "sha512-sKzpEkf11GpOFuw0Zzjzmt4B4UZwjOcG757PPvrfhxcLFbq0wpsgpOqxpxtxFiCG4DtG93M6XRVbF2oGdev7bg==",
+ "dependencies": {
+ "global-prefix": "^1.0.1",
+ "is-windows": "^1.0.1",
+ "resolve-dir": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/global-prefix": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/global-prefix/-/global-prefix-1.0.2.tgz",
+ "integrity": "sha1-2/dDxsFJklk8ZVVoy2btMsASLr4=",
+ "dependencies": {
+ "expand-tilde": "^2.0.2",
+ "homedir-polyfill": "^1.0.1",
+ "ini": "^1.3.4",
+ "is-windows": "^1.0.1",
+ "which": "^1.2.14"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/grunt": {
+ "version": "1.6.1",
+ "resolved": "https://registry.npmjs.org/grunt/-/grunt-1.6.1.tgz",
+ "integrity": "sha512-/ABUy3gYWu5iBmrUSRBP97JLpQUm0GgVveDCp6t3yRNIoltIYw7rEj3g5y1o2PGPR2vfTRGa7WC/LZHLTXnEzA==",
+ "dependencies": {
+ "dateformat": "~4.6.2",
+ "eventemitter2": "~0.4.13",
+ "exit": "~0.1.2",
+ "findup-sync": "~5.0.0",
+ "glob": "~7.1.6",
+ "grunt-cli": "~1.4.3",
+ "grunt-known-options": "~2.0.0",
+ "grunt-legacy-log": "~3.0.0",
+ "grunt-legacy-util": "~2.0.1",
+ "iconv-lite": "~0.6.3",
+ "js-yaml": "~3.14.0",
+ "minimatch": "~3.0.4",
+ "nopt": "~3.0.6"
+ },
+ "bin": {
+ "grunt": "bin/grunt"
+ },
+ "engines": {
+ "node": ">=16"
+ }
+ },
+ "node_modules/grunt-check-modules": {
"version": "1.1.0",
- "resolved": "https://registry.npmjs.org/grunt-cli/-/grunt-cli-1.1.0.tgz",
- "integrity": "sha1-r9eWmTTd8zYg6ER+3B+pTlHlWjQ=",
- "requires": {
- "findup-sync": "0.3.0",
- "nopt": "3.0.6",
- "resolve": "1.1.7"
- },
- "dependencies": {
- "findup-sync": {
- "version": "0.3.0",
- "resolved": "https://registry.npmjs.org/findup-sync/-/findup-sync-0.3.0.tgz",
- "integrity": "sha1-N5MKpdgWt3fANEXhlmzGeQpMCxY=",
- "requires": {
- "glob": "5.0.15"
- }
- },
- "glob": {
- "version": "5.0.15",
- "resolved": "https://registry.npmjs.org/glob/-/glob-5.0.15.tgz",
- "integrity": "sha1-G8k2ueAvSmA/zCIuz3Yz0wuLk7E=",
- "requires": {
- "inflight": "1.0.6",
- "inherits": "2.0.3",
- "minimatch": "3.0.4",
- "once": "1.4.0",
- "path-is-absolute": "1.0.1"
- }
- },
- "minimatch": {
- "version": "3.0.4",
- "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
- "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
- "requires": {
- "brace-expansion": "1.1.8"
- }
- },
- "nopt": {
- "version": "3.0.6",
- "resolved": "https://registry.npmjs.org/nopt/-/nopt-3.0.6.tgz",
- "integrity": "sha1-xkZdvwirzU2zWTF/eaxopkayj/k=",
- "requires": {
- "abbrev": "1.1.0"
- }
- }
+ "resolved": "https://registry.npmjs.org/grunt-check-modules/-/grunt-check-modules-1.1.0.tgz",
+ "integrity": "sha1-fBZB28ZlSGdqbVl5Ga35C3s11kQ=",
+ "engines": {
+ "node": ">=0.6.0"
+ },
+ "peerDependencies": {
+ "grunt": ">=0.4.0"
}
},
- "grunt-jquery-content": {
- "version": "3.0.1",
- "resolved": "https://registry.npmjs.org/grunt-jquery-content/-/grunt-jquery-content-3.0.1.tgz",
- "integrity": "sha1-aHdrx0G1SVEdaPBouVCsizd+g90=",
- "requires": {
- "async": "0.9.0",
- "cheerio": "0.17.0",
- "grunt-check-modules": "1.0.0",
- "grunt-wordpress": "2.1.2",
- "he": "0.5.0",
- "highlight.js": "7.3.0",
- "marked": "0.3.2",
- "rimraf": "2.2.8",
- "spawnback": "1.0.0",
- "which": "1.0.5",
- "wordpress": "1.1.2"
- },
- "dependencies": {
- "async": {
- "version": "0.9.0",
- "resolved": "https://registry.npmjs.org/async/-/async-0.9.0.tgz",
- "integrity": "sha1-rDYTsdqb7RtHUQu0ZRuJMeRxRsc="
- },
- "which": {
- "version": "1.0.5",
- "resolved": "https://registry.npmjs.org/which/-/which-1.0.5.tgz",
- "integrity": "sha1-VjDWgZ3aaS8UZEYueVbLQsCEJzk="
- }
+ "node_modules/grunt-jquery-content": {
+ "version": "3.3.2",
+ "resolved": "https://registry.npmjs.org/grunt-jquery-content/-/grunt-jquery-content-3.3.2.tgz",
+ "integrity": "sha512-b6w8GBe022BG8O7BkhAKBFcBBAldoIiwAUZ2WI+A8HIouXy8XS8Cwp2RuUPEACg3g2/wHOarmjrsFKFPmmZ55Q==",
+ "dependencies": {
+ "cheerio": "^1.0.0-rc.12",
+ "gilded-wordpress": "1.0.7",
+ "grunt-check-modules": "^1.1.0",
+ "he": "^1.2.0",
+ "highlight.js": "^10.7.2",
+ "marked": "^4.0.0",
+ "which": "^4.0.0",
+ "wordpress": "^1.4.1"
}
},
- "grunt-legacy-log": {
- "version": "0.1.3",
- "resolved": "https://registry.npmjs.org/grunt-legacy-log/-/grunt-legacy-log-0.1.3.tgz",
- "integrity": "sha1-7ClCboAwIa9ZAp+H0vnNczWgVTE=",
- "requires": {
- "colors": "0.6.2",
- "grunt-legacy-log-utils": "0.1.1",
- "hooker": "0.2.3",
- "lodash": "2.4.2",
- "underscore.string": "2.3.3"
- },
- "dependencies": {
- "lodash": {
- "version": "2.4.2",
- "resolved": "https://registry.npmjs.org/lodash/-/lodash-2.4.2.tgz",
- "integrity": "sha1-+t2DS5aDBz2hebPq5tnA0VBT9z4="
- },
- "underscore.string": {
- "version": "2.3.3",
- "resolved": "https://registry.npmjs.org/underscore.string/-/underscore.string-2.3.3.tgz",
- "integrity": "sha1-ccCL9rQosRM/N+ePo6Icgvcymw0="
- }
+ "node_modules/grunt-jquery-content/node_modules/isexe": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/isexe/-/isexe-3.1.1.tgz",
+ "integrity": "sha512-LpB/54B+/2J5hqQ7imZHfdU31OlgQqx7ZicVlkm9kzg9/w8GKLEcFfJl/t7DCEDueOyBAD6zCCwTO6Fzs0NoEQ==",
+ "engines": {
+ "node": ">=16"
}
},
- "grunt-legacy-log-utils": {
- "version": "0.1.1",
- "resolved": "https://registry.npmjs.org/grunt-legacy-log-utils/-/grunt-legacy-log-utils-0.1.1.tgz",
- "integrity": "sha1-wHBrndkGThFvNvI/5OawSGcsD34=",
- "requires": {
- "colors": "0.6.2",
- "lodash": "2.4.2",
- "underscore.string": "2.3.3"
- },
- "dependencies": {
- "lodash": {
- "version": "2.4.2",
- "resolved": "https://registry.npmjs.org/lodash/-/lodash-2.4.2.tgz",
- "integrity": "sha1-+t2DS5aDBz2hebPq5tnA0VBT9z4="
- },
- "underscore.string": {
- "version": "2.3.3",
- "resolved": "https://registry.npmjs.org/underscore.string/-/underscore.string-2.3.3.tgz",
- "integrity": "sha1-ccCL9rQosRM/N+ePo6Icgvcymw0="
- }
+ "node_modules/grunt-jquery-content/node_modules/which": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/which/-/which-4.0.0.tgz",
+ "integrity": "sha512-GlaYyEb07DPxYCKhKzplCWBJtvxZcZMrL+4UkrTSJHHPyZU4mYYTv3qaOe77H7EODLSSopAUFAc6W8U4yqvscg==",
+ "dependencies": {
+ "isexe": "^3.1.1"
+ },
+ "bin": {
+ "node-which": "bin/which.js"
+ },
+ "engines": {
+ "node": "^16.13.0 || >=18.0.0"
}
},
- "grunt-legacy-util": {
- "version": "0.2.0",
- "resolved": "https://registry.npmjs.org/grunt-legacy-util/-/grunt-legacy-util-0.2.0.tgz",
- "integrity": "sha1-kzJIhNv343qf98Am3/RR2UqeVUs=",
- "requires": {
- "async": "0.1.22",
- "exit": "0.1.2",
- "getobject": "0.1.0",
- "hooker": "0.2.3",
- "lodash": "0.9.2",
- "underscore.string": "2.2.1",
- "which": "1.0.9"
+ "node_modules/grunt-legacy-log": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/grunt-legacy-log/-/grunt-legacy-log-3.0.0.tgz",
+ "integrity": "sha512-GHZQzZmhyq0u3hr7aHW4qUH0xDzwp2YXldLPZTCjlOeGscAOWWPftZG3XioW8MasGp+OBRIu39LFx14SLjXRcA==",
+ "dependencies": {
+ "colors": "~1.1.2",
+ "grunt-legacy-log-utils": "~2.1.0",
+ "hooker": "~0.2.3",
+ "lodash": "~4.17.19"
+ },
+ "engines": {
+ "node": ">= 0.10.0"
}
},
- "grunt-wordpress": {
- "version": "2.1.2",
- "resolved": "https://registry.npmjs.org/grunt-wordpress/-/grunt-wordpress-2.1.2.tgz",
- "integrity": "sha1-ue3Lv5jp6HM9F6gsMmWf2zbO2LE=",
- "requires": {
- "gilded-wordpress": "1.0.3"
+ "node_modules/grunt-legacy-log-utils": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/grunt-legacy-log-utils/-/grunt-legacy-log-utils-2.1.0.tgz",
+ "integrity": "sha512-lwquaPXJtKQk0rUM1IQAop5noEpwFqOXasVoedLeNzaibf/OPWjKYvvdqnEHNmU+0T0CaReAXIbGo747ZD+Aaw==",
+ "dependencies": {
+ "chalk": "~4.1.0",
+ "lodash": "~4.17.19"
+ },
+ "engines": {
+ "node": ">=10"
}
},
- "he": {
- "version": "0.5.0",
- "resolved": "https://registry.npmjs.org/he/-/he-0.5.0.tgz",
- "integrity": "sha1-LAX/rvkLaOhg8/0rVO9YCYknfuI="
+ "node_modules/grunt-legacy-util": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/grunt-legacy-util/-/grunt-legacy-util-2.0.1.tgz",
+ "integrity": "sha512-2bQiD4fzXqX8rhNdXkAywCadeqiPiay0oQny77wA2F3WF4grPJXCvAcyoWUJV+po/b15glGkxuSiQCK299UC2w==",
+ "dependencies": {
+ "async": "~3.2.0",
+ "exit": "~0.1.2",
+ "getobject": "~1.0.0",
+ "hooker": "~0.2.3",
+ "lodash": "~4.17.21",
+ "underscore.string": "~3.3.5",
+ "which": "~2.0.2"
+ },
+ "engines": {
+ "node": ">=10"
+ }
},
- "highlight.js": {
- "version": "7.3.0",
- "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-7.3.0.tgz",
- "integrity": "sha1-bF8PZOcHj2ZAK82/yJEQw/0bqZ8="
+ "node_modules/grunt-legacy-util/node_modules/which": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
+ "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
+ "dependencies": {
+ "isexe": "^2.0.0"
+ },
+ "bin": {
+ "node-which": "bin/node-which"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
},
- "hooker": {
+ "node_modules/grunt/node_modules/grunt-cli": {
+ "version": "1.4.3",
+ "resolved": "https://registry.npmjs.org/grunt-cli/-/grunt-cli-1.4.3.tgz",
+ "integrity": "sha512-9Dtx/AhVeB4LYzsViCjUQkd0Kw0McN2gYpdmGYKtE2a5Yt7v1Q+HYZVWhqXc/kGnxlMtqKDxSwotiGeFmkrCoQ==",
+ "dependencies": {
+ "grunt-known-options": "~2.0.0",
+ "interpret": "~1.1.0",
+ "liftup": "~3.0.1",
+ "nopt": "~4.0.1",
+ "v8flags": "~3.2.0"
+ },
+ "bin": {
+ "grunt": "bin/grunt"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/grunt/node_modules/grunt-cli/node_modules/nopt": {
+ "version": "4.0.3",
+ "resolved": "https://registry.npmjs.org/nopt/-/nopt-4.0.3.tgz",
+ "integrity": "sha512-CvaGwVMztSMJLOeXPrez7fyfObdZqNUK1cPAEzLHrTybIua9pMdmmPR5YwtfNftIOMv3DPUhFaxsZMNTQO20Kg==",
+ "dependencies": {
+ "abbrev": "1",
+ "osenv": "^0.1.4"
+ },
+ "bin": {
+ "nopt": "bin/nopt.js"
+ }
+ },
+ "node_modules/grunt/node_modules/grunt-known-options": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/grunt-known-options/-/grunt-known-options-2.0.0.tgz",
+ "integrity": "sha512-GD7cTz0I4SAede1/+pAbmJRG44zFLPipVtdL9o3vqx9IEyb7b4/Y3s7r6ofI3CchR5GvYJ+8buCSioDv5dQLiA==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/has": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz",
+ "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==",
+ "dependencies": {
+ "function-bind": "^1.1.1"
+ },
+ "engines": {
+ "node": ">= 0.4.0"
+ }
+ },
+ "node_modules/has-flag": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
+ "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/he": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz",
+ "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==",
+ "bin": {
+ "he": "bin/he"
+ }
+ },
+ "node_modules/highlight.js": {
+ "version": "10.7.2",
+ "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-10.7.2.tgz",
+ "integrity": "sha512-oFLl873u4usRM9K63j4ME9u3etNF0PLiJhSQ8rdfuL51Wn3zkD6drf9ZW0dOzjnZI22YYG24z30JcmfCZjMgYg==",
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/homedir-polyfill": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/homedir-polyfill/-/homedir-polyfill-1.0.3.tgz",
+ "integrity": "sha512-eSmmWE5bZTK2Nou4g0AI3zZ9rswp7GRKoKXS1BLUkvPviOqs4YTN1djQIqrXy9k5gEtdLPy86JjRwsNM9tnDcA==",
+ "dependencies": {
+ "parse-passwd": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/hooker": {
"version": "0.2.3",
"resolved": "https://registry.npmjs.org/hooker/-/hooker-0.2.3.tgz",
- "integrity": "sha1-uDT3I8xKJCqmWWNFnfbZhMXT2Vk="
- },
- "htmlparser2": {
- "version": "3.7.3",
- "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-3.7.3.tgz",
- "integrity": "sha1-amTHdjfAjG8w7CqBV6UzM758sF4=",
- "requires": {
- "domelementtype": "1.3.0",
- "domhandler": "2.2.1",
- "domutils": "1.5.1",
- "entities": "1.0.0",
- "readable-stream": "1.1.14"
- },
- "dependencies": {
- "domutils": {
- "version": "1.5.1",
- "resolved": "https://registry.npmjs.org/domutils/-/domutils-1.5.1.tgz",
- "integrity": "sha1-3NhIiib1Y9YQeeSMn3t+Mjc2gs8=",
- "requires": {
- "dom-serializer": "0.0.1",
- "domelementtype": "1.3.0"
- }
- },
- "entities": {
- "version": "1.0.0",
- "resolved": "https://registry.npmjs.org/entities/-/entities-1.0.0.tgz",
- "integrity": "sha1-sph6o4ITR/zeZCsk/fyeT7cSvyY="
+ "integrity": "sha1-uDT3I8xKJCqmWWNFnfbZhMXT2Vk=",
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/htmlparser2": {
+ "version": "8.0.2",
+ "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-8.0.2.tgz",
+ "integrity": "sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA==",
+ "funding": [
+ "https://github.com/fb55/htmlparser2?sponsor=1",
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/fb55"
}
+ ],
+ "dependencies": {
+ "domelementtype": "^2.3.0",
+ "domhandler": "^5.0.3",
+ "domutils": "^3.0.1",
+ "entities": "^4.4.0"
}
},
- "iconv-lite": {
- "version": "0.2.11",
- "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.2.11.tgz",
- "integrity": "sha1-HOYKOleGSiktEyH/RgnKS7llrcg="
+ "node_modules/iconv-lite": {
+ "version": "0.6.3",
+ "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz",
+ "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==",
+ "dependencies": {
+ "safer-buffer": ">= 2.1.2 < 3.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
},
- "inflight": {
+ "node_modules/inflight": {
"version": "1.0.6",
"resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
"integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=",
- "requires": {
- "once": "1.4.0",
- "wrappy": "1.0.2"
+ "dependencies": {
+ "once": "^1.3.0",
+ "wrappy": "1"
}
},
- "inherits": {
- "version": "2.0.3",
- "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz",
- "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4="
+ "node_modules/inherits": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
+ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="
},
- "isarray": {
- "version": "0.0.1",
- "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz",
- "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8="
+ "node_modules/ini": {
+ "version": "1.3.8",
+ "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz",
+ "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew=="
},
- "js-yaml": {
- "version": "2.0.5",
- "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-2.0.5.tgz",
- "integrity": "sha1-olrmUJmZ6X3yeMZxnaEb0Gh3Q6g=",
- "requires": {
- "argparse": "0.1.16",
- "esprima": "1.0.4"
+ "node_modules/interpret": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.1.0.tgz",
+ "integrity": "sha1-ftGxQQxqDg94z5XTuEQMY/eLhhQ="
+ },
+ "node_modules/is-absolute": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-absolute/-/is-absolute-1.0.0.tgz",
+ "integrity": "sha512-dOWoqflvcydARa360Gvv18DZ/gRuHKi2NU/wU5X1ZFzdYfH29nkiNZsF3mp4OJ3H4yo9Mx8A/uAGNzpzPN3yBA==",
+ "dependencies": {
+ "is-relative": "^1.0.0",
+ "is-windows": "^1.0.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
}
},
- "lodash": {
- "version": "0.9.2",
- "resolved": "https://registry.npmjs.org/lodash/-/lodash-0.9.2.tgz",
- "integrity": "sha1-jzSZxSRdNG1oLlsNO0B2fgnxqSw="
+ "node_modules/is-core-module": {
+ "version": "2.4.0",
+ "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.4.0.tgz",
+ "integrity": "sha512-6A2fkfq1rfeQZjxrZJGerpLCTHRNEBiSgnu0+obeJpEPZRUooHgsizvzv0ZjJwOz3iWIHdJtVWJ/tmPr3D21/A==",
+ "dependencies": {
+ "has": "^1.0.3"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-extglob": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz",
+ "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-glob": {
+ "version": "4.0.3",
+ "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz",
+ "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==",
+ "dependencies": {
+ "is-extglob": "^2.1.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-number": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+ "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
+ "engines": {
+ "node": ">=0.12.0"
+ }
+ },
+ "node_modules/is-plain-object": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz",
+ "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==",
+ "dependencies": {
+ "isobject": "^3.0.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-relative": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-relative/-/is-relative-1.0.0.tgz",
+ "integrity": "sha512-Kw/ReK0iqwKeu0MITLFuj0jbPAmEiOsIwyIXvvbfa6QfmN9pkD1M+8pdk7Rl/dTKbH34/XBFMbgD4iMJhLQbGA==",
+ "dependencies": {
+ "is-unc-path": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-unc-path": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-unc-path/-/is-unc-path-1.0.0.tgz",
+ "integrity": "sha512-mrGpVd0fs7WWLfVsStvgF6iEJnbjDFZh9/emhRDcGWTduTfNHd9CHeUwH3gYIjdbwo4On6hunkztwOaAw0yllQ==",
+ "dependencies": {
+ "unc-path-regex": "^0.1.2"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-windows": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz",
+ "integrity": "sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/isexe": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
+ "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA="
+ },
+ "node_modules/isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/js-yaml": {
+ "version": "3.14.1",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz",
+ "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==",
+ "dependencies": {
+ "argparse": "^1.0.7",
+ "esprima": "^4.0.0"
+ },
+ "bin": {
+ "js-yaml": "bin/js-yaml.js"
+ }
},
- "lru-cache": {
- "version": "2.7.3",
- "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-2.7.3.tgz",
- "integrity": "sha1-bUUk6LlV+V1PW1iFHOId1y+06VI="
+ "node_modules/kind-of": {
+ "version": "6.0.3",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz",
+ "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
},
- "marked": {
- "version": "0.3.2",
- "resolved": "https://registry.npmjs.org/marked/-/marked-0.3.2.tgz",
- "integrity": "sha1-AV2xWIZEOPJKZL3WGgQotBhwbQk="
+ "node_modules/liftup": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/liftup/-/liftup-3.0.1.tgz",
+ "integrity": "sha512-yRHaiQDizWSzoXk3APcA71eOI/UuhEkNN9DiW2Tt44mhYzX4joFoCZlxsSOF7RyeLlfqzFLQI1ngFq3ggMPhOw==",
+ "dependencies": {
+ "extend": "^3.0.2",
+ "findup-sync": "^4.0.0",
+ "fined": "^1.2.0",
+ "flagged-respawn": "^1.0.1",
+ "is-plain-object": "^2.0.4",
+ "object.map": "^1.0.1",
+ "rechoir": "^0.7.0",
+ "resolve": "^1.19.0"
+ },
+ "engines": {
+ "node": ">=10"
+ }
},
- "minimatch": {
- "version": "0.2.14",
- "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-0.2.14.tgz",
- "integrity": "sha1-x054BXT2PG+aCQ6Q775u9TpqdWo=",
- "requires": {
- "lru-cache": "2.7.3",
- "sigmund": "1.0.1"
+ "node_modules/liftup/node_modules/findup-sync": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/findup-sync/-/findup-sync-4.0.0.tgz",
+ "integrity": "sha512-6jvvn/12IC4quLBL1KNokxC7wWTvYncaVUYSoxWw7YykPLuRrnv4qdHcSOywOI5RpkOVGeQRtWM8/q+G6W6qfQ==",
+ "dependencies": {
+ "detect-file": "^1.0.0",
+ "is-glob": "^4.0.0",
+ "micromatch": "^4.0.2",
+ "resolve-dir": "^1.0.1"
+ },
+ "engines": {
+ "node": ">= 8"
}
},
- "natives": {
+ "node_modules/lodash": {
+ "version": "4.17.21",
+ "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
+ },
+ "node_modules/make-iterator": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/make-iterator/-/make-iterator-1.0.1.tgz",
+ "integrity": "sha512-pxiuXh0iVEq7VM7KMIhs5gxsfxCux2URptUQaXo4iZZJxBAzTPOLE2BumO5dbfVYq/hBJFBR/a1mFDmOx5AGmw==",
+ "dependencies": {
+ "kind-of": "^6.0.2"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/map-cache": {
+ "version": "0.2.2",
+ "resolved": "https://registry.npmjs.org/map-cache/-/map-cache-0.2.2.tgz",
+ "integrity": "sha1-wyq9C9ZSXZsFFkW7TyasXcmKDb8=",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/marked": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz",
+ "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==",
+ "bin": {
+ "marked": "bin/marked.js"
+ },
+ "engines": {
+ "node": ">= 12"
+ }
+ },
+ "node_modules/micromatch": {
+ "version": "4.0.8",
+ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz",
+ "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==",
+ "dependencies": {
+ "braces": "^3.0.3",
+ "picomatch": "^2.3.1"
+ },
+ "engines": {
+ "node": ">=8.6"
+ }
+ },
+ "node_modules/minimatch": {
+ "version": "3.0.8",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.8.tgz",
+ "integrity": "sha512-6FsRAQsxQ61mw+qP1ZzbL9Bc78x2p5OqNgNpnoAFLTrX8n5Kxph0CsnhmKKNXTWjXqU5L0pGPR7hYk+XWZr60Q==",
+ "dependencies": {
+ "brace-expansion": "^1.1.7"
+ },
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/nopt": {
+ "version": "3.0.6",
+ "resolved": "https://registry.npmjs.org/nopt/-/nopt-3.0.6.tgz",
+ "integrity": "sha1-xkZdvwirzU2zWTF/eaxopkayj/k=",
+ "dependencies": {
+ "abbrev": "1"
+ },
+ "bin": {
+ "nopt": "bin/nopt.js"
+ }
+ },
+ "node_modules/nth-check": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz",
+ "integrity": "sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==",
+ "dependencies": {
+ "boolbase": "^1.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/nth-check?sponsor=1"
+ }
+ },
+ "node_modules/object.defaults": {
"version": "1.1.0",
- "resolved": "https://registry.npmjs.org/natives/-/natives-1.1.0.tgz",
- "integrity": "sha1-6f+EFBimsux6SV6TmYT3jxY+bjE="
+ "resolved": "https://registry.npmjs.org/object.defaults/-/object.defaults-1.1.0.tgz",
+ "integrity": "sha1-On+GgzS0B96gbaFtiNXNKeQ1/s8=",
+ "dependencies": {
+ "array-each": "^1.0.1",
+ "array-slice": "^1.0.0",
+ "for-own": "^1.0.0",
+ "isobject": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
},
- "nopt": {
- "version": "1.0.10",
- "resolved": "https://registry.npmjs.org/nopt/-/nopt-1.0.10.tgz",
- "integrity": "sha1-bd0hvSoxQXuScn3Vhfim83YI6+4=",
- "requires": {
- "abbrev": "1.1.0"
+ "node_modules/object.map": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/object.map/-/object.map-1.0.1.tgz",
+ "integrity": "sha1-z4Plncj8wK1fQlDh94s7gb2AHTc=",
+ "dependencies": {
+ "for-own": "^1.0.0",
+ "make-iterator": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/object.pick": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/object.pick/-/object.pick-1.3.0.tgz",
+ "integrity": "sha1-h6EKxMFpS9Lhy/U1kaZhQftd10c=",
+ "dependencies": {
+ "isobject": "^3.0.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
}
},
- "once": {
+ "node_modules/once": {
"version": "1.4.0",
"resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
"integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=",
- "requires": {
- "wrappy": "1.0.2"
+ "dependencies": {
+ "wrappy": "1"
+ }
+ },
+ "node_modules/os-homedir": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/os-homedir/-/os-homedir-1.0.2.tgz",
+ "integrity": "sha1-/7xJiDNuDoM94MFox+8VISGqf7M=",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/os-tmpdir": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz",
+ "integrity": "sha1-u+Z0BseaqFxc/sdm/lc0VV36EnQ=",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/osenv": {
+ "version": "0.1.5",
+ "resolved": "https://registry.npmjs.org/osenv/-/osenv-0.1.5.tgz",
+ "integrity": "sha512-0CWcCECdMVc2Rw3U5w9ZjqX6ga6ubk1xDVKxtBQPK7wis/0F2r9T6k4ydGYhecl7YUBxBVxhL5oisPsNxAPe2g==",
+ "dependencies": {
+ "os-homedir": "^1.0.0",
+ "os-tmpdir": "^1.0.0"
+ }
+ },
+ "node_modules/parse-filepath": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/parse-filepath/-/parse-filepath-1.0.2.tgz",
+ "integrity": "sha1-pjISf1Oq89FYdvWHLz/6x2PWyJE=",
+ "dependencies": {
+ "is-absolute": "^1.0.0",
+ "map-cache": "^0.2.0",
+ "path-root": "^0.1.1"
+ },
+ "engines": {
+ "node": ">=0.8"
+ }
+ },
+ "node_modules/parse-passwd": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/parse-passwd/-/parse-passwd-1.0.0.tgz",
+ "integrity": "sha1-bVuTSkVpk7I9N/QKOC1vFmao5cY=",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/parse5": {
+ "version": "7.1.2",
+ "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.1.2.tgz",
+ "integrity": "sha512-Czj1WaSVpaoj0wbhMzLmWD69anp2WH7FXMB9n1Sy8/ZFF9jolSQVMu1Ij5WIyGmcBmhk7EOndpO4mIpihVqAXw==",
+ "dependencies": {
+ "entities": "^4.4.0"
+ },
+ "funding": {
+ "url": "https://github.com/inikulin/parse5?sponsor=1"
}
},
- "path-is-absolute": {
+ "node_modules/parse5-htmlparser2-tree-adapter": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.0.0.tgz",
+ "integrity": "sha512-B77tOZrqqfUfnVcOrUvfdLbz4pu4RopLD/4vmu3HUPswwTA8OH0EMW9BlWR2B0RCoiZRAHEUu7IxeP1Pd1UU+g==",
+ "dependencies": {
+ "domhandler": "^5.0.2",
+ "parse5": "^7.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/inikulin/parse5?sponsor=1"
+ }
+ },
+ "node_modules/path-is-absolute": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
- "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18="
- },
- "readable-stream": {
- "version": "1.1.14",
- "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.1.14.tgz",
- "integrity": "sha1-fPTFTvZI44EwhMY23SB54WbAgdk=",
- "requires": {
- "core-util-is": "1.0.2",
- "inherits": "2.0.3",
- "isarray": "0.0.1",
- "string_decoder": "0.10.31"
- }
- },
- "resolve": {
- "version": "1.1.7",
- "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.1.7.tgz",
- "integrity": "sha1-IDEU2CrSxe2ejgQRs5ModeiJ6Xs="
- },
- "rimraf": {
- "version": "2.2.8",
- "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.2.8.tgz",
- "integrity": "sha1-5Dm+Kq7jJzIZUnMPmaiSnk/FBYI="
- },
- "sax": {
- "version": "0.6.1",
- "resolved": "https://registry.npmjs.org/sax/-/sax-0.6.1.tgz",
- "integrity": "sha1-VjsZx8HeiS4Jv8Ty/DDjwn8JUrk="
- },
- "sigmund": {
+ "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/path-parse": {
+ "version": "1.0.7",
+ "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz",
+ "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw=="
+ },
+ "node_modules/path-root": {
+ "version": "0.1.1",
+ "resolved": "https://registry.npmjs.org/path-root/-/path-root-0.1.1.tgz",
+ "integrity": "sha1-mkpoFMrBwM1zNgqV8yCDyOpHRbc=",
+ "dependencies": {
+ "path-root-regex": "^0.1.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/path-root-regex": {
+ "version": "0.1.2",
+ "resolved": "https://registry.npmjs.org/path-root-regex/-/path-root-regex-0.1.2.tgz",
+ "integrity": "sha1-v8zcjfWxLcUsi0PsONGNcsBLqW0=",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/picomatch": {
+ "version": "2.3.1",
+ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz",
+ "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==",
+ "engines": {
+ "node": ">=8.6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/jonschlinkert"
+ }
+ },
+ "node_modules/rechoir": {
+ "version": "0.7.0",
+ "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.7.0.tgz",
+ "integrity": "sha512-ADsDEH2bvbjltXEP+hTIAmeFekTFK0V2BTxMkok6qILyAJEXV0AFfoWcAq4yfll5VdIMd/RVXq0lR+wQi5ZU3Q==",
+ "dependencies": {
+ "resolve": "^1.9.0"
+ },
+ "engines": {
+ "node": ">= 0.10"
+ }
+ },
+ "node_modules/resolve": {
+ "version": "1.20.0",
+ "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz",
+ "integrity": "sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==",
+ "dependencies": {
+ "is-core-module": "^2.2.0",
+ "path-parse": "^1.0.6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/resolve-dir": {
"version": "1.0.1",
- "resolved": "https://registry.npmjs.org/sigmund/-/sigmund-1.0.1.tgz",
- "integrity": "sha1-P/IfGYytIXX587eBhT/ZTQ0ZtZA="
+ "resolved": "https://registry.npmjs.org/resolve-dir/-/resolve-dir-1.0.1.tgz",
+ "integrity": "sha1-eaQGRMNivoLybv/nOcm7U4IEb0M=",
+ "dependencies": {
+ "expand-tilde": "^2.0.0",
+ "global-modules": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
},
- "spawnback": {
- "version": "1.0.0",
- "resolved": "https://registry.npmjs.org/spawnback/-/spawnback-1.0.0.tgz",
- "integrity": "sha1-9zZi9+VNlTZ+ynTWQmxnfdfqaG8="
- },
- "string_decoder": {
- "version": "0.10.31",
- "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz",
- "integrity": "sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ="
- },
- "underscore": {
- "version": "1.7.0",
- "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.7.0.tgz",
- "integrity": "sha1-a7rwh3UA02vjTsqlhODbn+8DUgk="
- },
- "underscore.string": {
- "version": "2.2.1",
- "resolved": "https://registry.npmjs.org/underscore.string/-/underscore.string-2.2.1.tgz",
- "integrity": "sha1-18D6KvXVoaZ/QlPa7pgTLnM/Dxk="
- },
- "which": {
- "version": "1.0.9",
- "resolved": "https://registry.npmjs.org/which/-/which-1.0.9.tgz",
- "integrity": "sha1-RgwdoPgQED0DIam2M6+eV15kSG8="
- },
- "wordpress": {
+ "node_modules/safer-buffer": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz",
+ "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg=="
+ },
+ "node_modules/sax": {
+ "version": "1.2.4",
+ "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz",
+ "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw=="
+ },
+ "node_modules/sprintf-js": {
"version": "1.1.2",
- "resolved": "https://registry.npmjs.org/wordpress/-/wordpress-1.1.2.tgz",
- "integrity": "sha1-uDZhhSBVSXESG8VsQ7A5yzgg94M=",
- "requires": {
- "xmlrpc": "1.3.1"
+ "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.1.2.tgz",
+ "integrity": "sha512-VE0SOVEHCk7Qc8ulkWw3ntAzXuqf7S2lvwQaDLRnUeIEaKNQJzV6BwmLKhOqT61aGhfUMrXeaBk+oDGCzvhcug=="
+ },
+ "node_modules/supports-color": {
+ "version": "7.2.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
+ "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
}
},
- "wrappy": {
- "version": "1.0.2",
- "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
- "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8="
+ "node_modules/to-regex-range": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+ "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
+ "dependencies": {
+ "is-number": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=8.0"
+ }
+ },
+ "node_modules/unc-path-regex": {
+ "version": "0.1.2",
+ "resolved": "https://registry.npmjs.org/unc-path-regex/-/unc-path-regex-0.1.2.tgz",
+ "integrity": "sha1-5z3T17DXxe2G+6xrCufYxqadUPo=",
+ "engines": {
+ "node": ">=0.10.0"
+ }
},
- "xmlbuilder": {
- "version": "2.6.5",
- "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-2.6.5.tgz",
- "integrity": "sha1-b/etYPty0idk8AehZLd/K/FABSY=",
- "requires": {
- "lodash": "3.10.1"
+ "node_modules/underscore.string": {
+ "version": "3.3.6",
+ "resolved": "https://registry.npmjs.org/underscore.string/-/underscore.string-3.3.6.tgz",
+ "integrity": "sha512-VoC83HWXmCrF6rgkyxS9GHv8W9Q5nhMKho+OadDJGzL2oDYbYEppBaCMH6pFlwLeqj2QS+hhkw2kpXkSdD1JxQ==",
+ "dependencies": {
+ "sprintf-js": "^1.1.1",
+ "util-deprecate": "^1.0.2"
},
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/util-deprecate": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
+ "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8="
+ },
+ "node_modules/v8flags": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/v8flags/-/v8flags-3.2.0.tgz",
+ "integrity": "sha512-mH8etigqMfiGWdeXpaaqGfs6BndypxusHHcv2qSHyZkGEznCd/qAXCWWRzeowtL54147cktFOC4P5y+kl8d8Jg==",
"dependencies": {
- "lodash": {
- "version": "3.10.1",
- "resolved": "https://registry.npmjs.org/lodash/-/lodash-3.10.1.tgz",
- "integrity": "sha1-W/Rejkm6QYnhfUgnid/RW9FAt7Y="
- }
+ "homedir-polyfill": "^1.0.1"
+ },
+ "engines": {
+ "node": ">= 0.10"
}
},
- "xmlrpc": {
+ "node_modules/which": {
"version": "1.3.1",
- "resolved": "https://registry.npmjs.org/xmlrpc/-/xmlrpc-1.3.1.tgz",
- "integrity": "sha1-OqWCCG/vUwz+Hc2qDEyd3F0ORFE=",
- "requires": {
- "sax": "0.6.1",
- "xmlbuilder": "2.6.5"
+ "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz",
+ "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==",
+ "dependencies": {
+ "isexe": "^2.0.0"
+ },
+ "bin": {
+ "which": "bin/which"
+ }
+ },
+ "node_modules/wordpress": {
+ "version": "1.4.2",
+ "resolved": "https://registry.npmjs.org/wordpress/-/wordpress-1.4.2.tgz",
+ "integrity": "sha512-T+o+Af6pK7mhTz/rJEZk4PpSIyRMVhx6vZm6UsmrnlL8pVudhu1gWzn1n3wZXlcEZQz7I0AOkEvPQ5hu++L+qg==",
+ "dependencies": {
+ "xmlrpc": "1.3.2"
+ }
+ },
+ "node_modules/wrappy": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
+ "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8="
+ },
+ "node_modules/xmlbuilder": {
+ "version": "8.2.2",
+ "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-8.2.2.tgz",
+ "integrity": "sha512-eKRAFz04jghooy8muekqzo8uCSVNeyRedbuJrp0fovbLIi7wlsYtdUn3vBAAPq2Y3/0xMz2WMEUQ8yhVVO9Stw==",
+ "engines": {
+ "node": ">=4.0"
+ }
+ },
+ "node_modules/xmlrpc": {
+ "version": "1.3.2",
+ "resolved": "https://registry.npmjs.org/xmlrpc/-/xmlrpc-1.3.2.tgz",
+ "integrity": "sha512-jQf5gbrP6wvzN71fgkcPPkF4bF/Wyovd7Xdff8d6/ihxYmgETQYSuTc+Hl+tsh/jmgPLro/Aro48LMFlIyEKKQ==",
+ "dependencies": {
+ "sax": "1.2.x",
+ "xmlbuilder": "8.2.x"
+ },
+ "engines": {
+ "node": ">=0.8",
+ "npm": ">=1.0.0"
}
}
}
diff --git a/package.json b/package.json
index 34ef2b831..c86c045c7 100644
--- a/package.json
+++ b/package.json
@@ -1,31 +1,12 @@
{
"name": "api.jquery.com",
- "title": "jQuery API Docs",
- "description": "API reference documentation for the jQuery JavaScript Library.",
- "version": "1.12.36",
- "homepage": "https://github.com/jquery/api.jquery.com",
- "author": {
- "name": "jQuery Foundation and other contributors"
- },
- "repository": {
- "type": "git",
- "url": "git://github.com/jquery/api.jquery.com.git"
- },
- "bugs": {
- "url": "https://github.com/jquery/api.jquery.com/issues"
- },
- "licenses": [
- {
- "type": "MIT",
- "url": "https://github.com/jquery/api.jquery.com/blob/master/LICENSE.txt"
- }
- ],
+ "version": "3.3.10",
+ "private": true,
"scripts": {
"test": "grunt lint"
},
"dependencies": {
- "grunt": "0.4.5",
- "grunt-cli": "1.1.0",
- "grunt-jquery-content": "3.0.1"
+ "grunt": "1.6.1",
+ "grunt-jquery-content": "3.3.2"
}
}
diff --git a/pages/Ajax_Events.html b/pages/Ajax_Events.html
index 26a59f0fd..6b1249be3 100644
--- a/pages/Ajax_Events.html
+++ b/pages/Ajax_Events.html
@@ -19,9 +19,9 @@ <h3>Local Events</h3>
</code></pre>
<h3>Global Events</h3>
<p>These events are triggered on the <code>document</code>, calling any handlers which may be listening. You can listen for these events like so:</p>
-<pre> $(document).bind("ajaxSend", function(){
+<pre> $(document).on("ajaxSend", function(){
$("#loading").show();
- }).bind("ajaxComplete", function(){
+ }).on("ajaxComplete", function(){
$("#loading").hide();
});
</pre>
diff --git a/pages/Types.html b/pages/Types.html
index de56ce020..16a3a7c1b 100644
--- a/pages/Types.html
+++ b/pages/Types.html
@@ -1,6 +1,6 @@
<script>
{
- "title": "Types"
+ "title": "Types"
}
</script>
<style>
@@ -101,11 +101,11 @@
<li class="toclevel-1"><a href="#Assert"><span class="toctext">Qunit's Assert Object</span></a></li>
</ol>
-<h2 id="Anything"> Anything </h2>
+<h2 id="Anything">Anything</h2>
<p>The <strong>Anything</strong> virtual type is used in jQuery documentation to indicate that any type can be used or should be expected.
</p>
-<h2 id="String"> String </h2>
+<h2 id="String">String</h2>
<p>A string in JavaScript is an immutable primitive value that contains none, one or many characters.
</p>
<pre><code data-lang="javascript">"I'm a String in JavaScript!"
@@ -115,14 +115,14 @@ <h2 id="String"> String </h2>
</p>
<pre><code data-lang="javascript">typeof "some string"; // "string"
</code></pre>
-<h3 id="Quoting"> Quoting </h3>
+<h3 id="Quoting">Quoting</h3>
<p>A string can be defined using single or double quotes. You can nest single quotes inside of double quotes, and the other way around. To mix double quotes with double quotes (or single with single), the nested ones have to be escaped with a backslash.
</p>
<pre><code data-lang="javascript">"You make 'me' sad."
'That\'s "cranking" good fun!'
"<a href=\"home\">Home</a>"
</code></pre>
-<h3 id="Built-in_Methods"> Built-in Methods </h3>
+<h3 id="Built-in_Methods">Built-in Methods</h3>
<p>A string in JavaScript has some built-in methods to manipulate the string, though the result is always a new string - or something else, eg. split returns an <a href="/Types/#Array" title="Types">array</a>.
</p>
<pre><code data-lang="javascript">"hello".charAt( 0 ) // "h"
@@ -131,13 +131,13 @@ <h3 id="Built-in_Methods"> Built-in Methods </h3>
"hello".replace( /e|o/g, "x" ) // "hxllx"
"1,2,3".split( "," ) // [ "1", "2", "3" ]
</code></pre>
-<h3 id="Length_Property"> Length Property </h3>
+<h3 id="Length_Property">Length Property</h3>
<p>All strings have a length property.
</p>
<pre><code data-lang="javascript">"Hello".length // 5
"".length // 0
</code></pre>
-<h3 id="Boolean_Default"> Boolean Default </h3>
+<h3 id="Boolean_Default">Boolean Default</h3>
<p>An empty string defaults to false:
</p>
<pre><code data-lang="javascript">!"" // true
@@ -147,9 +147,9 @@ <h3 id="Boolean_Default"> Boolean Default </h3>
!new Boolean( false ) // false
</code></pre>
-<h2 id="htmlString"> htmlString </h2>
+<h2 id="htmlString">htmlString</h2>
<p>A string is designated <strong>htmlString</strong> in jQuery documentation when it is used to represent one or more DOM elements, typically to be created and inserted in the document. When passed as an argument of the <code>jQuery()</code> function, the string is identified as HTML if it starts with <code><tag ... ></code>) and is parsed as such until the final <code>></code> character. Prior to jQuery 1.9, a string was considered to be HTML if it contained <code><tag ... ></code> <em>anywhere within the string</em>.</p>
-<p>When a string as passed as an argument to a manipulation method such as <code>.append()</code>, it is always considered to be HTML since jQuery's other common interpretation of a string (CSS selectors) does not apply in those contexts.</p>
+<p>When a string is passed as an argument to a manipulation method such as <code>.append()</code>, it is always considered to be HTML since jQuery's other common interpretation of a string (CSS selectors) does not apply in those contexts.</p>
<p>For explicit parsing of a string to HTML, the <code><a href="/https/github.com/jQuery.parseHTML/">$.parseHTML()</a></code> method is available as of jQuery 1.8.</p>
<pre><code data-lang="javascript">// Appends <b>hello</b>:
$( "<b>hello</b>" ).appendTo( "body" );
@@ -166,7 +166,7 @@ <h2 id="htmlString"> htmlString </h2>
// Appends <b>hello</b>wait<b>bye</b>:
$( "<b>hello</b>wait<b>bye</b>" ).appendTo( "body" );
</code></pre>
-<h2 id="Number"> Number </h2>
+<h2 id="Number">Number</h2>
<p>Numbers in JavaScript are double-precision 64-bit format IEEE 754 values. They are immutable primitive values, just like <a href="#String" title="">strings</a>. All operators common in c-based languages are available to work with numbers (+, -, *, /, %, =, +=, -=, *=, /=, ++, --).
</p>
<pre><code data-lang="javascript">12
@@ -177,7 +177,7 @@ <h2 id="Number"> Number </h2>
<pre><code data-lang="javascript">typeof 12 // "number"
typeof 3.543 // "number"
</code></pre>
-<h3 id="Boolean_Default_2"> Boolean Default </h3>
+<h3 id="Boolean_Default_2">Boolean Default</h3>
<p>If a number is zero, it defaults to false:
</p>
<pre><code data-lang="javascript">!0 // true
@@ -189,15 +189,13 @@ <h3 id="Boolean_Default_2"> Boolean Default </h3>
</p>
<pre><code data-lang="javascript">0.1 + 0.2 // 0.30000000000000004
</code></pre>
-<p><br />
-</p>
-<h3 id="Math"> Math </h3>
+<h3 id="Math">Math</h3>
<p>JavaScript provides utilities to work with numbers in the Math object:
</p>
<pre><code data-lang="javascript">Math.PI // 3.141592653589793
Math.cos( Math.PI ) // -1
</code></pre>
-<h3 id="Parsing_Numbers"> Parsing Numbers </h3>
+<h3 id="Parsing_Numbers">Parsing Numbers</h3>
<p>parseInt and parseFloat help parsing strings into numbers. Both do some implicit conversion if the base isn't specified:
</p>
<pre><code data-lang="javascript">parseInt( "123" ) = 123 // (implicit decimal)
@@ -207,7 +205,7 @@ <h3 id="Parsing_Numbers"> Parsing Numbers </h3>
parseInt( "11", 2 ) = 3 // (explicit binary)
parseFloat( "10.10" ) = 10.1
</code></pre>
-<h3 id="Numbers_to_Strings"> Numbers to Strings </h3>
+<h3 id="Numbers_to_Strings">Numbers to Strings</h3>
<p>When appending numbers to string, the result is always a string. The operator is the same, so be careful: If you want to add numbers and then append them to a string, put parentheses around the numbers:
</p>
<pre><code data-lang="javascript">"" + 1 + 2; // "12"
@@ -220,7 +218,7 @@ <h3 id="Numbers_to_Strings"> Numbers to Strings </h3>
<pre><code data-lang="javascript">String( 1 ) + String( 2 ); // "12"
String( 1 + 2 ); // "3"
</code></pre>
-<h3 id="NaN_and_Infinity"> NaN and Infinity </h3>
+<h3 id="NaN_and_Infinity">NaN and Infinity</h3>
<p>Parsing something that isn't a number results in NaN. isNaN helps to detect those cases:
</p>
<pre><code data-lang="javascript">parseInt( "hello", 10 ) // NaN
@@ -243,21 +241,19 @@ <h3 id="NaN_and_Infinity"> NaN and Infinity </h3>
</p>
<pre><code data-lang="javascript">Infinity === Infinity // true
</code></pre>
-<h3 id="Integer"> Integer </h3>
+<h3 id="Integer">Integer</h3>
<p>An integer is a plain Number type, but whenever explicitly mentioned, indicates that a non-floating-point number is expected.
</p>
-<h3 id="Float"> Float </h3>
+<h3 id="Float">Float</h3>
<p>A float is a plain Number type, just as Integer, but whenever explicitly mentioned, indicates that a floating-point number is expected.
</p>
-<p><br />
-</p>
-<h2 id="Boolean"> Boolean </h2>
+<h2 id="Boolean">Boolean</h2>
<p>A boolean in JavaScript can be either true or false:
</p>
<pre><code data-lang="javascript">if ( true ) console.log( "always!" );
if ( false ) console.log( "never!" );
</code></pre>
-<h2 id="Object"> Object </h2>
+<h2 id="Object">Object</h2>
<p>Everything in JavaScript is an object, though some are more objective (haha). The easiest way to create an object is the object literal:
</p>
<pre><code data-lang="javascript">var x = {};
@@ -270,7 +266,7 @@ <h2 id="Object"> Object </h2>
</p>
<pre><code data-lang="javascript">typeof {} // "object"
</code></pre>
-<h3 id="Dot_Notation"> Dot Notation </h3>
+<h3 id="Dot_Notation">Dot Notation</h3>
<p>You can write and read properties of an object using the dot notation:
</p>
<pre><code data-lang="javascript">y.name // "Pete"
@@ -278,7 +274,7 @@ <h3 id="Dot_Notation"> Dot Notation </h3>
x.name = y.name + " Pan" // "Pete Pan"
x.age = y.age + 1 // 16
</code></pre>
-<h3 id="Array_Notation"> Array Notation </h3>
+<h3 id="Array_Notation">Array Notation</h3>
<p>Or you write and read properties using the array notation, which allows you to dynamically choose the property:
</p>
<pre><code data-lang="javascript">var operations = {
@@ -289,7 +285,7 @@ <h3 id="Array_Notation"> Array Notation </h3>
operations[ operation ] // "++"
operations[ "multiply" ] = "*"; // "*"
</code></pre>
-<h3 id="Iteration"> Iteration </h3>
+<h3 id="Iteration">Iteration</h3>
<p>Iterating over objects is easy with the for-in-loop:
</p>
<pre><code data-lang="javascript">var obj = {
@@ -300,7 +296,7 @@ <h3 id="Iteration"> Iteration </h3>
alert( "key is " + [ key ] + ", value is " + obj[ key ] );
}
</code></pre>
-<p>Note that for-in-loop can be spoiled by extending Object.prototype (see <a href="http://erik.eae.net/archives/2005/06/06/22.13.54/" class="external text" title="http://erik.eae.net/archives/2005/06/06/22.13.54/">Object.prototype is verboten</a>) so take care when using other libraries.
+<p>Note that for-in-loop can be spoiled by extending <code>Object.prototype</code> (see <a href="https://web.archive.org/web/20200416084623/https://erik.eae.net/archives/2005/06/06/22.13.54/" class="external text" title="https://web.archive.org/web/20200416084623/https://erik.eae.net/archives/2005/06/06/22.13.54/">Object.prototype is verboten</a>) so take care when using other libraries.
</p>
<p>jQuery provides a generic <a href="/https/github.com/jQuery.each/"><em>each</em> function</a> to iterate over properties of objects, as well as elements of arrays:
</p>
@@ -311,13 +307,13 @@ <h3 id="Iteration"> Iteration </h3>
<p>The drawback is that the callback is called in the context of each value and you therefore lose the context of your own object if applicable. More on this below at Functions.
</p>
-<h3 id="Boolean_default_3"> Boolean default </h3>
+<h3 id="Boolean_default_3">Boolean default</h3>
<p>An object, no matter if it has properties or not, never defaults to false:
</p>
<pre><code data-lang="javascript">!{} // false
!!{} // true
</code></pre>
-<h3 id="Prototype"> Prototype </h3>
+<h3 id="Prototype">Prototype</h3>
<p>All objects have a prototype property. Whenever the interpreter looks for a property, it also checks in the object's prototype if the property is not found on the object itself. jQuery uses the prototype extensively to add methods to jQuery instances. Internally, jQuery makes <code>jQuery.fn</code> an alias of <code>jQuery.prototype</code> so you can use either one (though plugin developers have standardized on <code>fn</code>).
</p>
<pre><code data-lang="javascript">var form = $("#myform");
@@ -336,7 +332,7 @@ <h3 id="Prototype"> Prototype </h3>
form.clearForm();
</code></pre>
-<h2 id="Array"> Array </h2>
+<h2 id="Array">Array</h2>
<p>Arrays in JavaScript are mutable lists with a few built-in methods. You can define arrays using the array literal:
</p>
<pre><code data-lang="javascript">var x = [];
@@ -352,7 +348,7 @@ <h2 id="Array"> Array </h2>
<pre><code data-lang="javascript">x[ 0 ] = 1;
y[ 2 ] // 3
</code></pre>
-<h3 id="Iteration_2"> Iteration </h3>
+<h3 id="Iteration_2">Iteration</h3>
<p>An array has a length property that is useful for iteration:
</p>
<pre><code data-lang="javascript">for ( var i = 0; i < a.length; i++ ) {
@@ -402,13 +398,13 @@ <h3 id="Iteration_2"> Iteration </h3>
</code></pre>
<p>Note: .unshift() method does not return a length property in Internet Explorer.
</p>
-<h3 id="Boolean_Default_4"> Boolean Default </h3>
+<h3 id="Boolean_Default_4">Boolean Default</h3>
<p>An array, no matter if it has elements or not, never defaults to false:
</p>
<pre><code data-lang="javascript">![] // false
!![] // true
</code></pre>
-<h3 id="Array.3CType.3E_Notation"> Array<Type> Notation </h3>
+<h3 id="Array.3CType.3E_Notation">Array<Type> Notation</h3>
<p>In the jQuery API you'll often find the notation of Array<Type>:
</p>
<pre>dragPrevention Array<String>
@@ -418,7 +414,7 @@ <h3 id="Array.3CType.3E_Notation"> Array<Type> Notation </h3>
<h2 id="ArrayLikeObject">Array-Like Object</h2>
<p>Either a true JavaScript Array or a JavaScript Object that contains a nonnegative integer <code>length</code> property and index properties from <code>0</code> up to <code>length - 1</code>. This latter case includes array-like objects commonly encountered in web-based code such as the <code>arguments</code> object and the <code>NodeList</code> object returned by many DOM methods.</p>
<p>When a jQuery API accepts either plain Objects or Array-Like objects, a plain Object with a numeric <code>length</code> property will trigger the Array-Like behavior.</p>
-<h2 id="PlainObject"> PlainObject </h2>
+<h2 id="PlainObject">PlainObject</h2>
<p>The PlainObject type is a JavaScript object containing zero or more key-value pairs. The plain object is, in other words, an <code>Object</code> object. It is designated "plain" in jQuery documentation to distinguish it from other kinds of JavaScript objects: for example, <code>null</code>, user-defined arrays, and host objects such as <code>document</code>, all of which have a <code>typeof</code> value of "object." The <code><a href="/https/github.com/jQuery.isPlainObject/">jQuery.isPlainObject()</a></code> method identifies whether the passed argument is a plain object or not, as demonstrated below:
</p>
<pre><code data-lang="javascript">
@@ -438,7 +434,7 @@ <h2 id="PlainObject"> PlainObject </h2>
<h2 id="Null">Null</h2>
<p>The <code>null</code> keyword is a JavaScript literal that is commonly used to express the absence of an intentional value.</p>
-<h2 id="Date"> Date </h2>
+<h2 id="Date">Date</h2>
<p>The Date type is a JavaScript object that represents a single moment in time. Date objects are instantiated using their constructor function, which by default creates an object that represents the current date and time.
</p>
<pre><code data-lang="javascript">
@@ -450,7 +446,7 @@ <h2 id="Date"> Date </h2>
new Date( 2014, 0, 1, 8, 15 );
</code></pre>
-<h2 id="Function"> Function </h2>
+<h2 id="Function">Function</h2>
<p>A function in JavaScript can be either named or anonymous. Any function can be assigned to a variable or passed to a method, but passing member functions this way can cause them to be called in the context of another object (i.e. with a different "this" object).
</p>
<pre><code data-lang="javascript">function named() {}
@@ -459,7 +455,7 @@ <h2 id="Function"> Function </h2>
<p>You see a lot of anonymous functions in jQuery code:
</p>
<pre><code data-lang="javascript">$( document ).ready(function() {});
-$( "a" ).click(function() {});
+$( "a)" ).on( "click", function() {});
$.ajax({
url: "someurl.php",
success: function() {}
@@ -467,7 +463,7 @@ <h2 id="Function"> Function </h2>
</code></pre>
<p>The type of a function is "function".
</p>
-<h3 id="Arguments"> Arguments </h3>
+<h3 id="Arguments">Arguments</h3>
<p>Inside a function a special variable "arguments" is always available. It's similar to an array in that it has a length property, but it lacks the built-in methods of an array. The elements of the pseudo-array are the argument of the function call.
</p>
<pre><code data-lang="javascript">function log( x ) {
@@ -482,7 +478,7 @@ <h3 id="Arguments"> Arguments </h3>
<pre><code data-lang="javascript">var awesome = function() { return arguments.callee; }
awesome() === awesome // true
</code></pre>
-<h3 id="Context.2C_Call_and_Apply"> Context, Call and Apply </h3>
+<h3 id="Context.2C_Call_and_Apply">Context, Call and Apply</h3>
<p>In JavaScript, the variable "this" always refers to the current context. By default, "this" refers to the window object. Within a function this context can change, depending on how the function is called.
</p>
<p>All event handlers in jQuery are called with the handling element as the context.
@@ -490,7 +486,7 @@ <h3 id="Context.2C_Call_and_Apply"> Context, Call and Apply </h3>
<pre><code data-lang="javascript">$( document ).ready(function() {
// this refers to window.document
});
-$( "a" ).click(function() {
+$( "a)" ).on( "click", function() {
// this refers to an anchor DOM element
});
</code></pre>
@@ -503,7 +499,7 @@ <h3 id="Context.2C_Call_and_Apply"> Context, Call and Apply </h3>
scope.call( "foobar", [ 1, 2 ] ); // "foobar", 1
scope.apply( "foobar", [ 1, 2 ] ); // "foobar", 2
</code></pre>
-<h3 id="Scope"> Scope </h3>
+<h3 id="Scope">Scope</h3>
<p>In JavaScript, all variables defined inside a function are only visible inside that function scope. Consider the following example:
</p>
<pre><code data-lang="javascript">// global
@@ -517,7 +513,7 @@ <h3 id="Scope"> Scope </h3>
</code></pre>
<p>It defines a variable <i>x</i> in the global scope, then defines an anonymous function and executes it immediately (the additional parentheses are required for immediate execution). Inside the function another variable <i>x</i> is defined with a different value. It is only visible within that function and doesn't overwrite the global variable.
</p>
-<h3 id="Closures"> Closures </h3>
+<h3 id="Closures">Closures</h3>
<p>Closures are created whenever a variable that is defined outside the current scope is accessed from within some inner scope. In the following example, the variable <i>counter</i> is visible within the create, increment, and print functions, but not outside of them.
</p>
<pre><code data-lang="javascript">function create() {
@@ -537,7 +533,7 @@ <h3 id="Closures"> Closures </h3>
</code></pre>
<p>The pattern allows you to create objects with methods that operate on data that isn't visible to the outside—the very basis of object-oriented programming.
</p>
-<h3 id="Proxy_Pattern"> Proxy Pattern </h3>
+<h3 id="Proxy_Pattern">Proxy Pattern</h3>
<p>Combining the above knowledge gives you as a JavaScript developer quite a lot of power. One way to combine that is to implement a proxy pattern in JavaScript, enabling the basics of aspect-oriented programming (AOP):
</p>
<pre><code data-lang="javascript">(function() {
@@ -551,10 +547,10 @@ <h3 id="Proxy_Pattern"> Proxy Pattern </h3>
</code></pre>
<p>The above wraps its code in a function to hide the "proxied"-variable. It saves jQuery's setArray-method in a closure and overwrites it. The proxy then logs all calls to the method and delegates the call to the original. Using apply(this, arguments) guarantees that the caller won't be able to notice the difference between the original and the proxied method.
</p>
-<h2 id="Callback"> Callback </h2>
+<h2 id="Callback">Callback</h2>
<p>A callback is a plain JavaScript function passed to some method as an argument or option. Some callbacks are just events, called to give the user a chance to react when a certain state is triggered. jQuery's event system uses such callbacks everywhere:
</p>
-<pre><code data-lang="javascript">$( "body" ).click(function( event ) {
+<pre><code data-lang="javascript">$( "body" ).on( "click", function( event ) {
console.log( "clicked: " + event.target );
});
</code></pre>
@@ -562,13 +558,13 @@ <h2 id="Callback"> Callback </h2>
</p>
<p>Some callbacks are required to return something, others make that return value optional. To prevent a form submission, a submit event handler can return false:
</p>
-<pre><code data-lang="javascript">$( "#myform" ).submit(function() {
+<pre><code data-lang="javascript">$( "#myform" ).on( "submit", function() {
return false;
-});
+} );
</code></pre>
<p>Instead of always returning false, the callback could check fields of the form for validity, and return false only when the form is invalid.
</p>
-<h2 id="Error"> Error </h2>
+<h2 id="Error">Error</h2>
<p>An instance of an Error object is thrown as an exception when a runtime error occurs. Error can also be used as base to define user custom exception classes. In JavaScript an error can be thrown as shown below:
</p>
<pre><code data-lang="javascript">throw new Error( "The argument provided is incorrect" );
@@ -578,7 +574,7 @@ <h2 id="Error"> Error </h2>
<pre><code data-lang="javascript">var obj = null;
console.log( obj.foo() );
</code></pre>
-<h2 id="Selector"> Selector </h2>
+<h2 id="Selector">Selector</h2>
<p>A selector is used in jQuery to select DOM elements from a DOM document. That document is, in most cases, the DOM document present in all browsers, but can also be an XML document received via Ajax.
</p>
<p>The selectors are a composition of CSS and custom additions. All selectors available in jQuery are documented on the <a href="/https/github.com/category/selectors/" title="Selectors">Selectors API page</a>.
@@ -600,7 +596,7 @@ <h2 id="Event">Event</h2>
</p>
<p>The standard events in the Document Object Model are: <code>blur</code>, <code>focus</code>, <code>load</code>, <code>resize</code>, <code>scroll</code>, <code>unload</code>, <code>beforeunload</code>, <code>click</code>, <code>dblclick</code>, <code>mousedown</code>, <code>mouseup</code>, <code>mousemove</code>, <code>mouseover</code>, <code>mouseout</code>, <code>mouseenter</code>, <code>mouseleave</code>, <code>change</code>, <code>select</code>, <code>submit</code>, <code>keydown</code>, <code>keypress,</code> and <code>keyup</code>. Since the DOM event names have predefined meanings for some elements, using them for other purposes is not recommended. jQuery's event model can trigger an event by any name on an element, and it is propagated up the DOM tree to which that element belongs, if any.
</p>
-<h2 id="Element"> Element </h2>
+<h2 id="Element">Element</h2>
<p>An element in the Document Object Model (DOM) can have attributes, text, and children. It provides methods to traverse the parent and children and to get access to its attributes. Due to inconsistencies in DOM API specifications and implementations, however, those methods can be a challenge to use. jQuery provides a "wrapper" around those elements to help interacting with the DOM. But sometimes you will be working directly with DOM elements, or see methods that (also) accept DOM elements as arguments.
</p>
<p>Whenever you call jQuery's <code>.each()</code> method or one of its event methods on a jQuery collection, the context of the callback function — <code>this</code> — is set to a DOM element.
@@ -615,7 +611,7 @@ <h2 id="Element"> Element </h2>
</code></pre>
<p>You could replace <code>this.value</code> with <code>$(this).val()</code> to access the value of the text input via jQuery, but in that case you wouldn't gain anything.
</p>
-<h2 id="Text"> Text </h2>
+<h2 id="Text">Text</h2>
<p>Text is a node of the Document Object Model (DOM) that represents the textual content of an <a href="#Element">element</a> or an attribute. Consider the following code:
</p>
<pre><code><p id="target"><b>Hello</b> world</p></code></pre>
@@ -625,7 +621,7 @@ <h2 id="Text"> Text </h2>
</code></pre>
<p>you obtain two children. The first one is the <a href="#Element">element</a> representing the <code>b</code> tag. The second child is a text node containing the string " world".
</p>
-<h2 id="jQuery"> jQuery </h2>
+<h2 id="jQuery">jQuery</h2>
<p>A jQuery object contains a collection of Document Object Model (DOM) elements that have been created from an HTML string or selected from a document. Since jQuery methods often use CSS selectors to match elements from a document, the set of elements in a jQuery object is often called a set of "matched elements" or "selected elements".
</p>
<p>The jQuery object itself behaves much like an array; it has a <code>length</code> property and the elements in the object can be accessed by their numeric indices <code>[0]</code> to <code>[length-1]</code>. Note that a jQuery object is not actually a Javascript Array object, so it does not have all the methods of a true Array object such as <code>join()</code>.
@@ -642,15 +638,15 @@ <h2 id="jQuery"> jQuery </h2>
</p>
<pre><code data-lang="javascript">$( ".badEntry" ).css({ color: "red" });
</code></pre>
-<h2 id="XMLHttpRequest"> XMLHttpRequest </h2>
+<h2 id="XMLHttpRequest">XMLHttpRequest</h2>
<p>Some of jQuery's Ajax functions return the native XMLHttpRequest (XHR) object, or pass it as an argument to success/error/complete handlers, so that you can do additional processing or monitoring on the request. Note that Ajax functions only return or pass an XHR object when an XHR object is actually used in the request. For example, JSONP requests and cross-domain GET requests use a script element rather than an XHR object.
</p>
<p>Although the XHR object is a standard, there are variations in its behavior on different browsers. Refer to the WHATWG site and Mozilla Developer Network for more information:
</p>
<ul><li> <a href="https://xhr.spec.whatwg.org/" class="external text" title="https://xhr.spec.whatwg.org/">WHATWG living standard</a>
-</li><li> <a href="https://developer.mozilla.org/docs/DOM/XMLHttpRequest" class="external text" title="https://developer.mozilla.org/docs/DOM/XMLHttpRequest">Mozilla Developer Network</a>
+</li><li> <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest" class="external text" title="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest">Mozilla Developer Network</a>
</li></ul>
-<h2 id="jqXHR"> jqXHR </h2>
+<h2 id="jqXHR">jqXHR</h2>
<p>As of jQuery 1.5, the <a href="/https/github.com/jQuery.ajax/">$.ajax()</a> method returns the jqXHR object, which is a superset of the XMLHTTPRequest object. For more information, see the <a href="/https/github.com/jQuery.ajax/#jqXHR">jqXHR section of the $.ajax entry</a>
</p>
<h2 id="Thenable">Thenable</h2>
@@ -663,7 +659,9 @@ <h2 id="Promise"> Promise Object</h2>
</p>
<h2 id="Callbacks">Callbacks Object</h2>
<p>A multi-purpose object that provides a powerful way to manage callback lists. It supports adding, removing, firing, and disabling callbacks. The Callbacks object is created and returned by the <code>$.Callbacks</code> function and subsequently returned by most of that function's methods. </p>
+<h2 id="Document">Document</h2>
+<p>A document object created by the browser's DOM parser, usually from a string representing HTML or XML.</p>
<h2 id="XMLDocument">XML Document</h2>
<p>A document object created by the browser's XML DOM parser, usually from a string representing XML. XML documents have different semantics than HTML documents, but most of the traversing and manipulation methods provided by jQuery will work with them.</p>
<h2 id="Assert">Assert</h2>
-<p>A reference to or instance of the object holding all of QUnit's assertions. See the <a href="https://api.qunitjs.com/QUnit.assert/">API documentation for <code>QUnit.assert</code></a> for details.</p>
+<p>A reference to or instance of the object holding all of QUnit's assertions. See the <a href="https://api.qunitjs.com/config/QUnit.assert">API documentation for <code>QUnit.assert</code></a> for details.</p>
diff --git a/redirects.json b/redirects.json
index 2aa9b0565..ba33f9ddd 100644
--- a/redirects.json
+++ b/redirects.json
@@ -1,3 +1,4 @@
{
- "/api/": "/resources/api.xml"
+ "/api/": "/resources/api.xml",
+ "/extending-ajax/": "/jQuery.ajax/#extending-ajax"
}
diff --git a/resources/events.js b/resources/events.js
index e00efb363..9b01b7e6c 100644
--- a/resources/events.js
+++ b/resources/events.js
@@ -1,31 +1,31 @@
jQuery.print = function(message, insertionType) {
- if (typeof(message) == 'object') {
- var string = '{<br />',
- values = [],
- counter = 0;
- $.each(message, function(key, value) {
- if (value && value.nodeName) {
- var domnode = '<' + value.nodeName.toLowerCase();
- domnode += value.className ? ' class="' + value.className + '"' : '';
- domnode += value.id ? ' id="' + value.id + '"' : '';
- domnode += '>';
- value = domnode;
- }
- values[counter++] = key + ': ' + value;
- });
- string += values.join(',<br />');
- string += '<br />}';
- message = string;
- }
+ if (typeof(message) == 'object') {
+ var string = '{<br />',
+ values = [],
+ counter = 0;
+ $.each(message, function(key, value) {
+ if (value && value.nodeName) {
+ var domnode = '<' + value.nodeName.toLowerCase();
+ domnode += value.className ? ' class="' + value.className + '"' : '';
+ domnode += value.id ? ' id="' + value.id + '"' : '';
+ domnode += '>';
+ value = domnode;
+ }
+ values[counter++] = key + ': ' + value;
+ });
+ string += values.join(',<br />');
+ string += '<br />}';
+ message = string;
+ }
- var $output = $('#print-output');
+ var $output = $('#print-output');
- if ($output.length === 0) {
- $output = $('<div id="print-output" />').appendTo('body');
- }
+ if ($output.length === 0) {
+ $output = $('<div id="print-output" />').appendTo('body');
+ }
- var $newMessage = $('<div class="print-output-line" />');
- $newMessage.html(message);
- insertionType = insertionType || 'append';
- $output[insertionType]($newMessage);
+ var $newMessage = $('<div class="print-output-line" />');
+ $newMessage.html(message);
+ insertionType = insertionType || 'append';
+ $output[insertionType]($newMessage);
};
diff --git a/resources/load.html b/resources/load.html
index 659f60445..81558c2a8 100644
--- a/resources/load.html
+++ b/resources/load.html
@@ -1,20 +1,20 @@
<!doctype html>
<html lang="en">
<head>
- <meta charset="utf-8">
- <title>Sample Page</title>
+ <meta charset="utf-8">
+ <title>Sample Page</title>
</head>
<body>
<h1>Popular jQuery Projects</h1>
<ul id="projects">
- <li>jQuery</li>
- <li>jQuery UI</li>
- <li>jQuery Mobile</li>
- <li>QUnit</li>
- <li>Sizzle</li>
+ <li>jQuery</li>
+ <li>jQuery UI</li>
+ <li>jQuery Mobile</li>
+ <li>QUnit</li>
+ <li>Sizzle</li>
</ul>
</body>
-</html>
\ No newline at end of file
+</html>