0%

Programmingプログラミングナレッジ

Posted:2019.10.01

Vue.jsで直接DOMを操作する時に使える$elと$refs

Vue.jsではjQueryのように、直接DOMを参照してそのDOMに対して何らかの操作をするというケースはあまりありません。コンポーネントとして取り扱ったり、コンポーネントにあるテンプレート内で直接的に要素に対して操作するためです。

 

とは言っても、要素固有の座標位置や高さなどのDOMが持つ情報を取得して、何らかの処理を行いたい場合には、直接DOMを参照するような場合も出てきます。Vue.jsでは直接的にDOMを参照する際に「$el」や「$refs」などのプロパティが用意されており、これらを使うことで直接コンポーネント内のDOMを参照することができます。

 

コンポーネントのルート要素を取得する「$el」

「$el」を使うことで、そのコンポーネントのルート要素にあたるDOMを参照することができます。下記のようにVueコンポーネントファイル内のscriptで使うと、そのコンポーネント内のルート要素のDOMが取得できます。

【Vue】※一部抜粋

<template>
 <div id="component_root">
  <div>子要素1</div>
  <div>子要素2</div>
  <div>子要素3</div>
 </div>
</template>

<script>
 export default {
  mounted() {
   const targetElement = this.$el;
   console.log('対象のDOM:', targetElement);
  }
 } 
</script>

 

【console】

対象のDOM:<div id="root_element" data-v-fae5bece="">

 

この時に注意しないといけないのは、「mounted」以降で処理を実行しなければなりません。すでにDOMが生成されている必要であるためです。ちなみにVueインスタンスの中で使用した場合には、そのVueインスタンスにおけるマウントされた要素、つまり「el」で指定した要素のDOMが取得できます。Vue.jsでは「this.$el」で取得します。

【Vueインスタンスの場合】※一部抜粋

new Vue ({
 el: '#app',
 .......
 mounted() {
  const targetElement = this.$el;
  console.log('対象のDOM:', targetElement);
 }
})

 

【console】

対象のDOM:<div id="#app" data-v-fae5bece="">

 

実際にデベロッパーツールでも確認することができます。参照先のDOMでいろんな情報を取得することができます。

Vue.jsで直接DOMを操作する時に使える$elと$refs

 

 

「$refs」でコンポーネント内の個別DOM要素を直接参照する

次に「$refs」を使うと、HTML内で「ref属性」で対応する値をつけた要素を参照することができます。参照したい要素のHTMLに「ref属性」を追加し、値には任意の名前をつけておきます。

【Vue】※一部抜粋

<template>
 <div id="component_root">
  <div ref="first_child" class="children-1st">子要素1</div>
  <div ref="second_child" class="children-2nd">子要素2</div>
  <div ref="third_child" class="children-3rd">子要素3</div>
 </div>
</template>

<script>
 export default {
  mounted() {
   const targetElement = this.$refs.first_child
   const targetElementText = this.$refs.first_child.textContent
   console.log('対象のDOM:', targetElement);
   console.log('対象のDOMのテキスト:', targetElementText);
  }
 } 
</script>

 

【console】

対象のDOM:<div class="children-1st" data-v-fae5bece="">
対象のDOMのテキスト:子要素1

 

その上で、「this.$refs.ref属性の値」と記述することで対象のDOMを参照することができます。こちらも同じくDOMが生成されている必要があるので、必ずmounted内において実行する形になります。

 

こちらも同じくデベロッパーツールでも確認することができます。参照先のDOMでいろんな情報を取得することができます。

Vue.jsで直接DOMを操作する時に使える$elと$refs

 


 

Vue.jsでは直接DOMを参照することは少ないかもしれませんが、ちょっとしたUIの実装などでDOMを直接参照して操作するケースもあるかと思いますので、知っておくと便利ですね。

author
この記事を書いた人オガワ シンヤ
FacebookTwitter

DesignSupply.代表 / ディレクター・ウェブデザイナー・フロントエンドエンジニアをやっています。「ウェブとデザインでヒト・モノ・サービスを繋げ新しい価値を生み出す」をコンセプトに日々奮闘中!制作中はチョコレートが欠かせない三十路Webクリエイター。

制作のご依頼やお問い合わせ・パートナー業務提携のご相談はこちら

デザインやウェブ制作についてのご依頼やご相談、その他お問い合わせなどもお気軽にご連絡ください。フットワークの軽さやレスポンスの早さ、また豊富な経験や知識、技術を活かした対応力といったフリーランスクリエイターの強みでクライアント様、パートナー企業様のお力になります。デザインからコーディングやWordPress実装といったウェブサイト構築はもちろん、写真撮影や動画編集、コンテンツ制作からサイト運用サポートまで一括してお任せください。

ホームページ制作のご検討やウェブ運用でお悩みの経営者様や企業のウェブ担当者様をはじめ、個人で店舗を営んでいらっしゃるオーナー様、フリーで活動されているビジネスオーナー様はもちろんのこと、リソース不足でお困りの制作会社様、またクリエイターをお探しの代理店様も大歓迎です。

コンタクトをご希望の方はお手数ですが、下記よりお問い合わせフォームのページへアクセスしていただき、必要事項を入力の上メッセージを送信してください。確認でき次第すぐに折り返しご連絡致します。

こんな記事も読まれています

コメントもお気軽にどうぞ

記事に関するご質問やご意見などありましたら下記のコメントフォームよりお気軽に投稿ください。なおメールアドレスは公開されませんのでご安心ください。また、* が付いている欄は必須項目となります。

内容に問題なければ、下記の「コメントを送信する」ボタンを押してください。

CAPTCHA


ページトップへ
大阪市天王寺区のホームページ制作デザイン事務所(SOHO)DesignSupply.【デザインサプライ】