innerHTML、textContent、innerText 使い分け

it
troubled-woman.png

jsのinnerHTMLtextContentinnerText をどう使い分けければいいの?
特に innerTextはどの場面で使えるの?

その悩みにお答えします。

それぞれのプロパティの違いを理解していますか?

HTML 要素の取得・書き込みしたい時は innerHTML を使って、文字列の書き込み・挿入したい時は textContent を使えば良いのでは?と思った読者さん。

正解です。

では次の質問に答えれますか?

Q1 : ブラウザで表示されているテキストのみを取得する方法は?(例えば display:none が指定された要素のテキストを省きたい時)
Q2 : 改行を含めたテキストを挿入する方法は?

答えはどちらも 「 innerText を使用する」です。
(Q2 の別解としては「 innerHTMLbr タグを含めてテキストを書き込む」がある)

今回は innerHTMLtextContentinnerText の取得時と挿入時での特徴を紹介します。

対象読者

  • 何か挿入したい時はとりあえず innerHTML を多用している人
  • 取得や書き込みが意図したものと違った経験がある人
  • 特殊文字(例えば
    <
    )の取得時・書き込み時の挙動の違いを知りたい人

それでは早速やっていきましょう。

取得時

以下の検証用の HTML コードを使って、 innerHTMLinnerTexttextContent による取得時の違いを見ていきます。

検証用の HTML コード


  <section id="sectionA">
    <div><br>白石
        萌音
    </div>
    &lt;span&nbsp;&gt;文字実体参照&lt;/span&gt;
    <div id="divA" style="visibility:hidden">見えない要素</div>
    <div id="divB" style="display:none">非表示の要素</div>
    <div id="divC"><s>取り消し線</s></div>
    <script>
        console.log("スクリプトだよ")
    </script>
    <style>
        #divC {
            width: 300px;
            height: 300px;
            background-color: #aaa;
            text-decoration: underline;
        }
        </style>
        </section>

上記のHTMLコードのブラウザでの表示結果

取得する値

それぞれのプロパティで取得した値を console.log で確認します。

innerHTML


const sectionA = document.getElementById("sectionA")
console.log(sectionA.innerHTML)

Console 画面

innerText


const sectionA = document.getElementById("sectionA")
console.log(sectionA.innerText)

Console 画面

textContent


const sectionA = document.getElementById("sectionA")
console.log(sectionA.textContent)

Console 画面

取得する値のまとめ

console.log で出力された値について以下にまとめました。

innerHTML innerText textContent
HTMLタグ 表示される 表示されない。br タグ が使用されていたところでは改行される。 表示されない
HTMLコード内の改行 改行される 改行されない 改行される
文字列実体参照 特殊文字に変換前の文字列のまま表示される 変換後の特殊文字が表示される 変換後の特殊文字が表示される
script 要素 表示される 表示されない 要素内のテキストのみ表示される
style 要素 表示される 表示されない 要素内のテキストのみ表示される
display:none を指定した要素 表示される 表示されない 要素内のテキストが表示される
visibility:hidden を指定した要素 表示される 表示されない 要素内のテキストが表示される

それぞれのプロパティの取得時の特徴

innerText

取得してくる値は、ブラウザで表示されている HTML 要素内のテキストといった感じです。br タグでの改行は反映され、非表示の要素のテキストは取得されません。

  • 取得した要素内の改行は、ソースコード上の改行は反映されませんが、br タグでの改行は反映されます。
  • 取得した要素内の文字実体参照は、ソースコード上のものではなく、ブラウザで表示されるような変換後の特殊文字が取得されます。
  • 取得した要素内の stylescript 要素のテキストは取得されません。
  • 取得した要素内の HTML 要素で display:nonevisibility:hidden が指定されている要素のテキストは取得されません。つまり、ブラウザで表示されていないテキストは取得されません。

innerHTML

取得してくる値は、HTMLコードです。HTMLタグ含めてHTMLコードを全て文字列として取得している感じです。

  • 取得した要素内の改行は、ソースコード上の改行は反映されますが、br タグでの改行は反映されません。
  • 取得した要素内の文字実体参照は、ソースコード上のものが取得されます(特殊文字への変換前の文字列)。
  • 取得した要素内のHTML要素は stylescript 要素含めて全て取得されます。

textContent

取得してくる値は、ブラウザ上で表示されているテキストというより、ソースコード上のHTML要素内のテキストといった感じです。
display:none の指定などによりブラウザで非表示になっている要素のテキストも取得されます。

  • 取得した要素内の改行は、ソースコード上の改行は反映されますが、br タグでの改行は反映されません。
  • 取得した要素内の文字実体参照は、ソースコード上のものではなく、ブラウザで表示されるような変換後の特殊文字が挿入されます。
  • 取得した要素内の stylescript 要素のテキストも取得されます。
  • 取得した要素内の HTML 要素で display:nonevisibility:hidden が指定されている要素のテキストも取得されます。つまり、ブラウザで表示されていないテキストも取得されます。

それぞれのプロパティの取得時の使い分け方

  • 要素の中の、HTMLコードを取得したい時innerHTML
  • 要素の中の、非表示の要素を含むテキスト( display:none が指定されている要素のテキストや style 要素の中など)を取得したい時textContent
  • 要素の中の、ブラウザで表示されている、テキストや改行を取得したい時innerText

挿入時

以下の検証用の HTML コードを使って、 innerHTMLinnerTexttextContent による書き込み時の違いを見ていきます。

検証用の HTML コード


  <section id="sectionA"></section>
  

挿入後のブラウザでの表示結果

それぞれのプロパティを使って、書き込んだ文字列を挿入します。書き込んだ文字列はどのプロパティでも同文です。

innerHTML


const sectionA = document.getElementById("sectionA")
sectionA.innerHTML = `
    <div><br>白石
        萌\n</div>
    &lt;span&nbsp;&gt;文字実体参照&lt;/span&gt;
    <div id="divA" style="visibility:hidden">見えない要素</div>
    <div id="divB" style="display:none">非表示の要素</div>
    <div id="divC"><s>取り消し線</s></div>
    <script>
        console.log("スクリプトだよ")
    </script>
    <style>
        #divC {
            width: 300px;
            height: 300px;
            background-color: #aaa;
            text-decoration: underline;
        }
        </style>
`
  

ブラウザの表示結果

innerText


const sectionA = document.getElementById("sectionA")
sectionA.innerText = `
    <div><br>白石
        萌\n</div>
    &lt;span&nbsp;&gt;文字実体参照&lt;/span&gt;
    <div id="divA" style="visibility:hidden">見えない要素</div>
    <div id="divB" style="display:none">非表示の要素</div>
    <div id="divC"><s>取り消し線</s></div>
    <script>
        console.log("スクリプトだよ")
    </script>
    <style>
        #divC {
            width: 300px;
            height: 300px;
            background-color: #aaa;
            text-decoration: underline;
        }
        </style>
`
  

ブラウザの表示結果

textContent


const sectionA = document.getElementById("sectionA")
sectionA.textContent = `
    <div><br>白石
        萌\n</div>
    &lt;span&nbsp;&gt;文字実体参照&lt;/span&gt;
    <div id="divA" style="visibility:hidden">見えない要素</div>
    <div id="divB" style="display:none">非表示の要素</div>
    <div id="divC"><s>取り消し線</s></div>
    <script>
        console.log("スクリプトだよ")
    </script>
    <style>
        #divC {
            width: 300px;
            height: 300px;
            background-color: #aaa;
            text-decoration: underline;
        }
        </style>
`
  

ブラウザの表示結果

挿入後のブラウザの表示結果まとめ

書き込んだ文字列を挿入後のブラウザの表示結果をまとめました。
場合 \ プロパティ innerHTML innerText textContent
HTML要素 要素は解析されて挿入 要素は解析されず文字列として挿入 要素は解析されず文字列として挿入
改行 半角スペースとして挿入 改行として挿入 半角スペースとして挿入
改行(\n) 半角スペースとして挿入 改行として挿入 半角スペースとして挿入
文字列実体参照 変換されて特殊文字として挿入 変換されず元の文字列で挿入 変換されず元の文字列で挿入
script 要素 要素は解析されて挿入?(script 要素の中の処理は実行されない 要素は解析されず文字列として挿入 要素は解析されず文字列として挿入
style 要素 要素は解析されて挿入 要素は解析されず文字列として挿入 要素は解析されず文字列として挿入
display:none を指定した要素 解析され非表示になる 文字列として挿入 文字列として挿入
visibility:hidden を指定した要素 解析され非表示になる 文字列として挿入 文字列として挿入

それぞれのプロパティの挿入時の特徴

innerText

書き込んだ文字列がほぼそのまま文字列として挿入されるが、文字列の中の改行コード(\n)では改行されます。
書き込んだ文字列内のHTML要素は、解析されず文字列として挿入されます。

  • 書き込んだ文字列内のHTML要素は、解析されず文字列として挿入されます。
  • 書き込んだ文字列内の改行は、改行として挿入されます。
  • 書き込んだ文字列内の改行コード(\n)は、改行として挿入されます。
  • 書き込んだ文字列内の文字実体参照は、特殊文字に変換されず文字列のまま挿入されます。

innerHTML

書き込んだ文字列のHTML要素は解析され、HTML要素として挿入されます。style 要素や script 要素もDOMに追加されますが、script は実行されません。

  • 書き込んだ文字列内のHTML要素は、解析されHTML要素として挿入されます。
  • 書き込んだ文字列内の改行は、半角スペースとして挿入されます。
  • 書き込んだ文字列内の改行コード(\n)は、半角スペースとして挿入されます。
  • 書き込んだ文字列内の文字実体参照は、変換後の特殊文字が挿入されます。

textContent

書き込んだ文字列がほぼそのまま文字列として挿入されますが、文字列内の改行は半角スペースとして挿入されます。

  • 書き込んだ文字列内のHTML要素は、解析されず文字列として挿入されます。
  • 書き込んだ文字列内の改行は、半角スペースとして挿入されます。
  • 書き込んだ文字列内の改行コード(\n)は、半角スペースとして挿入されます。
  • 書き込んだ文字列内の文字実体参照は、特殊文字に変換されず文字列のまま挿入されます。
  • 今回の検証では、innerText と違う点は書き込んだ文字列の改行の扱いぐらい?

それぞれのプロパティの挿入時の使い分け方

  • 改行を含まないテキストを挿入したい時textContent
  • HTML要素や style を指定する必要がないが、改行を含むテキストを挿入したい時innerText を使用する。
  • HTML要素や style を指定したい時innerHTML を使用する。

まとめ

調べ始めた当初は innerHTMLtextContent の使い分けは明確なのですが、innerTextの使い所が不明でした。

しかし調べていくうちに、それぞれのプロパティの違いを知ることができました。
(まあ innerHTMLtextContent でほとんどのケースをカバーできそうな気もしますが。。)

筆者が考える innerText の使い所は、テキストがブラウザに表示されているか否かで処理を分岐する時、だと考えています。

具体的な使い方については、使い方を習熟した後に別の記事で紹介したいと思います。

それではお読みいただきありがとうございました。

コメント