TypeScriptの組み立てかた
1. はじめに
現在、TypeScriptの勉強をしている新米エンジニアです。
学習内容をアウトプットし、自分の理解を整理することを目的に本記事を書くことにしました。
今回はTODOアプリを題材にDOM取得・型定義・状態管理・描画・イベント処理を用いてTypeScriptの基本的な組み立て方についてまとめてみました。
2. HTMLテンプレート
index.htmlを作成。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<div id="title">TypeScriptの組み立てかた</div>
<ul id="list" class="list"></ul>
<input id="input" class="input" type="text">
<button id="button" class="button" type="button">ボタン</button>
<script type="module" src="./index.js"></script>
</body>
</html>
HTMLから要素を取得する方法は複数ありますが、今回はidから要素を取得したいと思います。
idを記載することで、後に実装する処理でDOM操作ができます。
3. TypeScriptファイル作成 & DOM取得
index.tsを作成し、HTMLの各要素を取得する。
const list = document.getElementById('list') as HTMLUListElement;
const input = document.getElementById('input') as HTMLInputElement;
const button = document.getElementById('button') as HTMLButtonElement;
document.getElementByIdだけでは型がHTMLElement | nullになり、各要素固有のプロパティにアクセスできません。
as HTMLXxxElementを付けることで、各要素専用の型として扱えるようになります。
| 要素 | 型 | 使用できるプロパティ例 |
|---|---|---|
| ul | HTMLUListElement | innerHTML |
| input | HTMLInputElement | value, checked |
| button | HTMLButtonElement | disabled |
4. 型定義
扱うデータの形をinterfaceで定義する。
interface Todo {
id: string;
text: string;
done: boolean;
}
interfaceを使う理由は、データの構造をあらかじめ決めておくことで、
プロパティの追加漏れや型の間違いをコンパイル時に検知するためです。
| プロパティ | 型 | 理由 |
|---|---|---|
| id | string | Date.now()を文字列化して使用するため |
| text | string | 入力テキストをそのまま格納するため |
| done | boolean | 完了/未完了の2択のみのため |
5. 格納先、定義
Todoデータを格納する配列を定義する。
let todos: Todo[] = []
Todo[]とすることで、Todo型のオブジェクトのみを格納できる配列として定義しています。
初期値を空配列にしている理由は、何も入力していない状態=何も表示されない状態をそのまま表現するためです。
letにしている理由は、削除処理でfilterを使い新しい配列を再代入するためです。
6. 描画関数 実装
todosの状態を画面に反映する関数を実装する。
function render(): void {
list.innerHTML = '';
const html = todos.map((todo) => {
return `<li>
<input type="checkbox" data-id="${todo.id}" ${todo.done ? 'checked' : ''}>
<span>${todo.text}</span>
<button data-id="${todo.id}">削除</button>
</li>`
}).join('')
list.innerHTML = html;
}
一旦innerHTMLを空にしてから再生成している理由は、todosの状態とDOM表示を常に一致させるため。
差分だけ更新する方法もありますが、全体を作り直すことで状態のズレを防ぐ実装にしています。
innerHTMLを使っている理由は、ulは表示要素のためです。
7. タスク処理関数 実装
追加・削除・完了の3つの処理を実装する。
// 追加処理
button.addEventListener('click', () => {
const text = input.value;
const newTodo: Todo = {
id: Date.now().toString(),
text: text,
done: false
}
todos.push(newTodo);
input.value = '';
render();
})
// 削除処理
list.addEventListener('click', (e) => {
const target = e.target as HTMLElement
if (target.tagName === 'BUTTON') {
const id = target.dataset.id
todos = todos.filter(todo => todo.id !== id)
render()
}
})
// 完了処理
list.addEventListener('change',(e) => {
const target = e.target as HTMLInputElement
if (target.type === 'checkbox') {
const id = target.dataset.id
const todo = todos.find(t => t.id === id)
if (todo) {
todo.done = !todo.done
}
render()
}
})
削除・完了処理でlistの親要素にイベントを登録している理由は、render()のたびに動的に生成される要素には直接addEventListenerを登録できないため。
親要素にイベントを1つ登録し、e.targetでどの要素が操作されたかを判定する(イベント委任)。
8. JS生成 & サーバー起動
下記コマンドを順に実行する。
# TSをコンパイルしてJS生成
tsc index.ts
# serveパッケージが入っていない場合は、下記をインストール。
npm install -g serve
# ローカルサーバー起動
npx serve .
tsc index.tsを実行するとindex.jsが生成される。
HTMLの<script src="./index.js">で読み込んでいるのはこのファイル。
ブラウザはTSを直接実行できないため、JSに変換してから起動する。
TSコード全体
const list = document.getElementById('list') as HTMLUListElement;
const input = document.getElementById('input') as HTMLInputElement;
const button = document.getElementById('button') as HTMLButtonElement;
interface Todo {
id: string;
text: string;
done: boolean;
}
let todos: Todo[] = []
button.addEventListener('click', () => {
const text = input.value;
const newTodo: Todo = {
id: Date.now().toString(),
text: text,
done: false
}
todos.push(newTodo);
input.value = '';
render();
})
function render(): void {
list.innerHTML = '';
const html = todos.map((todo) => {
return `<li>
<input type="checkbox" data-id="${todo.id}" ${todo.done ? 'checked' : ''}>
<span>${todo.text}</span>
<button data-id="${todo.id}">削除</button>
</li>`
}).join('')
list.innerHTML = html;
}
list.addEventListener('click', (e) => {
const target = e.target as HTMLElement
if (target.tagName === 'BUTTON') {
const id = target.dataset.id
todos = todos.filter(todo => todo.id !== id)
render()
}
})
list.addEventListener('change',(e) => {
const target = e.target as HTMLInputElement
if (target.type === 'checkbox') {
const id = target.dataset.id
const todo = todos.find(t => t.id === id)
if (todo) {
todo.done = !todo.done
}
render()
}
})
9. まとめ
本記事で実装したTypeScriptの基本的な構成は下記の流れになります。
- DOM要素を取得する
- 型を定義する(interface)
- 状態(データ)を用意する
- 描画関数を作る
- イベントを登録する
この構成を意識することで、データとDOMの関係を整理しながら実装できます。
実務では、DOM取得・型定義・関数などをファイルごとに分割して管理・実装することが多いです。
本記事は1ファイルで完結する構成としていますが、規模が大きくなる場合はファイル分割を検討することをおすすめします。
ここまで読んでいただき、ありがとうございました!