OWNED MEDIAウェブ制作に役立つコンテンツを発信中!

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

最終更新日:2020.2.15 Update!!
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を直接参照して操作するケースもあるかと思いますので、知っておくと便利ですね。  
  • はてなブックマーク
  • Pocket
  • Linkedin
  • Feedly

この記事を書いた人

Twitter

SPONSORED

    KEYWORD SEARCH

    RECENT POSTS

    合同会社デザインサプライ -DesignSupply. LLC-

    サイト制作・開発 / 各種デザイン制作 / ウェブプロモーション企画

    合同会社デザインサプライ(DesignSupply. LLC)

    Office:大阪府大阪市天王寺区清水谷町3-22
    Email:info@designsupply-web.com
    • Twitter
    • Github
    CONTACT USSCROLL TO TOP
      • Facebook
      • Twitter
      • Github
      • Instagram