Svelte 中的動態行為：變數及屬性

複製 Github 儲存庫（假如你還沒完成）如下：

git clone https://github.com/opensas/mdn-svelte-tutorial.git

接著取得當前應用程式狀態，執行如下：

cd mdn-svelte-tutorial/03-adding-dynamic-behavior

或直接下載資料夾內容如下：

npx degit opensas/mdn-svelte-tutorial/03-adding-dynamic-behavior

記得執行 npm install && npm run dev 以開發模式來運行你的應用程式。

為了使用 REPL 和我們一起撰寫程式碼，點擊如下連結：

https://svelte.dev/repl/c862d964d48d473ca63ab91709a0a5a0?version=3.23.2

目前我們的 Todos.svelte 元件只有顯示靜態標記語言，讓我們開始讓它變得更加動態。我們將從標記語言中取得任務資訊並將其儲存在 todos 陣列中。另外我們將建立兩個變數來持續追蹤任務總數及已完成的任務。

我們元件的狀態將由這三個頂層變數代表。

1. 在 src/components/Todos.svelte 的頂端建立一個 <script> 區塊並給它一些內容，如下所示：

   html

   <script>
     let todos = [
       { id: 1, name: "Create a Svelte starter app", completed: true },
       { id: 2, name: "Create your first component", completed: true },
       { id: 3, name: "Complete the rest of the tutorial", completed: false },
     ];
     let totalTodos = todos.length;
     let completedTodos = todos.filter((todo) => todo.completed).length;
   </script>
   

   現在讓我們用這些資訊做點什麼。

2. 讓我們從顯示狀態訊息開始。找到 id 為 list-heading 的 <h2> 標頭並用動態表達式替換已經寫死的現行任務及已完成任務數量：

   svelte

   <h2 id="list-heading">{completedTodos} out of {totalTodos} items completed</h2>
   

3. 回到應用程式，你應該會看到和以前一樣的「2 out of 3 items completed」訊息，但這次的資訊來自 todos 陣列。

4. 為了證明這一點，回到陣列並嘗試改變一些待辦事項物件的已完成屬性值，甚至是新增一個新的待辦事項物件。觀察訊息中的數字是如何適當地被更新。

目前我們顯示的待辦事項都是靜態的。而我們想要迭代 todos 陣列中的每個項目並為每個任務渲染其標記，讓我們馬上動手吧。

HTML 沒有表達邏輯的方式——像是條件和迴圈。但 Svelte 做到了。在這種情況下，我們使用 {#each} 指令來迭代 todos 陣列。假如有提供第二個參數，將包含當前項目的索引。此外，可以提供一個關鍵表達式，它將唯一識別每個項目。Svelte 將在資料改變時使用它來差異清單，而不是在最後新增或刪除項目，所以始終指定一個是一種好的做法。最後，可以提供 :else 區塊，它將在清單為空時呈現。

試一試吧。

1. 將現有的 <ul> 元素替換為以下的簡化版本，以了解其工作原理：

   svelte

   <ul>
   {#each todos as todo, index (todo.id)}
     <li>
       <input type="checkbox" checked={todo.completed}/> {index}. {todo.name} (id: {todo.id})
     </li>
   {:else}
     Nothing to do here!
   {/each}
   </ul>
   

2. 回到應用程式，你會看到這樣的畫面：

   

3. 現在我們已經看到這是有效的，接著讓我們使用 {#each} 指令的每個循環產生一個完整的待辦事項並在其中嵌入來自 todos 陣列中的資訊：id、name 和 completed。將現有的 <ul> 區塊替換為以下內容：

   svelte

   <!-- To-dos -->
   <ul role="list" class="todo-list stack-large" aria-labelledby="list-heading">
     {#each todos as todo (todo.id)}
     <li class="todo">
       <div class="stack-small">
         <div class="c-cb">
           <input
             type="checkbox"
             id="todo-{todo.id}"
             checked={todo.completed} />
           <label for="todo-{todo.id}" class="todo-label"> {todo.name} </label>
         </div>
         <div class="btn-group">
           <button type="button" class="btn">
             Edit <span class="visually-hidden">{todo.name}</span>
           </button>
           <button type="button" class="btn btn__danger">
             Delete <span class="visually-hidden">{todo.name}</span>
           </button>
         </div>
       </div>
     </li>
     {:else}
     <li>Nothing to do here!</li>
     {/each}
   </ul>
   

   請注意我們如何使用大括號將 JavaScript 表達式嵌入 HTML 屬性中，就像我們對勾選框的 checked 和 id 屬性所做的那樣。

我們已經將靜態標記轉為動態範本並從元件的狀態來顯示這些任務。做得好！

寫死的待辦事項清單，使我們的 Todos 元件不是那麼有用。為了將我們的元件變為一個通用的待辦事項編輯器，我們應該允許它的上層元件可以傳遞待辦事項清單以進行編輯。這將允許我們將它們儲存至網路服務或局部儲存區，便於之後將它們取回以進行更新。所以讓我們將陣列變為一個 prop。

1. 在 Todos.svelte 中，將現有的 let todos = … 區塊替換為 export let todos = []。

   js

   export let todos = [];
   

   起初這可能會讓你覺得有點奇怪。這不像在 JavaScript 模組中使用 export 的常見方式！但這就是 Svelte 透過採用有效語法並賦予其新用途藉此來「擴展」JavaScript 的作法。在這種情況下，Svelte 使用 export 關鍵字將變數宣告標記為屬性，這意味著元件的消費者可以存取它。

   你也可以為屬性指定預設初始值。如果元件的消費者沒有在元件上指定屬性時，則將使用此預設初始值——或者如果它的初始值未定義——在實例化元件時。

   因此，透過 export let todos = [] 我們告訴 Svelte 我們的 Todos.svelte 元件將可接受一個 todos 屬性，而當省略該屬性時，它將被初始化為一個空陣列。

2. 回頭看看應用程式，你將會看到「Nothing to do here!」訊息。這是因為我們目前沒有從 App.svelte 向它傳遞任何數值，所以它使用預設值。

3. 現在讓我們將待辦事項移動到 App.svelte 並將它們作為屬性傳遞給 Todos.svelte 元件。更新 src/App.svelte 如下：

   svelte

   <script>
     import Todos from "./components/Todos.svelte";
   
     let todos = [
       { id: 1, name: "Create a Svelte starter app", completed: true },
       { id: 2, name: "Create your first component", completed: true },
       { id: 3, name: "Complete the rest of the tutorial", completed: false }
     ];
   </script>
   
   <Todos todos={todos} />
   

4. 當屬性和變數具有相同名稱時，Svelte 允許你僅指定變數作為便利的捷徑，因此我們可以像這樣重寫最後一行。現在試試吧。

   svelte

   <Todos {todos} />
   

此時，你的待辦事項呈現應該如同以往，除了現在我們是從 App.svelte 元件來傳遞它們之外。

讓我們新增一些功能性來切換任務狀態。Svelte 具有用於監聽 DOM 事件的 on:eventname 指令。讓我們為勾選框的 on:click 事件新增一個處理器來切換已完成的數值。

1. 更新 src/components/Todos.svelte 中的 <input type="checkbox"> 元素，如下：

   svelte

   <input type="checkbox" id="todo-{todo.id}"
     on:click={() => todo.completed = !todo.completed}
     checked={todo.completed}
   />
   

2. 接下來我們將新增一個函式來從我們的 todos 陣列中刪除一個待辦事項。在 Todos.svelte 中 <script> 區塊的底部，新增 removeTodo() 函式，如下：

   js

   function removeTodo(todo) {
     todos = todos.filter((t) => t.id !== todo.id);
   }
   

3. 我們將透過 Delete 按鈕呼叫它。更新 click 事件，如下：

   svelte

   <button type="button" class="btn btn__danger"
     on:click={() => removeTodo(todo)}
   >
     Delete <span class="visually-hidden">{todo.name}</span>
   </button>
   

   Svelte 中處理器的一個常見錯誤是將執行函式的結果作為處理器傳遞，而不是傳遞函式。舉例來說，假如你指定 on:click={removeTodo(todo)}，它會執行 removeTodo(todo) 並把結果作為處理器傳遞，但這不是我們要的。

   在這種情況下，你必須指定 on:click={() => removeTodo(todo)} 作為處理器。如果 removeTodo() 沒有接收參數，你可以使用 on:event={removeTodo}，但不能使用 on:event={removeTodo()}。這並不是 Svelte 中的特殊語法——這裡我們只是使用常規的 JavaScript 箭頭函式。

這是不錯的進展——此時，我們現在能刪除任務了。當一個待辦事項的 Delete 按鈕被按下時，相關的待辦事項會從 todos 陣列中被移除並且更新使用者介面讓它不再顯示。此外，我們現在能勾選勾選框，相關待辦事項的已完成狀態將在 todos 陣列中被更新。

然而，「x out of y items completed」標頭並未被更新。繼續閱讀以了解為什麼會發生這種情況以及我們如何解決它。

正如我們所看到的，每次元件頂層變數的數值被修改時，Svelte 都知道如何更新使用者介面。在我們的應用程式中，每次切換或刪除待辦事項時都會直接地更新 todos 陣列數值，所以 Svelte 會自動地更新 DOM。

然而，對於 totalTodos 和 completedTodos 來說情況並非如此。在下面的程式碼中，當元件被實例化且腳本被執行時，它們會被指定一個數值，但是在那之後，它們的數值不會被改變：

let totalTodos = todos.length;
let completedTodos = todos.filter((todo) => todo.completed).length;

我們可以在切換和刪除待辦事項後重新計算它們，但有一種更簡單的方式可以做到。

可以告訴 Svelte 我們想要 totalTodos 和 completedTodos 等變數藉由前綴 $:，使其具有反應性。Svelte 將產生程式碼以在它們相依的資料發生變化時自動更新它們。

更新 src/components/Todos.svelte 中的 totalTodos 和 completedTodos 變數定義，如下：

$: totalTodos = todos.length;
$: completedTodos = todos.filter((todo) => todo.completed).length;

如果你現在檢查你的應用程式，當待辦事項完成或被刪除時，你將會看到標頭的數字被更新。做得好！

Svelte 編譯器在背後會解析和分析我們的程式碼以產生相依樹，接著它會產生 JavaScript 程式碼以在其中一個相依項目被更新時，來重新評估每個反應性陳述。Svelte 的反應性以非常輕量和高性能的方式來實現，無須使用監聽器（listener）、設定器（setter）、取得器（getter）或任何其它複雜的機制。

目前此文章的下一個主要任務——讓我們新增一些功能性來加入新的待辦事項。

1. 首先，我們將建立一個變數來保存新待辦事項的文字。將此宣告新增到 Todos.svelte 檔案的 <script> 區塊中：

   js

   let newTodoName = "";
   

2. 我們將使用 <input> 中的數值來加入新任務。為此我們需要將 newTodoName 變數綁定到 todo-0 輸入框，以便 newTodoName 變數數值與輸入框的 value 屬性保持同步。我們可以這樣做：

   svelte

   <input value={newTodoName} on:keydown={(e) => newTodoName = e.target.value} />
   

   每當變數 newTodoName 的數值發生變化時，它將被反映在 value 輸入框的屬性中且每當在輸入框按下某個鍵時，我們將會更新變數 newTodoName 的內容。

   這是對輸入框雙向資料綁定的手動實作。但是我們不需要這樣做—— Svelte 提供了一種更簡單的方式來將任何屬性綁定到變數，使用 bind:property 指令：

   svelte

   <input bind:value={newTodoName} />
   

   所以，讓我們來實作它。更新 todo-0 輸入框如下：

   svelte

   <input
     bind:value={newTodoName}
     type="text"
     id="todo-0"
     autocomplete="off"
     class="input input__lg" />
   

3. 測試是否有效的一個簡單方式是新增一個反應性陳述來記錄 newTodoName 的內容。在 <script> 區塊的末端新增此程式碼片段：

   js

   $: console.log("newTodoName: ", newTodoName);
   

   备注： 你可能已經注意到了，反應性陳述不僅限於變數宣告。你可以在 $: 符號之後放上 任何 JavaScript 陳述。

4. 現在嘗試回到 localhost:5042，按下 Ctrl + Shift + K 來打開瀏覽器控制台並在輸入框中輸入一些內容。你應該就會看到你的輸入被記錄了。此時，你可以視情況刪除反應性 console.log()。

5. 接下來，我們將建立一個函式來加入新的待辦事項—— addTodo() ——它會將一個新的 todo 物件塞入到 todos 陣列中。將此函式新增到 src/components/Todos.svelte 中 <script> 區塊的底部：

   js

   function addTodo() {
     todos.push({ id: 999, name: newTodoName, completed: false });
     newTodoName = "";
   }
   

   备注： 目前我們為每個待辦事項都指定相同的 id，別擔心，我們會盡快解決這個問題。

6. 現在我們要更新我們的 HTML，以便每當表單被提交時來呼叫 addTodo()。更新新增待辦事項（NewTodo）表單的起始標籤如下：

   svelte

   <form on:submit|preventDefault={addTodo}>
   

   on:eventname 指令支援使用 | 字元向 DOM 事件加入修飾詞（modifier）。在這種情況下，preventDefault 修飾詞告訴 Svelte 在運行處理器之前，產生呼叫 event.preventDefault() 的程式碼。瀏覽前一個連結以查看其它可以用的修飾詞有哪些。

7. 假如你現在嘗試加入新的待辦事項，新的待辦事項會被加入到待辦事項陣列中，但我們的使用者介面不會被更新。記住在 Svelte 中反應性是由指定來觸發。這意味著 addTodo() 函式被執行，元素被新增到 todos 陣列中，但 Svelte 不會檢測到推入（push）方法修改了陣列，所以它也不會刷新任務 <ul>。

   只要將 todos = todos 新增到 addTodo() 函式的末端就能解決這個問題，但是必須在函式末端包含它似乎很奇怪。取而代之，我們將拿掉 push() 方法並使用展開語法來達到相同的結果：我們將為 todos 陣列指定一個等於 todos 陣列加上新物件的數值。

   备注： 陣列（Array）有幾個可變的操作：push()、pop()、splice()、shift()、unshift()、reverse() 和 sort()。使用它們常會導致難以追蹤的副作用和錯誤。透過使用展開語法而不是 push()，我們可以避免改變陣列本身，這被認為是一種好的做法。

   更新你的 addTodo() 函式如下：

   js

   function addTodo() {
     todos = [...todos, { id: 999, name: newTodoName, completed: false }];
     newTodoName = "";
   }
   

如果現在嘗試在你的應用程式中加入新的待辦事項，你將可以加入新的待辦事項並讓它出現在使用者介面中——一次。假如你嘗試第二次，它將無作用並且你會得到一條控制台訊息「Error: Cannot have duplicate keys in a keyed each」。看起來我們的待辦事項需要唯一的 ID。

1. 讓我們宣告一個由待辦事項數量加 1 計算得出的 newTodoId 變數並使其具有反應性。將以下程式碼片段新增到 <script> 區塊：

   js

   let newTodoId;
   $: {
     if (totalTodos === 0) {
       newTodoId = 1;
     } else {
       newTodoId = Math.max(...todos.map((t) => t.id)) + 1;
     }
   }
   

   备注： 如你所見，反應性陳述不僅限於單行。以下程式碼也有作用，但可讀性較差：$: newTodoId = totalTodos ? Math.max(...todos.map((t) => t.id)) + 1 : 1

2. Svelte 是如何做到這一點的？編譯器會解析整個反應性陳述並檢測到它依賴於 totalTodos 變數和 todos 陣列。所以每當它們中任何一個被修改時，都會重新評估程式碼並相應地更新 newTodoId。

   讓我們在 addTodo() 函式中使用它。像這樣更新它：

   js

   function addTodo() {
     todos = [...todos, { id: newTodoId, name: newTodoName, completed: false }];
     newTodoName = "";
   }
   

在本篇文章的最後，讓我們來實現藉由狀態過濾待辦事項的功能。我們將建立一個變數來保存目前的過濾器，以及一個回傳過濾完的待辦事項輔助函式。

1. 在我們的 <script> 區塊的底部新增以下內容：

   js

   let filter = "all";
   const filterTodos = (filter, todos) =>
     filter === "active"
       ? todos.filter((t) => !t.completed)
       : filter === "completed"
         ? todos.filter((t) => t.completed)
         : todos;
   

   我們使用 filter 變數來控制目前的過濾器：all、active、completed。只要將這些數值中其中一個指定給過濾器變數即可使用該過濾器並更新待辦事項清單。讓我們看看它如何做到這一點。

   filterTodos() 函式將接收目前的過濾器和待辦事項清單並回傳過濾完的新待辦事項陣列。

2. 讓我們更新過濾器按鈕標記以使其動態化，當使用者按下其中一個過濾器按鈕時，更新目前的過濾器。像這樣更新它：

   svelte

   <div class="filters btn-group stack-exception">
     <button class="btn toggle-btn" class:btn__primary={filter === 'all'} aria-pressed={filter === 'all'} on:click={() => filter = 'all'} >
       <span class="visually-hidden">Show</span>
       <span>All</span>
       <span class="visually-hidden">tasks</span>
     </button>
     <button class="btn toggle-btn" class:btn__primary={filter === 'active'} aria-pressed={filter === 'active'} on:click={() => filter = 'active'} >
       <span class="visually-hidden">Show</span>
       <span>Active</span>
       <span class="visually-hidden">tasks</span>
     </button>
     <button class="btn toggle-btn" class:btn__primary={filter === 'completed'} aria-pressed={filter === 'completed'} on:click={() => filter = 'completed'} >
       <span class="visually-hidden">Show</span>
       <span>Completed</span>
       <span class="visually-hidden">tasks</span>
     </button>
   </div>
   

   而這個標記當中發生了幾件事。

   我們透過將 btn__primary 類別套用於過濾器按鈕來顯示目前使用中的過濾器。為了有條件地將樣式類別套用於元素上，我們使用 class:name={value} 指令。如果數值表達式的計算結果為真，則類別名稱將會被套用。你可以將許多不同條件的指令塞到同一個元素上。所以當我們寫為 class:btn__primary={filter === 'all'} 時，假如過濾器（filter）變數等於 all，Svelte 將會套用 btn__primary 類別。

   备注： Svelte 提供了一個便利的捷徑，允許我們在類別與變數名稱相同時，可以將 <div class:active={active}> 縮短為 <div class:active>。

   aria-pressed={filter === 'all'} 也是類似的情況：當在大括號之間被傳入的 JavaScript 表達式的計算結果為真時，aria-pressed 屬性將被加入到按鈕上。

   每當我們點擊按鈕時，我們藉由發出 on:click={() => filter = 'all'} 來更新過濾器變數。繼續閱讀以了解 Svelte 反應性將如何處理其餘部分。

3. 現在我們只需要在 {#each} 迴圈中使用輔助函式；像這樣更新它：

   svelte

   …
     <ul role="list" class="todo-list stack-large" aria-labelledby="list-heading">
     {#each filterTodos(filter, todos) as todo (todo.id)}
   …
   

   在分析我們的程式碼後，Svelte 檢測到我們的 filterTodos() 函式依賴於變數 filter 和 todos。而就像嵌入在標記中的任何其它動態表達式一樣，每當這些依賴發生變化時，DOM 都會相應地更新。所以每當 filter 或 todos 發生變化時，filterTodos() 函式將會重新評估並更新迴圈內的項目。

若想要看到本文結束後程式碼所呈現的最終結果，你可以參照下列的方式存取我們已經複製下來的儲存庫：

cd mdn-svelte-tutorial/04-componentizing-our-app

或直接下載資料夾內容：

npx degit opensas/mdn-svelte-tutorial/04-componentizing-our-app

記得執行 npm install && npm run dev 以開發模式來運行你的應用程式。

若要在 REPL 看見當前程式碼狀態，請點擊如下連結：

https://svelte.dev/repl/99b9eb228b404a2f8c8959b22c0a40d3?version=3.23.2

截至目前為止做得好！在本篇文章中，我們已經實現了大部分想要的功能。我們的應用程式可以顯示、新增和刪除待辦事項，切換其完成狀態、顯示已完成的數量和使用多個過濾器。

回顧一下，我們涵蓋了以下主題：

• 建立和使用元件
• 轉換靜態標記為動態範本
• 在標記語言嵌入 JavaScript 表達式
• 使用 {#each} 指令迭代清單
• 透過屬性在元件之間傳遞資訊
• 監聽 DOM 事件
• 宣告反應性陳述
• 使用 console.log() 和反應性陳述進行基本偵錯
• 使用 bind:property 指令綁定 HTML 屬性
• 透過指定觸發反應性
• 使用反應性表達式過濾資料
• 明確定義我們的反應依賴關係

在下一篇文章中，我們將新增更多功能，允許使用者編輯待辦事項。

• 前頁
• 概述：理解 JavaScript 前端框架
• 次頁