Skip to content

Fixing typo on Example code block #1270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 1, 2025
Merged

Fixing typo on Example code block #1270

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
891e94b
Fixing typo on Example code block
aldimar-junior Apr 1, 2025
0ae4e12
Fixing requested changes
aldimar-junior Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions entries/ajaxSuccess.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,37 +28,37 @@
</code></pre>
<p>Attach the event handler to any element:</p>
<pre><code>
$( document ).on( "ajaxSuccess", function() {
$( ".log" ).text( "Triggered ajaxSuccess handler." );
} );
$( 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" );
} );
$( ".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 ).on( "ajaxSuccess", function( event, xhr, settings ) {
if ( settings.url == "ajax/test.html" ) {
$( ".log" ).text( "Triggered ajaxSuccess handler. The Ajax response was: " +
xhr.responseText );
}
} );
$( 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"/>
<example>
<desc>Show a message when an Ajax request completes successfully.</desc>
<code><![CDATA[
$( document ).on( "ajaxSuccess< function( event, request, settings ) {
$( "#msg" ).append( "<li>Successful Request!</li>" );
} );
]]></code>
<pre><code>
$( document ).on( "ajaxSuccess", function( event, request, settings ) {
$( "#msg" ).append( "<li>Successful Request!</li>" );
} );
</code></pre>
</example>
<category slug="ajax/global-ajax-event-handlers"/>
<category slug="version/1.0"/>
Expand Down