.hide() | jQuery API Documentation

Description: Hide the matched elements.

A function to be called when the animation on an element completes or stops without completing (its Promise object is either resolved or rejected).

A function to be called when the animation on an element fails to complete (its Promise object is rejected).

A function to be called when the animation on an element completes (its Promise object is resolved).

A function that is called once the animation on an element is complete.

A function to be called after each step of the animation, only once per animated element regardless of the number of animated properties.

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.

An object containing one or more of the CSS properties defined by the properties argument and their corresponding easing functions.

A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. As of jQuery 1.7 , 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 .dequeue(“queuename”) to start it.

With no parameters, the .hide() method is the simplest way to hide an element:

1

$(

".target"

).hide();

The matched elements will be hidden immediately, with no animation. This is roughly equivalent to calling .css( "display", "none" ), except that the value of the display property is saved in jQuery’s data cache so that display can later be restored to its initial value. If an element has a display value of inline and is hidden then shown, it will once again be displayed inline.

When a duration, a plain object, or a “complete” function is provided, .hide() becomes an animation method. The .hide() method animates the width, height, and opacity of the matched elements simultaneously. When these properties reach 0, the display style property is set to none to ensure that the element no longer affects the layout of the page.

Durations are given in milliseconds; higher values indicate slower animations, not faster ones. The strings 'fast' and 'slow' can be supplied to indicate durations of 200 and 600 milliseconds, respectively.

Note that .hide() is fired immediately and will override the animation queue if no duration or a duration of 0 is specified.

As of jQuery 1.4.3, an optional string naming an easing function may be used. Easing functions specify the speed at which the animation progresses at different points within the animation. The only easing implementations in the jQuery library are the default, called swing, and one that progresses at a constant pace, called linear. More easing functions are available with the use of plug-ins, most notably the jQuery UI suite.

If supplied, the callback is fired once the animation is complete. This can be useful for stringing different animations together in sequence. The callback is not sent any arguments, but this is set to the DOM element being animated. If multiple elements are animated, it is important to note that the callback is executed once per matched element, not once for the animation as a whole.

Note: This method may cause performance issues, especially when used on many elements. If you’re encountering such issues, use performance testing tools to determine whether this method is causing them. Moreover, this method can cause problems with responsive layouts if the display value differs at different viewport sizes.

We can animate any element, such as a simple image:

1

2

3

4

<

div

id

=

"clickme"

>

Click here

</

div

>

<

img

id

=

"book"

src

=

"book.png"

alt

=

""

width

=

"100"

height

=

"123"

>

1

2

3

4

5

6

$(

"#clickme"

).click(

function

(

)

{

$(

"#book"

).hide(

"slow"

,

function

(

)

{

alert(

"Animation complete."

);

});

});





Figure 1 – Illustration of the hide() effect