「譯」一個案例搞懂 Vue.js 的作用域插槽

• 原文地址：Getting Your Head Around Vue.js Scoped Slots
• 原文作者：Anthony Gore
• 譯者：Chor

作用域插槽是 Vue.js 中一個很有用的特性，可以顯著提高元件的通用性和可複用性。問題在於，它實在不太好理解。嘗試搞清楚父子作用域之間錯綜複雜的關係，其痛苦程度不亞於求解一個棘手的數學方程。

當你無法理解一個東西的時候，最好的辦法就是在解決問題的過程中體會它的應用。本文將向你展示如何使用作用域插槽構建一個可複用的列表元件。

注意: 完整程式碼可以去 Codepen 檢視

最基礎的元件

我們即將構建的元件叫做 my-list ，用來展示一系列的專案。它的特別之處就在於，你可以在每次使用元件的時候自定義列表專案的渲染方式。

我們先從最簡單的單個列表開始：一個包含幾何圖形名字和邊數的陣列。

app.js

Vue.component('my-list', {
  template: '#my-list',
  data() {
    return {
      title: 'Shapes',
      shapes: [ 
        { name: 'Square', sides: 4 }, 
        { name: 'Hexagon', sides: 6 }, 
        { name: 'Triangle', sides: 3 }
      ]
    };
  }
});

new Vue({
  el: '#app'
});

index.html

<div id="app">
  <my-list></my-list>
</div>

<script type="text/x-template" id="my-list">
  <div class="my-list">
    <div class="title">{{ title }}</div>
    <div class="list">
      <div class="list-item" v-for="shape in shapes">
        <div>{{ shape.name }} <small>({{ shape.sides }} sides)</small></div>
      </div>
    </div>
  </div>
</script>

在加上一點樣式，大概就會是下圖這個樣子：

更通用的 my-list

現在我們想要讓 my-list 更加通用，可以渲染任何型別的列表。這次我們展示的是一堆顏色的名字以及對應的顏色方塊。

為此，我們需要將上例列表獨有的資料進行抽象化。由於列表中的專案可能有不同的結構，我們將會給 my-list 一個插槽，讓父元件來定義列表的展示方式。

app.js

Vue.component('my-list', {
  template: '#my-list',
  props: [ 'title' ]
});

index.html

<script type="text/x-template" id="my-list">
  <div class="my-list">
    <div class="title">{{ title }}</div>
    <div class="list">
      <slot></slot>
    </div>
  </div>
</script>

現在，我們在根例項中建立 my-list 元件的兩個例項，分別展示兩個測試用例列表：lists:

app.js

new Vue({
  el: '#app',
  data: {
    shapes: [ 
      { name: 'Square', sides: 4 }, 
      { name: 'Hexagon', sides: 6 }, 
      { name: 'Triangle', sides: 3 }
    ],
    colors: [
      { name: 'Yellow', hex: '#F4D03F', },
      { name: 'Green', hex: '#229954' },
      { name: 'Purple', hex: '#9B59B6' }
    ]
  }
});

<div id="app">
  <my-list :title="Shapes">
    <div class="list-item" v-for="item in shapes">
      <div>{{ shape.name }} <small>({{ shape.sides }} sides)</small></div>
    </div>
  </my-list>
  <my-list :title="Colors">
    <div class="list-item" v-for="color in colors">
      <div>
        <div class="swatch" :style="{ background: color.hex }"></div>
        {{ color.name }}
      </div>
    </div>
  </my-list>
</div>

效果如下圖：

大材小用的元件

我們剛才建立的元件確實符合要求，但那段程式碼算不上很好。my-list 本來應該是一個展示列表的元件，但我們卻把渲染列表需要的邏輯部分抽象到了父元件中，這樣一來，子元件在這裡只不過是用來包裹列表而已，未免顯得大材小用了。

更糟糕的是，在兩個元件的宣告中存在著大量重複程式碼（例如，<div class="list-item" v-for="item in ...">）。如果我們能夠在子元件中編寫這些程式碼，那麼子元件就不再是“打醬油的角色”了。

作用域插槽

普通插槽無法滿足我們的需求，這時候，作用域插槽就派上用場了。作用域插槽允許你傳遞一個模板而不是已經渲染好的元素給插槽。之所以叫做”作用域“插槽，是因為模板雖然是在父級作用域中渲染的，卻能拿到子元件的資料。

例如，帶有作用域插槽的元件 child 大概是下面這個樣子：

<div>
  <slot my-prop="Hello from child"></slot>
</div>

使用這個元件的父元件將會在插槽中宣告一個 template 元素。這個模板元素會有一個 scope （譯者注：Vue 2.6 後改為 v-slot 屬性）屬性指向一個物件，任何新增到插槽（位於子元件模板）中的屬性都會作為這個物件的屬性。

<child>
  <template scope="props">
    <span>Hello from parent</span>
    <span>{{ props.my-prop }}</span>
  </template>
</child>

將會渲染成：

<div>
  <span>Hello from parent</span>
  <span>Hello from child</span>
</div>

在 my-list 中使用作用域插槽

我們將兩個列表陣列通過 props 傳遞給 my-list。之後將普通插槽替換為作用域插槽，這樣，my-list 就能夠負責迭代列表專案，同時父元件依然能夠定義每個專案具體的展示方式。

index.html

<div id="app">
  <my-list title="Shapes" :items="shapes">
    <!--在這裡書寫 template-->
  </my-list>
  <my-list title="Colors" :items="colors">
    <!--在這裡書寫 template-->
  </my-list>   
</div>

接著我們讓 my-list 迭代專案。在 v-for 迴圈中，item 是當前迭代專案的別名。我們可以建立一個插槽並通過 v-bind="item" 將那個專案繫結到插槽中。

app.js

Vue.component('my-list', {
  template: '#my-list',
  props: [ 'title', 'items' ]
});

index.html

<script type="text/x-template" id="my-list">
  <div class="my-list">
    <div class="title">{{ title }}</div>
    <div class="list">
      <div v-for="item in items">
        <slot v-bind="item"></slot>
      </div>
    </div>
  </div>
</script>

注意：也許你之前沒見過不帶引數的 v-bind 用法。這種用法將會把整個物件的所以屬性都繫結到當前元素上。在涉及作用域插槽時，這種用法很常見，因為繫結的物件可能有很多屬性，而一一將它們列舉出來並手動繫結顯然太麻煩了。

現在，回到根例項這裡來，在 my-list 的插槽中宣告一個模板。首先看一下幾何圖形列表（第一個例子中的列表），我們宣告的模板必須帶有一個 scope 屬性，這裡將其賦值為 shape。shape 這個別名可以讓我們訪問作用域插槽。在模板中，我們可以繼續沿用最初例子中的標記來展示專案。

<my-list title="Shapes" :items="shapes">
  <template scope="shape">
    <div>{{ shape.name }} <small>({{ shape.sides }} sides)</small></div>
  </template>
</my-list>

整個模板大概是下面這樣：

<div id="app">
  <my-list title="Shapes" :items="shapes">
    <template scope="shape">
      <div>{{ shape.name }} <small>({{ shape.sides }} sides)</small></div>
    </template>
  </my-list>
  <my-list title="Colors" :items="colors">
    <template scope="color">
      <div>
        <div class="swatch" :style="{ background: color.hex }"></div>
        {{ color.name }}
      </div>
    </template>
  </my-list>   
</div>

結論

雖然用上作用域插槽之後，程式碼量並未減少，但是我們將通用的功能都交由子元件負責，這顯著提高了程式碼的健壯性。

完整程式碼的 Codepen 在這裡：

https://codepen.io/anthonygor...

譯者注： Vue.js 2.6.0 之後將 slot-scope 改為 v-slot