.each()

分類： 雜項 > 集合操作 | 遍歷

.each( function )傳回： jQuery

說明： 針對 jQuery 物件進行反覆運算，對每個相符的元素執行一個函式。

.each() 方法旨在使 DOM 迴圈結構簡潔且不易出錯。呼叫時，它會遍歷屬於 jQuery 物件的 DOM 元素。每次呼叫函式時，都會傳遞目前的迴圈反覆運算，從 0 開始。更重要的是，會在目前 DOM 元素的內容中觸發函式，因此關鍵字 this 指的是該元素。

假設頁面上有一個簡單的未排序清單

1
2
3
4
 
<ul>
  <li>foo</li>
  <li>bar</li>
</ul>

您可以選取清單項目並遍歷它們

1
2
3
 
$( "li" ).each(function( index ) {
  console.log( index + ": " + $( this ).text() );
});

因此，會為清單中的每個項目記錄一則訊息

0: foo
1: bar

您可以透過傳回 false 來從函式內停止迴圈。

注意：大多數傳回 jQuery 物件的 jQuery 方法也會迴圈遍歷 jQuery 集合中的元素集，這個程序稱為隱式反覆運算。發生這種情況時，通常不需要使用 .each() 方法來明確反覆運算

1
2
3
4
5
6
7
 
// The .each() method is unnecessary here:
$( "li" ).each(function() {
  $( this ).addClass( "foo" );
});
 
// Instead, you should rely on implicit iteration:
$( "li" ).addClass( "bar" );

範例

遍歷三個 div 並設定其 color 屬性。

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
 
<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>each demo</title>
  <style>
  div {
    color: red;
    text-align: center;
    cursor: pointer;
    font-weight: bolder;
    width: 300px;
  }
  </style>
  <script src="https://code.jquery.com/jquery-3.7.0.js"></script>
</head>
<body>
 
<div>Click here</div>
<div>to iterate through</div>
<div>these divs.</div>
 
<script>
$( document.body ).on( "click", function() {
  $( "div" ).each( function( i ) {
    if ( this.style.color !== "blue" ) {
      this.style.color = "blue";
    } else {
      this.style.color = "";
    }
  } );
} );
</script>
 
</body>
</html>

示範

若要存取 jQuery 物件而不是一般 DOM 元素，請使用 $( this )。例如

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 lang="en">
<head>
  <meta charset="utf-8">
  <title>each demo</title>
  <style>
  ul {
    font-size: 18px;
    margin: 0;
  }
  span {
    color: blue;
    text-decoration: underline;
    cursor: pointer;
  }
  .example {
    font-style: italic;
  }
  </style>
  <script src="https://code.jquery.com/jquery-3.7.0.js"></script>
</head>
<body>
 
To do list: <span>(click here to change)</span>
<ul>
  <li>Eat</li>
  <li>Sleep</li>
  <li>Be merry</li>
</ul>
 
<script>
$( "span" ).on( "click", function() {
  $( "li" ).each(function() {
    $( this ).toggleClass( "example" );
  });
});
</script>
 
</body>
</html>

示範

使用 return false 可以提早中斷 each() 迴圈。

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
41
42
43
44
45
46
47
48
 
<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>each demo</title>
  <style>
  div {
    width: 40px;
    height: 40px;
    margin: 5px;
    float: left;
    border: 2px blue solid;
    text-align: center;
  }
  span {
    color: red;
  }
  </style>
  <script src="https://code.jquery.com/jquery-3.7.0.js"></script>
</head>
<body>
 
<button>Change colors</button>
<span></span>
<div></div>
<div></div>
<div></div>
<div></div>
<div id="stop">Stop here</div>
<div></div>
<div></div>
<div></div>
 
<script>
$( "button" ).on( "click", function() {
  $( "div" ).each(function( index, element ) {
    // element == this
    $( element ).css( "backgroundColor", "yellow" );
    if ( $( this ).is( "#stop" ) ) {
      $( "span" ).text( "Stopped at div index #" + index );
      return false;
    }
  });
});
</script>
 
</body>
</html>

示範