Vue內容分發slot - xiaohuochai－IT工程師數位筆記本

文章出處

前面的話

為了讓組件可以組合，需要一種方式來混合父組件的內容與子組件自己的模板。這個過程被稱為 內容分發 (或 “transclusion” )。Vue實現了一個內容分發 API，參照了當前 Web 組件規范草案，使用特殊的 <slot> 元素作為原始內容的插槽。本文將詳細介紹Vue內容分發slot

編譯作用域

　　在深入內容分發 API 之前，先明確內容在哪個作用域里編譯。假定模板為

<child-component>
  {{ message }}
</child-component>

　　message 應該綁定到父組件的數據，還是綁定到子組件的數據？答案是父組件。組件作用域簡單地說是：父組件模板的內容在父組件作用域內編譯；子組件模板的內容在子組件作用域內編譯。

　　一個常見錯誤是試圖在父組件模板內將一個指令綁定到子組件的屬性/方法：

<!-- 無效 -->
<child-component v-show="someChildProperty"></child-component>

　　假定someChildProperty是子組件的屬性，上例不會如預期工作。父組件模板不應該知道子組件的狀態

　　如果要綁定作用域內的指令到一個組件的根節點，應當在組件自己的模板上做：

Vue.component('child-component', {
  // 有效，因為是在正確的作用域內
  template: '<div v-show="someChildProperty">Child</div>',
  data: function () {
    return {
      someChildProperty: true
    }
  }
})

　　類似地，分發內容是在父作用域內編譯

默認丟棄

一般地，如果子組件模板不包含<slot>插口，父組件的內容將會被丟棄

var parentNode = {
  template: `
  <div class="parent">
    <p>父組件</p>
    <child>
      <p>測試內容</p>
    </child>
  </div>
  `,
  components: {
    'child': childNode
  },
};

<div id="example">
  <parent></parent>
</div>
<script src="https://unpkg.com/vue"></script>
<script>
var childNode = {
  template: `
  <div class="child">
    <p>子組件</p>
  </div>
  `,
};
var parentNode = {
  template: `
  <div class="parent">
    <p>父組件</p>
    <child>
      <p>測試內容</p>
    </child>
  </div>
  `,
  components: {
    'child': childNode
  },
};
// 創建根實例
new Vue({
  el: '#example',
  components: {
    'parent': parentNode
  }
})
</script>

如下圖所示，<child>所包含的測試內容被丟棄

內聯模板

　　如果子組件有 inline-template 特性，組件將把它的內容當作它的模板，而忽略真實的模板內容

　　但是 inline-template 讓模板的作用域難以理解

var childNode = {
  template: `
  <div class="child">
    <p>子組件</p>
  </div>
  `,
};

var parentNode = {
  template: `
  <div class="parent">
    <p>父組件</p>
    <child inline-template>
      <p>測試內容</p>
    </child>
  </div>
  `,
  components: {
    'child': childNode
  },
};

匿名slot

　　當子組件模板只有一個沒有屬性的 slot 時，父組件整個內容片段將插入到 slot 所在的 DOM 位置，并替換掉 slot 標簽本身

var childNode = {
  template: `
  <div class="child">
    <p>子組件</p>
    <slot></slot>
  </div>
  `,
};

var parentNode = {
  template: `
  <div class="parent">
    <p>父組件</p>
    <child>
      <p>測試內容</p>
    </child>
  </div>
  `,
  components: {
    'child': childNode
  },
};

　　如果出現多于1個的匿名slot，vue將報錯

var childNode = {
  template: `
  <div class="child">
    <p>子組件</p>
    <slot></slot>
    <slot></slot>
  </div>
  `,
};

【默認值】

最初在 <slot> 標簽中的任何內容都被視為備用內容，或者稱為默認值。備用內容在子組件的作用域內編譯，并且只有在宿主元素為空，且沒有要插入的內容時才顯示備用內容

當slot存在默認值，且父元素在<child>中沒有要插入的內容時，顯示默認值

var childNode = {
  template: `
  <div class="child">
    <p>子組件</p>
    <slot><p>我是默認值</p></slot>
  </div>
  `,
};
var parentNode = {
  template: `
  <div class="parent">
    <p>父組件</p>
    <child></child>
  </div>
  `,
  components: {
    'child': childNode
  },
};

當slot存在默認值，且父元素在<child>中存在要插入的內容時，則顯示設置值

var childNode = {
  template: `
  <div class="child">
    <p>子組件</p>
    <slot><p>我是默認值</p></slot>
  </div>
  `,
};
var parentNode = {
  template: `
  <div class="parent">
    <p>父組件</p>
    <child>
      <p>我是設置值</p>
    </child>
  </div>
  `,
  components: {
    'child': childNode
  },
};

具名Slot

<slot> 元素可以用一個特殊的屬性 name 來配置如何分發內容。多個 slot 可以有不同的名字。具名 slot 將匹配內容片段中有對應 slot 特性的元素

var childNode = {
  template: `
  <div class="child">
    <p>子組件</p>
    <slot name="my-header">頭部默認值</slot>
    <slot name="my-body">主體默認值</slot>
    <slot name="my-footer">尾部默認值</slot>
  </div>
  `,
};

var parentNode = {
  template: `
  <div class="parent">
    <p>父組件</p>
    <child>
      <p slot="my-header">我是頭部</p>
      <p slot="my-footer">我是尾部</p>
    </child>
  </div>
  `,
  components: {
    'child': childNode
  },
};

　　仍然可以有一個匿名 slot，它是默認 slot，作為找不到匹配的內容片段的備用插槽。匿名slot只能作為沒有slot屬性的元素的插槽，有slot屬性的元素如果沒有配置slot，則會被拋棄

var childNode = {
  template: `
  <div class="child">
    <p>子組件</p>
    <slot name="my-body">主體默認值</slot>
    <slot></slot>
  </div>
  `,
};

var parentNode = {
  template: `
  <div class="parent">
    <p>父組件</p>
    <child>
      <p slot="my-body">我是主體</p>
      <p>我是其他內容</p>
      <p slot="my-footer">我是尾部</p>
    </child>
  </div>
  `,
  components: {
    'child': childNode
  },
};

插入<slot name="my-body">中，我是其他內容插入<slot>中，而被丟棄

　　如果沒有默認的 slot，這些找不到匹配的內容片段也將被拋棄

var childNode = {
  template: `
  <div class="child">
    <p>子組件</p>
    <slot name="my-body">主體默認值</slot>
  </div>
  `,
};

var parentNode = {
  template: `
  <div class="parent">
    <p>父組件</p>
    <child>
      <p slot="my-body">我是主體</p>
      <p>我是其他內容</p>
      <p slot="my-footer">我是尾部</p>
    </child>
  </div>
  `,
  components: {
    'child': childNode
  },
};

我是其他內容和都被拋棄

作用域插槽

　　作用域插槽是一種特殊類型的插槽，用作使用一個 (能夠傳遞數據到) 可重用模板替換已渲染元素。

　　在子組件中，只需將數據傳遞到插槽，就像將 props 傳遞給組件一樣

<div class="child">
  <slot text="hello from child"></slot>
</div>

在父級中，具有特殊屬性 scope 的 <template> 元素必須存在，表示它是作用域插槽的模板。scope 的值對應一個臨時變量名，此變量接收從子組件中傳遞的 props 對象

var childNode = {
  template: `
  <div class="child">
    <p>子組件</p>
      <slot xxx="hello from child"></slot>
  </div>
  `,
};
var parentNode = {
  template: `
  <div class="parent">
    <p>父組件</p>
    <child>
      <template scope="props">
        <p>hello from parent</p>
        <p>{{ props.xxx }}</p>
      </template>
    </child>
  </div>
  `,
  components: {
    'child': childNode
  },
};

　　如果渲染以上結果，得到的輸出是

【列表組件】

　　作用域插槽更具代表性的用例是列表組件，允許組件自定義應該如何渲染列表每一項

var childNode = {
  template: `
  <ul>
    <slot name="item" v-for="item in items" :text="item.text">默認值</slot>
  </ul>
  `,
  data(){
    return{
      items:[
        {id:1,text:'第1段'},
        {id:2,text:'第2段'},
        {id:3,text:'第3段'},
      ]
    }
  }
};

var parentNode = {
  template: `
  <div class="parent">
    <p>父組件</p>
    <child>
      <template slot="item" scope="props">
        <li>{{ props.text }}</li>
      </template>
    </child>
  </div>
  `,
  components: {
    'child': childNode
  },
};