Vue 入門

WARNING

コマンドやコードを示すときに{ユーザー名}のような表記をすることがありますが、これは実際には自分の情報に合わせて{}を取り除いた上で、自分のユーザー名を入力してください。

git cloneするときの例を挙げてみます。

bash

$ git clone {リポジトリのURI}

上のように書いてあって traQ のリポジトリをクローンする場合、以下のように自分がクローンしたいリポジトリの URI を入力します。

bash

$ git clone git@github.com:traPtitech/traQ.git

このような表記はしばしば出てくるので、{}をつけたまま書いてしまわないように気をつけましょう。

Vue テンプレートのクローン

~/developディレクトリの中にテンプレートリポジトリをクローンしてプログラムを書きます。
予め設定等が準備されたテンプレートリポジトリを用いて、最終的には TodoList を作っていきます。

GitHub に SSH 鍵を登録していない人は以下を参考にしてまず登録してください。

SSH鍵の登録

traPtitech/naro-template-frontend にアクセスし、「Use this template」→「Create a new repository」をクリックしてください。

「Repository name」にリポジトリ名を入力、公開状態は TA が見られるように「Public」にしてください。

「Create repository from template」でリポジトリを作成したら手元にクローンしてください。
cd {リポジトリ名}でプロジェクトのディレクトリに移動し、code .で VSCode を開きます。

開いたプロジェクトの中に入っているpackage.jsonというファイルには npm に関する様々な設定が書かれています。この中には依存するパッケージ一覧も含まれており、以下のコマンドでそれらをインストールできます。

$ npm i
もしくは
$ npm install

bash

mehm8128@DESKTOP-6F4C0KI ~/develop/todolist-mehm8128 (main)$ npm i

added 130 packages, and audited 131 packages in 2s

20 packages are looking for funding
  run `npm fund` for details

1 moderate severity vulnerability

To address all issues, run:
  npm audit fix

Run `npm audit` for details.

テンプレートは初期状態でビルド&配信できるようになっているので、以下のコマンドを実行してブラウザで確認してみましょう。

$ npm run dev

bash

mehm8128@DESKTOP-6F4C0KI ~/develop/todolist-mehm8128 (main)$ npm run dev

> todolist@0.0.0 dev
> vite


  VITE v4.3.8  ready in 611 ms

  ➜  Local:   http://localhost:5173/
  ➜  Network: use --host to expose
  ➜  press h to show help

この状態で、ブラウザから localhost:5173 にアクセスすると、以下のような画面が表示されるはずです。

止めるときはCtrl + Cで止めてください。

Vue 入門

Vue とは

以下のリンクから公式ドキュメントに飛ぶことができます。
Vue

traP では、Web フロントフレームワークとして最も多く使われているフレームワークで、traQ、traPortal、Showcase、anke-to、knoQ などで使われています。

`.vue`ファイルについて

Vue では.vueという拡張子で単一ファイルコンポーネント(SFC, Single File Component)を作ることができます。

なろう講習会の言葉で言うと、Vue では、1 つの同じファイルに構造(HTML)・ロジック(JavaScript)・スタイル(CSS) を記述できます。それぞれを別の巨大なファイルに書くのではなく、見た目に対応した要素を各ファイルに分割して書くことで、それぞれの責任範囲をより直感的な形式で分けることができるわけです。このように分けられた要素をコンポーネントといいます。

Vue の書き方

<script>タグ内にロジック
<template>タグ内に構造
<style>タグ内にスタイル

を記述します。

Sample.vue

vue

<script>
// ロジック
</script>

<template>
  <!-- 構造 -->
</template>

<style>
/* スタイル */
</style>

使用例

traQ で 1 つ例を挙げると、メッセージの表示部分はコンポーネントとして定義されています。メッセージも複数のコンポーネントから構成されています。

https://github.com/traPtitech/traQ_S-UI/blob/master/src/components/Main/MainView/MessageElement/MessageElement.vue

メッセージ情報(ユーザー名、画像、ファイル等)の構造(HTML)
メッセージにスタンプをつける等のロジック(TypeScript)
それらのスタイルを記述するスタイル(Scss)

が 1 つのファイルに纏められていることがわかります(このファイルはたった 130 行程度ですが、traQ にはコンポーネントが 300 個以上あります。これがそれぞれの HTML、 CSS、 JavaScript のファイルに書かれていると想像してみると...)。

プロジェクト構造

.
├── index.html              // 最初にブラウザに読まれるHTMLファイル
├── node_modules/           // 依存ライブラリの保存先
├── package-lock.json       // 依存ライブラリ(詳細)
├── package.json            // 依存ライブラリ・タスク・各種設定
├── public
│   └── favicon.ico         // 静的ファイル(ビルドされない)
├── src
│   ├── App.vue             // main.jsから読まれる.vueファイル(Vueの処理開始点)
│   ├── images              // Vueで使用したい画像など
│   │　　└── logo.svg
│   ├── components          // 各種コンポーネント
│   │　　└── HelloWorld.vue
│   └── main.ts　　　　　　　　// index.htmlから読まれるscript(TSの処理開始点)
└── vite.config.ts

`index.html`

Vite はここから参照されているファイルをたどってビルドを進めていきます。ここに必要なものを書き加えることもありますが、基本的には書き換えません。マウント用の<div id="app"></div>とmain.jsの読み込みが書かれています。

`node_modules`

npm install でインストールされる依存ライブラリが保存されるディレクトリです。中を見ることは殆ど無いです。 .gitignoreに指定されています。(package.json, package-lock.json があれば npm install で再現できるためです)

`package.json` `package-lock.json`

プロジェクトに関するメタ情報や、npm run ~~で実行できるタスク、依存ライブラリの情報が記述されています。

`src/main.ts`

index.html で読み込まれている ts ファイルです。ここでは Vue インスタンスを生成し、index.html の<div id="app"></div>部分にマウントしています。

`src/App.vue`

Vue としてのエントリーポイントです。 HelloWorld コンポーネントを読み込み → 登録 → 描画しています。

`src/components/HelloWorld.vue`

ここと似たようなものをどんどん書いていきます。 App.vueで呼び出されています。
components内に他にも色々なコンポーネントがありますが、今回は使わないので省略します。

Vue を書く準備

まず、以下の拡張機能をインストールしてください。

Vue Dev tool

Chrome Devtool に Vue 向けのデバッグ機能を追加してくれます。
Vue devtools - Chrome ウェブストア

ソースコードの書き進め方

npm run devで起動していれば、ファイルの変更を自動で検知して表示が更新されます。

TIP

ちゃんと保存しましょう。

画面上部のタブのファイル名の横に ● がついているときは保存できていません。

設定で自動保存されるようにしておくと便利です。
参考：自動保存するように設定する

Vue を書く

Web 基礎講習会で書いたカウンターのソースコードを再掲します。

index.html(一部抜粋)

html

<body>
  <h1>カウンター</h1>
  <div id="count">回数: 0</div>
  <button onclick="countUp()">クリック！</button>
  <button onclick="reset()">リセット！</button>
</body>

counter.js

let count = 0
const countUp = () => {
  count++
  const countElement = document.querySelector('#count')
  countElement.innerText = '回数: ' + count
}

const reset = () => {
  count = 0
  const countElement = document.querySelector('#count')
  countElement.innerText = '回数: ' + count
}

INFO

Go や C++などでは""と''が区別されますが、JavaScript では区別されません。

Vue を書く

先にコードを書いてから解説を書いています。
意味がわからなくてもとりあえずコピー&ペースト or 写経しましょう。

ファイルの作成

componentsディレクトリ内にClickCounter.vueというファイルを作成します。

ソースコードの変更

src/App.vue

styleタグを丸ごと消します。

vue

<script setup lang="ts">
import HelloWorld from './components/HelloWorld.vue'
import TheWelcome from './components/TheWelcome.vue'
</script>

<template>
  <header>
    <img alt="Vue logo" class="logo" src="./assets/logo.svg" width="125" height="125" />

    <div class="wrapper">
      <HelloWorld msg="You did it!" />
    </div>
  </header>

  <main>
    <TheWelcome />
  </main>
</template>

src/components/HelloWorld.vue

scriptタグ内でClickCounter.vueを読み込み、templateタグ内にカウンターを配置します。

vue

<script setup lang="ts">
import ClickCounter from './ClickCounter.vue'

defineProps<{
  msg: string
}>()
</script>

<template>
  <div>
    <h1>{{ msg }}</h1>
    <ClickCounter />
  </div>
</template>

<style scoped>
a {
  color: #42b983;
}
</style>

src/components/ClickCounter.vue

vue

<script setup lang="ts">
import { ref, computed } from 'vue'

const count = ref<number>(0)
const countMessage = computed(() => '回数: ' + count.value)
</script>

<template>
  <div>
    <div>{{ countMessage }}</div>
    <button @click="count++">クリック！</button>
    <button @click="count = 0">リセット！</button>
  </div>
</template>

<style></style>

以下のように動けば OK です。

ソースコード解説

src/components/HelloWorld.vue

9~14 行目

テンプレート部分です。
Vue のコンポーネントは 1 つのタグの中に収まっている必要があります。
そのため、多くの場合 div タグで囲まれています。(ClickCounter.vueも)

1 行目

vue

<script setup lang="ts">

lang="ts"に注目してください。実は今回は script タグ内では JavaScript なくて、TypeScirpt を書いています。TypeSciript は JavaScript に型がついたもので、SysAd のほぼ全てのプロジェクトで用いられています。型をつけることでバグを防ぐことができるので、この講習会でも TypeScript を使っていきます。

2 行目

import ClickCounter from "./ClickCounter.vue"

ClickCounter コンポーネントを読み込む部分です。

4 行目

defineProps<{
	msg: string
}>()

msgprops をstring型で定義してる部分です。
今回だとApp.vueで <HelloWorld msg="Hello Vue 3 + Vite" />のような形でmsgに値を指定することで、コンポーネントを使う側から値を渡しています。 JavaScript でいう関数の引数のようなものです。

参考: プロパティ | Vue

INFO

今回は template 内でしか props の値を使っていないのでmsgで直接アクセスできていますが、script 内で使う場合は以下のようにしてpropsを定義し、props.msgのようにアクセスする必要があります。

const props = defineProps()

また、このとき以下のように分割代入してしまうとリアクティビティ性が失われてしまうので、このような書き方はできません。

const { msg } = defineProps()

参考：分割代入 - JavaScript | MDN
参考：リアクティビティーの基礎 | Vue.js

12 行目

tsx

<ClickCounter />

読み込んだコンポーネントを利用しています。

src/components/ClickCounter.vue

4 行目

コンポーネント内で利用する変数をこのように書きます。
ここではcountという名前の変数をnumber型で定義しています(実はこの程度なら TypeScript の型推論というものが効いて、初期値の0から自動でcount変数はnumber型だと推論してくれます)。 refを使うことで、Vue が値の変更を検知して自動で再描画してくれるようになります。

const count = ref<number>(0)

参考: リアクティビティーの基礎 | Vue

INFO

ここでcounter.jsのcountUpを見てみましょう。

const countUp = () => {
  count++
  const countElement = document.querySelector('#count')
  countElement.innerText = '回数: ' + count
}

count変数の値を変更した後に、DOM を直接操作して回数の値を更新しています。 Vue ではrefでcountのような変数を定義するだけで、「値を更新」と「表示を変更」の 2 つをセットでやってくれるようになります。

11・12 行目

ボタンが押されたイベントに対する処理を書いています。
@clickでは、今回のように直接 JavaScript を記述するだけでなく、<script setup>内で定義した関数の呼び出しもできます。

vue

<button @click="count++">クリック！</button>
<button @click="count = 0">リセット！</button>

参考: イベントへの入門 - ウェブ開発を学ぶ | MDN
参考: イベントハンドリング | Vue

TIP

v-on:click のショートハンドとして@click という書き方ができます(推奨)

5 行目

computedという機能を使って、表示するメッセージを生成します。
countの内容が変化すると自動的にcountMessageの値が更新されるようになっています。

リアクティブな値にアクセスする時、<script setup>の内部ではcount.valueのように、変数名のあとに.valueをつけてアクセスしてください。

const countMessage = computed(() => "回数: " + count.value)

参考: テンプレート構文 | Vue
参考: 算出プロパティ | Vue

今回のカウンターの全体像は以下のブランチに入っているので、参考にしてみてください。
traPtitech/naro-template-frontend at example/counter

Vue の嬉しさを実感する

いかがでしょうか？
この規模だと、ソースコードの行数としては生の HTML・JS で書いたほうが少ないですが、書く量を増やしてでも Vue を使う嬉しさがあります。

変数を操作するだけで表示が変わる

生 JS ではボタンのクリックごとに表示を変更する必要があります。
Vue ではコンポーネントの定義の時に表示と変数を関連付ける(5 行目・10 行目)ことで、変数を操作するだけで表示が自動で切り替わります。これが Vue の提供するリアクティビティです(コンポーネントが内部に保持している状態を変更したとき、その変更が Vue によって検知されて自動で HTML に反映されます)。

今回は、変数を操作する箇所が少ないのでまだ追えますが、この変数が様々なところで変更されるものだった場合を考えてみましょう。
生 HTML・JS ではその全ての場所で書き換えるコードを忘れることなく書かなければなりません。
複数のプログラマでコードを書いた場合、それを忘れないようにするということはかなりのコストになってしまうので辛いです。
Vue ではそれがなくて嬉しいです。

一度コンポーネントを登録すれば使い回せる

カウンターを 2 つ作りたくなった場合を考えます。
生 HTML・JS が書ける人はちょっとチャレンジしてみてください。関数名や変数名をかぶらないようにしたり、セレクタの名前を変更したりと結構めんどくさいです。
Vue ならば、HelloWorld.vue の<ClickCounter />をコピーして増やすだけで OK です。
これは traQ のように同じ要素を沢山利用するような Web アプリで大きな利点となります。

Vue 入門 ​

Vue テンプレートのクローン ​

Vue 入門 ​

Vue とは ​

.vueファイルについて ​

Vue の書き方 ​

Sample.vue ​

使用例 ​

プロジェクト構造 ​

index.html ​

node_modules ​

package.json package-lock.json ​

src/main.ts ​

src/App.vue ​

src/components/HelloWorld.vue ​

Vue を書く準備 ​

Vue Dev tool ​

ソースコードの書き進め方 ​

Vue を書く ​

index.html(一部抜粋) ​

counter.js ​

Vue を書く ​

ファイルの作成 ​

ソースコードの変更 ​

src/App.vue ​

src/components/HelloWorld.vue ​

src/components/ClickCounter.vue ​

ソースコード解説 ​

src/components/HelloWorld.vue ​

9~14 行目 ​

1 行目 ​

2 行目 ​

4 行目 ​

12 行目 ​

src/components/ClickCounter.vue ​

4 行目 ​

11・12 行目 ​

5 行目 ​

Vue の嬉しさを実感する ​

変数を操作するだけで表示が変わる ​

一度コンポーネントを登録すれば使い回せる ​

Vue 入門

Vue テンプレートのクローン

Vue 入門

Vue とは

`.vue`ファイルについて

Vue の書き方

Sample.vue

使用例

プロジェクト構造

`index.html`

`node_modules`

`package.json` `package-lock.json`

`src/main.ts`

`src/App.vue`

`src/components/HelloWorld.vue`

Vue を書く準備

Vue Dev tool

ソースコードの書き進め方

Vue を書く

index.html(一部抜粋)

counter.js

Vue を書く

ファイルの作成

ソースコードの変更

src/App.vue

src/components/HelloWorld.vue

src/components/ClickCounter.vue

ソースコード解説

src/components/HelloWorld.vue

9~14 行目

1 行目

2 行目

4 行目

12 行目

src/components/ClickCounter.vue

4 行目

11・12 行目

5 行目

Vue の嬉しさを実感する

変数を操作するだけで表示が変わる

一度コンポーネントを登録すれば使い回せる