如果你在 vue3 開發(fā)中使用了 <script setup> 語(yǔ)法的話，對(duì)于組件的 name 屬性，需要做一番額外的處理。
對(duì)于 [email protected] 及以上版本，在使用 <script setup> 的單文件組件時(shí)，vue 會(huì)根據(jù)組件文件名，自動(dòng)推導(dǎo)出 name 屬性。也就是名為 MyComponent.vue 或 my-component.vue 的文件， name 屬性為 MyComponent，而當(dāng)你在組件內(nèi)顯示定義 name 屬性時(shí)，會(huì)覆蓋推導(dǎo)出的名稱。
組件的 name 屬性不僅能用于 <KeepAlive>，而且在使用 vuejs-devtools 插件調(diào)試代碼的時(shí)候，對(duì)應(yīng)組件也能顯示出其 name 屬性，方便我們快速定位代碼和調(diào)試。顯示的定義 name 屬性，是一個(gè)好習(xí)慣。
除此之外，如果我們要在 <script setup> 顯示定義 name 屬性，需要額外添加一個(gè) script，也就是：
<script>
export default {
name: "MyComponent"
}
</script>
<script setup lang="ts">
...
<script>
稍顯繁瑣，對(duì)此社區(qū)推出了 unplugin-vue-define-options 來簡(jiǎn)化該操作。
使用步驟非常簡(jiǎn)單：
- 安裝
npm i unplugin-vue-define-options -D
- 配置 vite
// vite.config.ts
import DefineOptions from 'unplugin-vue-define-options/vite'
import Vue from '@vitejs/plugin-vue'
export default defineConfig({
plugins: [Vue(), DefineOptions()],
})
- 使用 typescript 開發(fā)的時(shí)候，需要配置 typescript 支持
// tsconfig.json
{
"compilerOptions": {
// ...
"types": ["unplugin-vue-define-options/macros-global" /* ... */]
}
}
安裝配置完成后，就能使用其提供的 defineOptions API 來定義 name 屬性。
<script setup lang="ts">
defineOptions({
name: "MyComponent"
})
<script>
那么它是如何做到這一點(diǎn)的呢？
對(duì)于使用了 defineOptions 的代碼：
<script setup lang="ts">
import { useSlots } from 'vue'
defineOptions({
name: 'Foo',
inheritAttrs: false,
})
const slots = useSlots()
</script>
編譯后輸出為：
<script lang="ts">
export default {
name: 'Foo',
inheritAttrs: false,
props: {
msg: { type: String, default: 'bar' },
},
emits: ['change', 'update'],
}
</script>
<script setup>
const slots = useSlots()
</script>
可以發(fā)現(xiàn)，這和我們?cè)谏衔闹袝鴮?2 個(gè) script 標(biāo)簽是一樣的，也就是說，unplugin-vue-define-options 通過 vite 插件的方式，在編譯階段幫我們做了編寫 2 個(gè) script 這一步，簡(jiǎn)化了我們的開發(fā)。
