【Javascript活用講座】もっとHTML要素を上手く操作するためのappendChildの使い方

※ 当ページには【広告/PR】を含む場合があります。

2021/12/22

2022/10/03

【javascript基礎講座】クラスコンストラクタの内部で async/await を使う時の注意

TypescriptのInterfaceでasync関数を定義する・async関数でクラス変数(this)を使う

蛸壺の技術ブログ｜もっとHTML要素を上手く操作するためにappendChildメソッドをカスタマイズする

たまに思いついたときに唐突に出てくるjavascriptのテクニカルな話題です。

今回はHTMLを直接スクリプトからDOM操作するために必須となる

「appendChild」

メソッドにスポットを当てます。

特にappendChildの面白い特徴である

「メソッドチェーン」

を理解することで、より効率的なDOM操作を検討してみましょう。

Javascript(js)＆Typescript(ts)プログラミング入門〜これから学ぶ人のためのおすすめ書籍＆教材の手引き

appendChildメソッドの基本

「appendChildメソッド」はその名の通りHTML要素(ノード)の下に子要素(ノード)を追加するだけです。

以下のHTMLファイルをブラウザで直に開いて確認してみましょう。

開く/閉じる

            
            <!DOCTYPE html>
<html lang="ja">
<html>
    <meta charset="utf-8"/>
    <body>
        <div id="wrapper"></div>
        <script>
            document.addEventListener("DOMContentLoaded", () => {
                const parent = document.getElementById('wrapper');

                const child = document.createElement('p');
                child.textContent = 'appendChildメソッドのテストです。';

                //👇親ノードに子ノードを追加する
                parent.appendChild(child)
            });
        </script>
    </body>
</html>

結果は以下のようになります。

このようにappendChildメソッドはとてもシンプルな機能です。

シンプルな故に、ほとんどの人は

appendChildメソッドの返り値

についてほぼ利用することもなく、普段は意識してはいないと思います。

今回はこのポイントを良く理解してみましょう。

結論から先に言うと、

「appendChildは追加した子ノードを返す」

ということをします。

先程のindex.htmlのスクリプト中身を以下に変更します。

開く/閉じる

            
            document.addEventListener("DOMContentLoaded", () => {
    const parent = document.getElementById('wrapper');

    const child = document.createElement('p');
    child.textContent = 'appendChildメソッドのテストです。';

    child === parent.appendChild(child) && console.log('オブジェクトが一致しました');
});

ということで、appendChildの返り値が追加した子要素と一致しました。

この返り値に一体なんの意味が...と感じる人もいるかもしれません。

一つはappendChildで最後に追加した要素を確認したいとき、もう一つは追加した子要素の下にさらに孫要素を追加したいとき、に使うことができます。

よってappendChildが追加した子要素そのものを返すため、先程のコードならば以下のようにワンライナーで書くことができます。

開く/閉じる

            
            document.addEventListener("DOMContentLoaded", () => {
    document.getElementById('wrapper').appendChild(document.createElement('p')).textContent = 'appendChildメソッドのテストです。';
});

Javascript(js)＆Typescript(ts)プログラミング入門〜これから学ぶ人のためのおすすめ書籍＆教材の手引き

createElementをカスタマイズする

もっとDOM操作をjavascriptから使いやすくするためは、

createElementメソッド

を拡張したほうが良いでしょう。

これは標準のcreateElementは一つの引数にHTMLタグ名を指定してHTML要素を生成するだけですので、あまり使い勝手の良いメソッドとは言えないことが理由です。

ということで

独自定義のcreateElementメソッド

を以下のように作成します。

開く/閉じる

            
            const createElement = (tagName, attrs) => {
    const _e = document.createElement(tagName);
    if (attrs) {
        for (let attr in attrs) { _e[attr] = attrs[attr]; }
    }
    return _e;
};

これで前節のスクリプト部分はもっと見通しが良くすることができて、

開く/閉じる

            
            const createElement = (tagName, attrs) => {
    const _e = document.createElement(tagName);
    if (attrs) {
        for (let attr in attrs) { _e[attr] = attrs[attr]; }
    }
    return _e;
};

document.addEventListener("DOMContentLoaded", () => {
    document.getElementById('wrapper').appendChild(createElement('p', {
        textContent: 'appendChildメソッドのテストです。'
    }));
});

とかなりスッキリとコードが書けるようになりました。

Javascript(js)＆Typescript(ts)プログラミング入門〜これから学ぶ人のためのおすすめ書籍＆教材の手引き

appendChildメソッドチェーン

ここからが気持ち的に本題です。

先程のから説明してきた通り、appendChildメソッドには追加した子要素の参照がそのまま返ってくる性質を利用しすることで、ワンライナーでDOMを直列的に生成することが可能になります。

これをここでは

「appendChildメソッドチェーン」

と呼ぶことにします。

一例を示すと、以下のようなスクリプトに変更します。

開く/閉じる

            
            const createElement = (tagName, attrs) => {
    const _e = document.createElement(tagName);
    if (attrs) {
        for (let attr in attrs) { _e[attr] = attrs[attr]; }
    }
    return _e;
};

document.addEventListener("DOMContentLoaded", () => {
    document.getElementById('wrapper')
        .appendChild(createElement('div', {
            innerHTML: 'これは最初のDIVです。'
        }))
        .appendChild(createElement('div', {
            innerHTML: 'これは２番めのDIVです。'
        }))
        .appendChild(createElement('div', {
            innerHTML: 'これは３番めのDIVです。'
        }))
        .appendChild(createElement('span', {
            innerHTML: 'これは３番めの中の最初のSPANです。'
        }));
});

生成されたDOMを確認すると以下のようになっています。

ということで、appendChildメソッドチェーンを使えば容易にかつ効率的に階層的なDOMを作成することが可能となりました。

Javascript(js)＆Typescript(ts)プログラミング入門〜これから学ぶ人のためのおすすめ書籍＆教材の手引き

余談〜コンストラクタ関数でメソッドチェーンを拡張

先程まででappendChildメソッドチェーンでDOM階層の縦方向へ要素を繋げることができました。

欲を言えば、同じ階層にある要素をDOM構造の横のつながりも柔軟に増やしてみたいと思われるかも知れません。

この場合、

コンストラクタ関数

を使ってオブジェクトのprototypeを拡張することで、独自のメソッドチェーンを組み込むことができます。

Class構文でも同じように出来るのですが、classを使うことが出来るのはECMAScript 6以降ですので、取り扱いには注意が必要です。

例えばDOMBuilderという名前でコンストラクタ関数を作ります。

開く/閉じる

            
            function DOMBuilder(element) {
    this.element = element;
};
DOMBuilder.prototype = {
    appendChildren: function(domSeed) {
        const children = [];
        for (const el of domSeed) {
            const child = this.element.appendChild(createElement(el[0], el[1]));
            children.push(new DOMBuilder(child));
        }
        return children;
    }
};

ポイントはプロトタイプで追加した

appendChildren

メソッドの返り値が、追加した子ノードのDOMBuilder関数のインスタンスの入った配列にしている点です。

使い方は若干複雑になるのですが、以下のように使います。

開く/閉じる

            
            const createElement = (tagName, attrs) => {
    const _e = document.createElement(tagName);
    if (attrs) {
        for (let attr in attrs) { _e[attr] = attrs[attr]; }
    }
    return _e;
};

function DOMBuilder(element) {
    this.element = element;
};
DOMBuilder.prototype = {
    appendChildren: function(domSeed) {
        const children = [];
        for (const el of domSeed) {
            const child = this.element.appendChild(createElement(el[0], el[1]));
            children.push(new DOMBuilder(child));
        }
        return children;
    }
};

document.addEventListener("DOMContentLoaded", () => {
    (new DOMBuilder(document.getElementById('wrapper')))
        .appendChildren([
            ['div', {innerHTML: 'これは最初のDIVです。'}],
            ['div', {innerHTML: 'これは２番目のDIVです。'}],
            ['div', {innerHTML: 'これは３番目のDIVです。'}],
        ]).forEach(dom => {
            dom.appendChildren([
                ['p', {textContent: `${dom.element.innerHTML} の最初のPです。`}],
                ['p', {textContent: `${dom.element.innerHTML} の２番めのPです。`}],
            ]);
        });
});