【Amazon】人気の商品が日替わりで登場!
毎日お得なタイムセール!商品をみる

【jQuery】attr()とprop()の違いと使い分け

本記事では、jQueryのattrメソッドとpropメソッドの違いについて解説しています。

JavaScriptの学習におすすめ書籍
1冊ですべて身につくJavaScript入門講座
総合評価
( 5 )
メリット
  • 誰でも分かるように嚙み砕いて説明してくれる
  • アニメーションの知識が深く学べる
  • 1つのWebサイトを作りながら学べる
楽天ブックス
¥2,794 (2024/10/06 13:34時点 | 楽天市場調べ)
先輩くん

Amazon Kindle Unlimitedに登録すると、月額980円で読み放題だからオススメだよ!

後輩ちゃん

初回30日間は無料だから、まだ登録したことのない人はぜひ試してみてね!

全プログラマー必見!
変数名/関数名にもう悩まない!
リーダブルコード
総合評価
( 5 )
メリット
  • 美しいコードが書けるが自然と書けるようになる
  • 他の開発者が理解しやすいコードになる
著:Dustin Boswell, 著:Trevor Foucher, 解説:須藤 功平, 翻訳:角 征典
¥2,640 (2023/07/23 02:48時点 | Amazon調べ)
目次

attrメソッドとpropメソッドの違い

attrメソッドとpropメソッドの違いは、checkedやdisabledなどの状態を表す属性を取得する時に表れます。

<label><input type="checkbox" checked />チェック</label>
$(function () {
  let isAttrChecked = $('input[type="checkbox"]').attr("checked");
  let isPropChecked = $('input[type="checkbox"]').prop("checked");

  console.log(isAttrChecked); // => checked
  console.log(isPropChecked); // => true
});

上記のコードは、checked属性を取得しています。コンソールログを確認すると、attrメソッドでは「checked」の文字が返され、propメソッドでは「true」の真偽値が返されています。

続いて、checked属性を持たない時に取得しようとするとどのような結果になるのか確認してみましょう。

<label><input type="checkbox" />チェック</label>
$(function () {
  let isAttrChecked = $('input[type="checkbox"]').attr("checked");
  let isPropChecked = $('input[type="checkbox"]').prop("checked");

  console.log(isAttrChecked); // => undefined
  console.log(isPropChecked); // => false
});

コンソールログを確認すると、attrメソッドでは「undefined」が返され、propメソッドでは「false」の真偽値が返されています。

この結果から状態を表す属性の場合、attrメソッドは見つけた文字列を返し、propメソッドは状態を表す真偽値を返すことが分かります。

attrメソッドとpropメソッドの使い分け

attrメソッドとpropメソッドの使い分けは、状態を表さない属性(alt属性など)の場合はattrメソッドを使用し、状態を表す属性の場合はpropメソッドを使うことをおすすめします。

理由としては、先ほど解説した内容もそうですがattrメソッドで状態を表す属性を取得しようとすると思わぬエラーになる場合があります。例として、チェックボックスにチェックが入っているか確認するサンプルコードを用意しました。

<label><input type="checkbox" />チェック</label>
$(function () {
  $('input[type="checkbox"]').on("change", function () {
    let isAttrChecked = $(this).attr("checked");
    let isPropChecked = $(this).prop("checked");
    if (isAttrChecked) {
      console.log("attrメソッド");
    }
    if (isPropChecked) {
      console.log("propメソッド");
    }
  });
});

attrメソッドとpropメソッドの両方でchecked属性を取得して、その戻り値を基に条件分岐しています。attrメソッドにはcheckedの文字が、propメソッドにはtrueの真偽値が返され両方とも想定している挙動を取りそうですが実行してみると、コンソールログには「propメソッド」しか表示されません。

何故、このような結果になるのかその理由はチェックボックスはチェックを入れても要素に属性として追加されないからです。attrメソッドは要素の状態ではなく属性が存在しているかを判定します。そのため、こちらから意図的にchecked属性を追加するコードを記述しない限り永遠にundefinedが返されます。

ブログランキング・にほんブログ村へ PVアクセスランキング にほんブログ村 FC2 Blog Ranking

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!
目次