ホーム
システム開発
Vueで再帰的コンポーネントを作成する方法【Vue3】

Vueで再帰的コンポーネントを作成する方法【Vue3】

2024/01/29

2024/02/19

Vue.js

※当ブログの記事にはアフィリエイトリンクを使用している場合があります。

はじめに

この記事ではVue.jsで再帰的コンポーネントの作成方法を解説します。

再帰的コンポーネントとは、あるコンポーネントが自身を呼び出しているようなコンポーネントを指します。
例えば、ディレクトリ構造やスレッド形式のコメント欄等をコンポーネント化する際に使うことが考えられます。

今回は、ディレクトリ構造を表現するコンポーネントを作成してみます。

再帰的コンポーネントの基本

Vue.jsで再帰的コンポーネントを作成するのは簡単です。

コンポーネントはデフォルトで自身を呼び出すことができます。
例えば、FooBar.vue というファイル名のコンポーネントは、そのテンプレート内で <FooBar/> として呼び出せます。

自身を呼び出すだけではコンポーネントが無限に描画されていくので、あとは描画の条件をv-ifなどを利用して制御します。

ディレクトリ構造を再帰的コンポーネントで再現する

再帰的コンポーネントの例として、ディレクトリ構造を表現するコンポーネントを作成します。
コンポーネントの見た目は以下のようになります。

今回作成するコンポーネント

ディレクトリ構造を再現する再帰的コンポーネントDirectoryTree.vueは、以下のように作成しました。
（CSSは一部省略）

DirectoryTree.vue

<script setup lang="ts">
interface Props {
  type: string;
  name: string;
  children?: Array<any>;
}

const props = withDefaults(defineProps<Props>(), {
  type: "",
  name: "",
  children: () => [],
});
</script>

<template>
  <template v-if="props.type === 'directory'">
    <li>
      <span class="directory">{{ props.name }}</span>
      <ul>
        <div v-for="child in props.children">
          <DirectoryTree
            :type="child.type"
            :name="child.name"
            :children="child.children"
          ></DirectoryTree>
        </div>
      </ul>
    </li>
  </template>

  <template v-else>
    <li>
      <span class="file">
        {{ props.name }}
      </span>
    </li>
  </template>
</template>

propsのtypeがdirectoryのときはディレクトリのため再度、自身のコンポーネント名であるを呼び出します。
propsのtypeがdirectoryのときはファイルのため、ファイル名のみを描画しています。

このコンポーネントを呼び出す親コンポーネントApp.vueは、以下のように作成しました。

App.vue

<script setup lang="ts">
import { ref } from "vue";
import DirectoryTree from "./DirectoryTree.vue";

const tree = ref([
  {
    type: "directory",
    name: "Dir1",
    children: [
      {
        type: "file",
        name: "File1",
      },
      {
        type: "directory",
        name: "Dir2",
        children: [
          {
            type: "file",
            name: "File2",
          },
          {
            type: "directory",
            name: "Dir3",
            children: [
              {
                type: "file",
                name: "File3",
              },
              {
                type: "file",
                name: "File4",
              },
            ],
          },
        ],
      },
    ],
  },
  {
    type: "file",
    name: "File5",
  },
]);
</script>

<template>
  <DirectoryTree :type="'directory'" :name="'/'" :children="tree"></DirectoryTree>
</template>