.siblings()

jQuery

previous page next page

.siblings()

Categories: Traversing > Tree Traversal

.siblings( [selector ] ) Returns: jQuery

Description: Get the siblings of each element in the set of matched elements, optionally filtered by a selector.

  • version added: 1.0.siblings( [selector ] )

    • selector
      Type: Selector
      A string containing a selector expression to match elements against.

Given a jQuery object that represents a set of DOM elements, the .siblings() method allows us to search through the siblings of these elements in the DOM tree and construct a new jQuery object from the matching elements.

The method optionally accepts a selector expression of the same type that we can pass to the $() function. If the selector is supplied, the elements will be filtered by testing whether they match it.

Consider a page with a simple list on it:

1
2
3
4
5
6
7
 
                                

                                  

                                    
                                      <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>

If we begin at the third item, we can find its siblings:

1
 
                                

                                  

                                    $('li.third-item').siblings().css('background-color', 'red');

The result of this call is a red background behind items 1, 2, 4, and 5. Since we do not supply a selector expression, all of the siblings are part of the object. If we had supplied one, only the matching items among these four would be included.

The original element is not included among the siblings, which is important to remember when we wish to find all elements at a particular level of the DOM tree.

Examples:

Example: Find the unique siblings of all yellow li elements in the 3 lists (including other yellow li elements if appropriate).

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
                                  

                                    

                                      
                                        <!DOCTYPE html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <head>
                                      
                                    

                                  

                                  

                                    

                                        <style>
                                    

                                  

                                  

                                    

                                        ul { float:left; margin:5px; font-size:16px; font-weight:bold; }
                                    

                                  

                                  

                                    

                                        p { color:blue; margin:10px 20px; font-size:16px; padding:5px;
                                    

                                  

                                  

                                    

                                            font-weight:bolder; }
                                    

                                  

                                  

                                    

                                        .hilite { background:yellow; }
                                    

                                  

                                  

                                    

                                      
                                        </style>
                                      
                                    

                                  

                                  

                                    

                                        <script src="http://code.jquery.com/jquery-latest.js"></script>
                                    

                                  

                                  

                                    

                                      
                                        </head>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <body>
                                      
                                    

                                  

                                  

                                    

                                        <ul>
                                    

                                  

                                  

                                    

                                        <li>One</li>
                                    

                                  

                                  

                                    

                                        <li>Two</li>
                                    

                                  

                                  

                                    

                                        <li class="hilite">Three</li>
                                    

                                  

                                  

                                    

                                        <li>Four</li>
                                    

                                  

                                  

                                    

                                      
                                        </ul>
                                      
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        <ul>
                                      
                                    

                                  

                                  

                                    

                                        <li>Five</li>
                                    

                                  

                                  

                                    

                                        <li>Six</li>
                                    

                                  

                                  

                                    

                                        <li>Seven</li>
                                    

                                  

                                  

                                    

                                      
                                        </ul>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <ul>
                                      
                                    

                                  

                                  

                                    

                                        <li>Eight</li>
                                    

                                  

                                  

                                    

                                        <li class="hilite">Nine</li>
                                    

                                  

                                  

                                    

                                        <li>Ten</li>
                                    

                                  

                                  

                                    

                                        <li class="hilite">Eleven</li>
                                    

                                  

                                  

                                    

                                      
                                        </ul>
                                      
                                    

                                  

                                  

                                    

                                      <p>Unique siblings: <b></b></p>
                                    

                                  

                                  

                                    

                                      
                                        <script>
                                        
                                      
                                    

                                  

                                  

                                    

                                      var len = $(".hilite").siblings()
                                    

                                  

                                  

                                    

                                                            .css("color", "red")
                                    

                                  

                                  

                                    

                                                            .length;
                                    

                                  

                                  

                                    

                                      $("b").text(len);
                                    

                                  

                                  

                                    

                                      
                                        </script>
                                      
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        </body>
                                      
                                    

                                  

                                  

                                    

                                      
                                        </html>

Example: Find all siblings with a class "selected" of each div.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
 
                                  

                                    

                                      
                                        <!DOCTYPE html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <head>
                                      
                                    

                                  

                                  

                                    

                                        <script src="http://code.jquery.com/jquery-latest.js"></script>
                                    

                                  

                                  

                                    

                                      
                                        </head>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <body>
                                      
                                    

                                  

                                  

                                    

                                        <div><span>Hello</span></div>
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                        <p class="selected">Hello Again</p>
                                    

                                  

                                  

                                    

                                        <p>And Again</p>
                                    

                                  

                                  

                                    

                                      
                                        <script>
                                        $("p").siblings(".selected").css("background", "yellow");
                                        </script>
                                      
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        </body>
                                      
                                    

                                  

                                  

                                    

                                      
                                        </html>
 POWERED BYHERONOTE
previous page start next page