文檔:html
教程react
課件npm
// ① npm i -g @vue/cli // ② vue create my-project // ③ npm install @vue/composition-api -S // ④ main,js import Vue from 'vue' import VueCompositionApi from '@vue/composition-api' Vue.use(VueCompositionApi)
setup
是vue3.x
中新的操做組件屬性的方法,它是組件內部暴露出全部的屬性和方法的統一API。api
setup的執行時機在:beforeCreate 以後 created以前app
setup(props, ctx) { console.log('setup') }, beforeCreate() { console.log('beforeCreate') }, created() { console.log('created') },
<!-- 組件傳值 --> <com-setup p1="傳值給 com-setup"/>
// 經過 setup 函數的第一個形參,接收 props 數據: setup(props) { console.log(props) }, // 在 props 中定義當前組件容許外界傳遞過來的參數名稱: props: { p1: String } /* {} p1: "傳值給 com-setup" get p1: ƒ reactiveGetter() set p1: ƒ reactiveSetter(newVal) __proto__: Object */
setup
函數的第二個形參是一個上下文對象,這個上下文對象中包含了一些有用的屬性,這些屬性在 vue 2.x
中須要經過 this
才能訪問到,在 vue 3.x
中,它們的訪問方式以下:dom
setup(props, ctx) { console.log(ctx) console.log(this) // undefined }, /* attrs: Object emit: ƒ () listeners: Object parent: VueComponent refs: Object root: Vue ... */
異步
reactive
函數接收一個普通函數,返回一個響應式的數據對象。async
reactive
函數等價於 vue 2.x
中的 Vue.observable()
函數,vue 3.x
中提供了 reactive()
函數,用來建立響應式的數據對象,基本代碼示例以下:ide
<template> <div> <!-- 在 template 中訪問響應式數據 --> <p>當前的 count 值爲:{{count}}</p> <button @click="count += 1">+1</button> </div> </template> <script> import {reactive} from '@vue/composition-api' export default { setup(props, ctx) { // 建立響應式數據對象,獲得的 state 相似於 vue 2.x 中 data() 返回的響應式對象 const state = reactive({ count: 0 }) state.count += 1 console.log(state) // setup 函數中將響應式數據對象 return 出去,供 template 使用 return state } } </script>
ref()
函數用來根據給定的值建立一個響應式的數據對象,ref()
函數調用的返回值是一個對象,這個對象上只包含一個 .value
屬性:
<template> <div> <h3>02.ref.vue 文件</h3> <p>refCount:{{refCount}}</p> <button @click="refCount += 1">+1</button> </div> </template> <script> import { ref } from '@vue/composition-api' export default { setup() { // / 建立響應式數據對象 count,初始值爲 0 const refCount = ref(0) // 若是要訪問 ref() 建立出來的響應式數據對象的值,必須經過 .value 屬性才能夠,只有在setup內部才須要 .value 屬性 console.log(refCount.value) // 輸出 0 // 讓 refCount 的值 +1 refCount.value++ // 再次打印 refCount 的值 console.log(refCount.value) // 輸出 1 return { refCount } } } </script>
當把 ref()
建立出來的響應式數據對象,掛載到 reactive()
上時,會自動把響應式數據對象展開爲原始的值,不需經過 .value
就能夠直接被訪問,例如:
setup() { const refCount = ref(0) const state = reactive({refCount}) console.log(state.refCount) // 輸出 0 state.refCount++ // 此處不須要經過 .value 就能直接訪問原始值 console.log(refCount) // 輸出 1 return { refCount } }
setup() { // 建立 ref 並掛載到 reactive 中 const c1 = ref(0); const state = reactive({ c1 }); // 再次建立 ref,命名爲 c2 const c2 = ref(9); // 將 舊 ref c1 替換爲 新 ref c2 state.c1 = c2; state.c1++; console.log(state.c1); // 輸出 10 console.log(c2.value); // 輸出 10 console.log(c1.value); // 輸出 0 }
isRef()
用來判斷某個值是否爲 ref()
建立出來的對象;應用場景:當須要展開某個可能爲 ref()
建立出來的值的時候,例如:
import { ref, reactive, isRef } from "@vue/composition-api"; export default { setup() { const unwrapped = isRef(foo) ? foo.value : foo } };
toRefs()
函數能夠將 reactive()
建立出來的響應式對象,轉換爲普通的對象,只不過,這個對象上的每一個屬性節點,都是 ref()
類型的響應式數據。
<template> <div> <h3>03.toRefs.vue文件</h3> <p>{{ count }} - {{ name }}</p> <button @click="count += 1">+1</button> <button @click="add">+1</button> </div> </template> <script> import { reactive, toRefs } from "@vue/composition-api"; export default { setup() { // 響應式數據 const state = reactive({ count: 0, name: "zs" }); // 方法 const add = () => { state.count += 1; }; return { // 非響應式數據 // ...state, // 響應式數據 ...toRefs(state), add }; } }; </script>
<template> <div> <h3>04.computed.vue文件</h3> <p>refCount: {{refCount}}</p> <p>計算屬性的值computedCount : {{computedCount}}</p> <button @click="refCount++">refCount + 1</button> <!-- 點擊報錯 --> <button @click="computedCount++">計算屬性的值computedCount + 1</button> </div> </template> <script> import { computed, ref } from '@vue/composition-api' export default { setup() { const refCount = ref(1) // 只讀 let computedCount = computed(() => refCount.value + 1) console.log(computedCount) return { refCount, computedCount } } }; </script>
<template> <div> <h3>04.computed.vue文件</h3> <p>refCount: {{refCount}}</p> <p>計算屬性的值computedCount : {{computedCount}}</p> <button @click="refCount++">refCount + 1</button> </div> </template> <script> import { computed, ref } from '@vue/composition-api' export default { setup() { const refCount = ref(1) // 可讀可寫 let computedCount = computed({ // 取值函數 get: () => refCount.value + 1, // 賦值函數 set: val => { refCount.value = refCount.value -5 } }) console.log(computedCount.value) // 爲計算屬性賦值的操做,會觸發 set 函數 computedCount.value = 10 console.log(computedCount.value) // 觸發 set 函數後,count 的值會被更新 console.log(refCount.value) return { refCount, computedCount } } }; </script>
watch()
函數用來監視某些數據項的變化,從而觸發某些特定的操做,使用以前須要按需導入:
import { watch } from '@vue/composition-api'
<template> <div> <h3>05.watch.vue文件</h3> <p>refCount: {{refCount}}</p> </div> </template> <script> import { watch, ref } from '@vue/composition-api' export default { setup() { const refCount = ref(100) // 定義 watch,只要 count 值變化,就會觸發 watch 回調 // 組件在第一次建立的時候執行一次 watch watch(() => console.log(refCount.value), { lazy: false}) setInterval(() => { refCount.value += 2 }, 5000) return { refCount } } }; </script>
監視 reactive
類型的數據源:
<template> <div> <h3>05.watch.vue文件</h3> <p>count: {{count}}</p> // 不是響應式數據 </div> </template> <script> import { watch, ref, reactive } from '@vue/composition-api' export default { setup() { const state = reactive({count: 100}) watch( // 監聽count () => state.count, // 若是變換 執行如下函數 (newVal, oldVala) => { console.log(newVal, oldVala) }, { lazy: true } ) setInterval(() => { state.count += 2 }, 5000) return state } }; </script>
export default { setup() { // 定義數據源 let count = ref(0); // 指定要監視的數據源 watch(count, (count, prevCount) => { console.log(count, prevCount) }) setInterval(() => { count.value += 2 }, 2000) console.log(count.value) return { count } } };
監視 reactive
export default { setup() { const state = reactive({count: 100, name: 'houfei'}) watch( // 監聽count name [() => state.count, () => state.name], // 若是變換 執行如下函數 ([newCount, newName], [oldCount, oldName]) => { console.log(newCount, oldCount) console.log(newName, oldName) }, { lazy: true} // 在 watch 被建立的時候,不執行回調函數中的代碼 ) setTimeout(() => { state.count += 2 state.name = 'qweqweewq' }, 3000) return state } };
export default { setup() { // 定義數據源 const count = ref(10) const name = ref('zs') // 指定要監視的數據源 watch( [count, name], ([newCount, newName], [oldCount, oldName]) => { console.log(newCount, oldCount) console.log(newName, oldName) }, { lazy: true} ) setInterval(() => { count.value += 2 }, 2000) console.log(count.value) return { count } } };
在 setup()
函數內建立的 watch
監視,會在當前組件被銷燬的時候自動中止。若是想要明確地中止某個監視,能夠調用 watch()
<script> // 建立監視,並獲得 中止函數 const stop = watch(() => { /* ... */ }) // 調用中止函數,清除對應的監視 stop()
<template> <div> <!-- <h3>05.watch.vue文件</h3> --> <p>count: {{ count }}</p> <button @click="stopWatch">中止監聽</button> </div> </template> <script> import { watch, ref, reactive } from "@vue/composition-api"; export default { setup() { // 定義數據源 const count = ref(10) const name = ref('zs') // 指定要監視的數據源 const stop = watch( [count, name], ([newCount, newName], [oldCount, oldName]) => { console.log(newCount, oldCount) console.log(newName, oldName) }, { lazy: true} ) setInterval(() => { count.value += 2 name.value = 'houyue' }, 2000) // 中止監視 const stopWatch = () => { console.log("中止監視,可是數據還在變化") stop() } console.log(count.value) return { stop, count, stopWatch } } }; </script>
有時候,當被 watch
監視的值發生變化時,或 watch
自己被 stop
以後,咱們指望可以清除那些無效的異步任務,此時,watch
回調函數中提供了一個 cleanup registrator function
來執行清除的工做。這個清除函數會在以下狀況下被調用:
watch 被重複執行了
watch 被強制 stop
了
Template 中的代碼示例以下
<template>
<div>
<!-- <h3>05.watch.vue文件</h3> -->
<input type="text" v-model="keywords" />
<p>keywords:--- {{ keywords }}</p>
</div>
</template>
<script> import { watch, ref, reactive } from "@vue/composition-api"; export default { setup() { // 定義響應式數據 keywords const keywords = ref(""); // 異步任務:打印用戶輸入的關鍵詞 const asyncPrint = val => { // 延時 1 秒後打印 return setTimeout(() => { console.log(val); }, 1000); }; // 定義 watch 監聽 watch( keywords, (keywords, prevKeywords, onCleanup) => { // 執行異步任務,並獲得關閉異步任務的 timerId const timerId = asyncPrint(keywords); // 若是 watch 監聽被重複執行了,則會先清除上次未完成的異步任務 onCleanup(() => clearTimeout(timerId)); }, // watch 剛被建立的時候不執行 { lazy: true } ); // 把 template 中須要的數據 return 出去 return { keywords }; } }; </script>
provide()
和 inject()
能夠實現嵌套組件之間的數據傳遞。這兩個函數只能在 setup()
函數中使用。父級組件中使用 provide()
函數向下傳遞數據;子級組件中使用 inject()
獲取上層傳遞過來的數據。
app.vue
<template> <div id="app"> <h1>父組件</h1> <button @click="color = 'blue'">藍色</button> <button @click="color = 'red'">紅色</button> <button @click="color = 'yellow'">黃色</button> <son></son> <son></son> </div> </template> <script> import { ref, provide } from '@vue/composition-api' import Son from './components/06.son.vue' export default { name: 'app', components: { 'son': Son }, setup() { const color = ref('green') provide('themecolor', color) return { color } } } </script>
<template> <div> <h3 :style="{color: color}">son 組件</h3> <grandson></grandson> </div> </template> <script> import { inject } from '@vue/composition-api' import Grandson from './07.grandson.vue' export default { components: { 'grandson': Grandson }, setup() { const color = inject('themecolor') return { color } } } </script>
07.grandson.vue
son 組件:
<template> <div> <h5 :style="{color: color}">grandson 組件</h5> </div> </template> <script> import { inject } from '@vue/composition-api' export default { setup() { const color = inject('themecolor') return { color } } } </script>
ref
響應式數據app.vue
<template> <div id="app"> <h1>父組件</h1> <son></son> </div> </template> <script> import { provide } from '@vue/composition-api' import Son from './components/06.son.vue' export default { name: 'app', components: { 'son': Son }, setup() { provide('themecolor', 'red') } } </script>
<template> <div> <h3 :style="{color: color}">son 組件</h3> <grandson></grandson> </div> </template> <script> import { inject } from '@vue/composition-api' import Grandson from './07.grandson.vue' export default { components: { 'grandson': Grandson }, setup() { const color = inject('themecolor') return { color } } } </script>
<template> <div> <h5 :style="{color: color}">grandson 組件</h5> </div> </template> <script> import { inject } from '@vue/composition-api' export default { setup() { const color = inject('themecolor') return { color } } } </script>
<template> <div> <h3 ref="h3Ref">TemplateRefOne</h3> </div> </template> <script> import { ref, onMounted } from '@vue/composition-api' export default { setup() { // 建立一個 DOM 引用 const h3Ref = ref(null) // 在 DOM 首次加載完畢以後,才能獲取到元素的引用 onMounted(() => { // 爲 dom 元素設置字體顏色 // h3Ref.value 是原生DOM對象 h3Ref.value.style.color = 'red' }) // 把建立的引用 return 出去 return { h3Ref } } } </script>
App
父組件:
<template> <div id="app"> <h1>父組件</h1> <button @click="showComRef">展現子組件的值</button> <son ref="comRef"></son> </div> </template> <script> import Son from './components/06.son.vue' export default { name: 'app', components: { 'son': Son }, setup() { const comRef = ref(null) const showComRef = () => { console.log(comRef) console.log('str1的值是' + comRef.value.str1) comRef.value.setStr1() } return { comRef, showComRef } } } </script>
<template> <div> <h3 :style="{color: color}">son 組件</h3> <p>{{str1}}</p> </div> </template> <script> import { ref } from '@vue/composition-api' export default { setup() { const str1 = ref('這是一個子組件!!') const setStr1 = () => { str1.value = '被賦值了' } return { str1, setStr1 } } } </script>
<template> <div> <h3>09.nextTick 組件</h3> <p>學習 $nextTick</p> <button v-if="isShowInput === false" @click="showInput">展現文本框</button> <input type="text" v-else ref="ipt"> </div> </template> <script> export default { data() { return { isShowInput: false } }, methods: { showInput() { this.isShowInput = !this.isShowInput // console.log(this.$refs) this.$nextTick(() => { this.$refs.ipt.focus() }) } } } </script>