Vue3 在大版本 3.3 裡面推出來了一些新功能(主要是語法糖),網上有各種文章,但是看起來似乎是一樣的。
我覺得吧,有新特性了,不能光看,還要動手嘗試一下。
DefineOptions 宏定義
先來一個簡單的,以前我們有時候想設個name,有時候不想讓元件自動繼承屬性,這時候需要單獨設定一個script進行設定,現在簡化了操作,直接使用 defineOptions 即可。
<script setup lang="ts">
defineOptions({
name: 'Foo',
inheritAttrs: false,
// ... 更多自定義屬性
})
</script>
defineModel
defineModel 這是一個語法糖,目前需要手動開啟,否則無法識別。
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
// https://vitejs.dev/config/
export default defineConfig({
plugins: [vue({
script: {
defineModel: true,
propsDestructure: true // 解構 props
}
})],
})
有人嫌棄 元件內部 v-model 的實現方式有點繁瑣,所以就做了這個語法糖給大家減少程式碼量,我們也來體驗一下。
const modelValue = defineModel()
console.log(modelValue)
我們看看 的結構
{__v_isRef: true}
value: (...)
__v_isRef: true
get value: ƒ value()
set value: ƒ value(value)
只是一個普通的物件看不出來有什麼名堂,我們來看一下內部的實現方式:
function useModel(props, name, options) {
const i = getCurrentInstance();
if (process.env.NODE_ENV !== "production" && !i) {
warn(`useModel() called without active instance.`);
return ref();
}
if (process.env.NODE_ENV !== "production" && !i.propsOptions[0][name]) {
warn(`useModel() called with prop "${name}" which is not declared.`);
return ref();
}
if (options && options.local) {
const proxy = ref(props[name]);
watch(
() => props[name], // 監聽外部元件的值的變化
(v) => proxy.value = v // 賦值給內部屬性
);
watch(proxy, (value) => { // 監聽內部屬性的變化
if (value !== props[name]) {
i.emit(`update:${name}`, value); // 提交給外部元件
}
});
return proxy;
} else {
return {
__v_isRef: true,
get value() {
return props[name]; // 返回外部元件的值
},
set value(value) {
i.emit(`update:${name}`, value); // 內部元件賦值,提交給外部元件
}
};
}
}
前面各種判斷,然後option模式下返回一個 ref,setup 模式下返回一個物件。取值的時候,返回 props[name]
Props 的響應式解構
我個人是不喜歡解構的,直接使用不香嗎?其實vue表面上不讓我們用,其實內部悄悄的在用,比如上面那個useModel 不就是嘛。
這個也是實驗性的,想要體驗需要手動設定,設定方法在上面。
const { name } = defineProps<{ name: string }>()
watchEffect(() => {
console.log(`name is: ${name}`)
})
const aa = computed(() => { return name + '響應'})
看列印效果,只是普通的string,那麼是如何實現響應的呢?還得看看“編譯後”的程式碼是什麼樣子的。
setup(__props, { expose: __expose }) {
__expose();
watchEffect(() => {
console.log(`name is: ${__props.name}`);
});
const aa = computed(() => {
return __props.name + "\u54CD\u5E94";
});
編譯後會生成一個 setup 函式,props 透過 引數 __props
傳入,需要監聽的地方,會把 name 變成 __props.name
,這樣就實現響應性了。也就是說,還是一個語法糖。
從外部檔案引入 props 的定義( 單檔案元件型別匯入)
從外部引入 props 的定義,這個功能非常實用,以前封裝UI庫,想實現共享屬性定義的時候卡了好久,使用OptionAPI,還是使用CompositionAPI,都各有優缺點,最後只好折中一下。
現在支援外部匯入那就方便多了。
比如我們先在一個ts檔案裡面定義一個介面:
export interface IFromItemProps {
/**
* 表單的 model
*/
model: {[key: string]: any},
/**
* 對應的欄位名稱
*/
colName: string,
/**
* 控制元件的備選項,單選、多選、等控制元件需要
*/
optionList?: Array<{
label: string,
value: string | number | boolean,
disabled: boolean
}>,
/**
* 是否顯示可清空的按鈕,預設顯示
*/
clearable?: boolean,
/**
* 浮動的提示資訊,部分控制元件支援
*/
title?: string,
/**
* 元件尺寸
*/
size?: string
}
text
然後我們可以 基於 el-input 做一個自己的 nf-text ,然後引入介面定義,還可以在 nf-list 等裡面引入,這比以前使用的方式正規多了,也能更好的支援TS。
<template>
<el-input
v-model="model[colName]"
v-bind="$attrs"
:id="'c' + colName"
:name="'c' + colName"
:size="size"
:clearable="clearable"
>
</el-input>
</template>
<script setup lang="ts">
// 引入 型別定義
import type { IFromItemProps } from './base'
// 定義 props
const props = defineProps<IFromItemProps>()
console.log('props - text', props)
</script>
看看效果
Proxy {model: Proxy, colName: 'name', title: '姓名', size: 'small', clearable: true, …}
[[Handler]]: Object
[[Target]]: Proxy
[[Handler]]: Object
[[Target]]: Object
clearable: true
colName: "name"
model: Proxy {name: 'jyk', city: Array(0), time: ''}
optionList: undefined
size: "small"
title: "姓名"
[[Prototype]]: Object
[[IsRevoked]]: false
[[IsRevoked]]: false
list
你可能會覺得,這封裝的有意義嗎?只看一個確實沒啥意思,不過表單裡面不是隻有文字框這一種,還需要其他型別,定義介面就是為了統一風格。
我們再封裝一個select看看:
<template>
<el-select
v-model="model[colName]"
v-bind="$attrs"
:id="'c' + colName"
:name="'c' + colName"
:size="size"
:clearable="clearable"
:multiple="multiple"
>
<el-option
v-for="item in optionList"
:key="'select' + item.value"
:label="item.label"
:value="item.value"
:disabled="item.disabled"
>
</el-option>
</el-select>
</template>
這裡處理了一下 el-option ,使用 v-for 建立 el-option。
<script setup lang="ts">
import type { IFromItemProps } from './base'
const props = defineProps<IFromItemProps & {multiple?: boolean}>()
console.log('props - list', props)
</script>
最後看一下使用情況
import nfText from './form/text.vue'
import nfList from './form/list.vue'
import nfDatetime from './form/datetime.vue'
const model = reactive({
name: 'jyk',
city: '',
time: ''
})
const myText = {
colName: 'name'
}
const myList = {
colName: 'city',
multiple: true,
optionList: [
{
label: '北京',
value: 1
},
{
label: '上海',
value: 2
}
]
}
<nf-text :model="model" v-bind="myText"></nf-text>
<nf-list :model="model" v-bind="myList"></nf-list>
...
封裝之後,我們不用關心元件是否需要子元件(比如el-select需要設定 el-option),都是<nf-text v-bind="myText"></nf-text>
這種簡單粗暴的方式,而元件需要的屬性,我們可以做成json的形式,這樣更方便。
另外大家不要忘記 vue 提供的動態元件(component :is="xxx"),這樣我們用 v-for 就可以把一個表單裡的所有子元件都給遍歷出來,不用一個一個的寫了。
小結
目前只對這幾個新特性感興趣體驗了一下,其他的還沒來得及。還有一個 props 設定預設值的問題,可以使用 withDefaults:
const props = withDefaults(defineProps< IFromItemProps >(), {
clearable: true
})
只是好像 預設值的部分需要直接寫進去。這個,等待以後更新吧,估計以後都會支援外部匯入的方式吧。
參考文件
- Announcing Vue 3.3 | The Vue Point
- Vue 3.3 主要新特性詳解 - 三咲智子 Kevin Deng
參考資料
[1] Generic component enhancements - Discussion #436: https://github.com/vuejs/rfcs/discussions/436
[2] unplugin-vue-define-options - npm: https://www.npmjs.com/package/unplugin-vue-define-options
[3] Announcing Vue 3.3 | The Vue Point: https://blog.vuejs.org/posts/vue-3-3
[4] Vue 3.3 主要新特性詳解 - 三咲智子 Kevin Deng: https://xlog.sxzz.moe/vue-3-3