| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314 |
- import {
- Text,
- Fragment,
- Comment,
- cloneIfMounted,
- normalizeVNode,
- VNode,
- VNodeArrayChildren,
- createVNode,
- isSameVNodeType,
- Static,
- VNodeNormalizedRef,
- VNodeHook,
- VNodeNormalizedRefAtom
- } from './vnode'
- import {
- ComponentInternalInstance,
- createComponentInstance,
- Data,
- setupComponent
- } from './component'
- import {
- filterSingleRoot,
- renderComponentRoot,
- shouldUpdateComponent,
- updateHOCHostEl
- } from './componentRenderUtils'
- import {
- isString,
- EMPTY_OBJ,
- EMPTY_ARR,
- isReservedProp,
- isFunction,
- PatchFlags,
- ShapeFlags,
- NOOP,
- hasOwn,
- invokeArrayFns,
- isArray
- } from '@vue/shared'
- import {
- queueJob,
- queuePostFlushCb,
- flushPostFlushCbs,
- invalidateJob,
- flushPreFlushCbs,
- SchedulerCb
- } from './scheduler'
- import { effect, stop, ReactiveEffectOptions, isRef } from '@vue/reactivity'
- import { updateProps } from './componentProps'
- import { updateSlots } from './componentSlots'
- import { pushWarningContext, popWarningContext, warn } from './warning'
- import { createAppAPI, CreateAppFunction } from './apiCreateApp'
- import {
- SuspenseBoundary,
- queueEffectWithSuspense,
- SuspenseImpl
- } from './components/Suspense'
- import {
- isTeleportDisabled,
- TeleportImpl,
- TeleportVNode
- } from './components/Teleport'
- import { isKeepAlive, KeepAliveContext } from './components/KeepAlive'
- import { registerHMR, unregisterHMR, isHmrUpdating } from './hmr'
- import {
- ErrorCodes,
- callWithErrorHandling,
- callWithAsyncErrorHandling
- } from './errorHandling'
- import { createHydrationFunctions, RootHydrateFunction } from './hydration'
- import { invokeDirectiveHook } from './directives'
- import { startMeasure, endMeasure } from './profiling'
- import { ComponentPublicInstance } from './componentPublicInstance'
- import { devtoolsComponentRemoved, devtoolsComponentUpdated } from './devtools'
- import { initFeatureFlags } from './featureFlags'
- import { isAsyncWrapper } from './apiAsyncComponent'
- export interface Renderer<HostElement = RendererElement> {
- render: RootRenderFunction<HostElement>
- createApp: CreateAppFunction<HostElement>
- }
- export interface HydrationRenderer extends Renderer<Element> {
- hydrate: RootHydrateFunction
- }
- export type RootRenderFunction<HostElement = RendererElement> = (
- vnode: VNode | null,
- container: HostElement
- ) => void
- export interface RendererOptions<
- HostNode = RendererNode,
- HostElement = RendererElement
- > {
- patchProp(
- el: HostElement,
- key: string,
- prevValue: any,
- nextValue: any,
- isSVG?: boolean,
- prevChildren?: VNode<HostNode, HostElement>[],
- parentComponent?: ComponentInternalInstance | null,
- parentSuspense?: SuspenseBoundary | null,
- unmountChildren?: UnmountChildrenFn
- ): void
- forcePatchProp?(el: HostElement, key: string): boolean
- insert(el: HostNode, parent: HostElement, anchor?: HostNode | null): void
- remove(el: HostNode): void
- createElement(
- type: string,
- isSVG?: boolean,
- isCustomizedBuiltIn?: string
- ): HostElement
- createText(text: string): HostNode
- createComment(text: string): HostNode
- setText(node: HostNode, text: string): void
- setElementText(node: HostElement, text: string): void
- parentNode(node: HostNode): HostElement | null
- nextSibling(node: HostNode): HostNode | null
- querySelector?(selector: string): HostElement | null
- setScopeId?(el: HostElement, id: string): void
- cloneNode?(node: HostNode): HostNode
- insertStaticContent?(
- content: string,
- parent: HostElement,
- anchor: HostNode | null,
- isSVG: boolean
- ): HostElement[]
- }
- // Renderer Node can technically be any object in the context of core renderer
- // logic - they are never directly operated on and always passed to the node op
- // functions provided via options, so the internal constraint is really just
- // a generic object.
- export interface RendererNode {
- [key: string]: any
- }
- export interface RendererElement extends RendererNode {}
- // An object exposing the internals of a renderer, passed to tree-shakeable
- // features so that they can be decoupled from this file. Keys are shortened
- // to optimize bundle size.
- export interface RendererInternals<
- HostNode = RendererNode,
- HostElement = RendererElement
- > {
- p: PatchFn
- um: UnmountFn
- r: RemoveFn
- m: MoveFn
- mt: MountComponentFn
- mc: MountChildrenFn
- pc: PatchChildrenFn
- pbc: PatchBlockChildrenFn
- n: NextFn
- o: RendererOptions<HostNode, HostElement>
- }
- // These functions are created inside a closure and therefore their types cannot
- // be directly exported. In order to avoid maintaining function signatures in
- // two places, we declare them once here and use them inside the closure.
- type PatchFn = (
- n1: VNode | null, // null means this is a mount
- n2: VNode,
- container: RendererElement,
- anchor?: RendererNode | null,
- parentComponent?: ComponentInternalInstance | null,
- parentSuspense?: SuspenseBoundary | null,
- isSVG?: boolean,
- optimized?: boolean
- ) => void
- type MountChildrenFn = (
- children: VNodeArrayChildren,
- container: RendererElement,
- anchor: RendererNode | null,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean,
- optimized: boolean,
- start?: number
- ) => void
- type PatchChildrenFn = (
- n1: VNode | null,
- n2: VNode,
- container: RendererElement,
- anchor: RendererNode | null,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean,
- optimized?: boolean
- ) => void
- type PatchBlockChildrenFn = (
- oldChildren: VNode[],
- newChildren: VNode[],
- fallbackContainer: RendererElement,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean
- ) => void
- type MoveFn = (
- vnode: VNode,
- container: RendererElement,
- anchor: RendererNode | null,
- type: MoveType,
- parentSuspense?: SuspenseBoundary | null
- ) => void
- type NextFn = (vnode: VNode) => RendererNode | null
- type UnmountFn = (
- vnode: VNode,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- doRemove?: boolean,
- optimized?: boolean
- ) => void
- type RemoveFn = (vnode: VNode) => void
- type UnmountChildrenFn = (
- children: VNode[],
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- doRemove?: boolean,
- optimized?: boolean,
- start?: number
- ) => void
- export type MountComponentFn = (
- initialVNode: VNode,
- container: RendererElement,
- anchor: RendererNode | null,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean,
- optimized: boolean
- ) => void
- type ProcessTextOrCommentFn = (
- n1: VNode | null,
- n2: VNode,
- container: RendererElement,
- anchor: RendererNode | null
- ) => void
- export type SetupRenderEffectFn = (
- instance: ComponentInternalInstance,
- initialVNode: VNode,
- container: RendererElement,
- anchor: RendererNode | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean,
- optimized: boolean
- ) => void
- export const enum MoveType {
- ENTER,
- LEAVE,
- REORDER
- }
- const prodEffectOptions = {
- scheduler: queueJob,
- // #1801, #2043 component render effects should allow recursive updates
- allowRecurse: true
- }
- function createDevEffectOptions(
- instance: ComponentInternalInstance
- ): ReactiveEffectOptions {
- return {
- scheduler: queueJob,
- allowRecurse: true,
- onTrack: instance.rtc ? e => invokeArrayFns(instance.rtc!, e) : void 0,
- onTrigger: instance.rtg ? e => invokeArrayFns(instance.rtg!, e) : void 0
- }
- }
- export const queuePostRenderEffect = __FEATURE_SUSPENSE__
- ? queueEffectWithSuspense
- : queuePostFlushCb
- export const setRef = (
- rawRef: VNodeNormalizedRef,
- oldRawRef: VNodeNormalizedRef | null,
- parentSuspense: SuspenseBoundary | null,
- vnode: VNode | null
- ) => {
- if (isArray(rawRef)) {
- rawRef.forEach((r, i) =>
- setRef(
- r,
- oldRawRef && (isArray(oldRawRef) ? oldRawRef[i] : oldRawRef),
- parentSuspense,
- vnode
- )
- )
- return
- }
- let value: ComponentPublicInstance | RendererNode | Record<string, any> | null
- if (!vnode || isAsyncWrapper(vnode)) {
- value = null
- } else {
- if (vnode.shapeFlag & ShapeFlags.STATEFUL_COMPONENT) {
- value = vnode.component!.exposed || vnode.component!.proxy
- } else {
- value = vnode.el
- }
- }
- const { i: owner, r: ref } = rawRef
- if (__DEV__ && !owner) {
- warn(
- `Missing ref owner context. ref cannot be used on hoisted vnodes. ` +
- `A vnode with ref must be created inside the render function.`
- )
- return
- }
- const oldRef = oldRawRef && (oldRawRef as VNodeNormalizedRefAtom).r
- const refs = owner.refs === EMPTY_OBJ ? (owner.refs = {}) : owner.refs
- const setupState = owner.setupState
- // unset old ref
- if (oldRef != null && oldRef !== ref) {
- if (isString(oldRef)) {
- refs[oldRef] = null
- if (hasOwn(setupState, oldRef)) {
- setupState[oldRef] = null
- }
- } else if (isRef(oldRef)) {
- oldRef.value = null
- }
- }
- if (isString(ref)) {
- const doSet = () => {
- refs[ref] = value
- if (hasOwn(setupState, ref)) {
- setupState[ref] = value
- }
- }
- // #1789: for non-null values, set them after render
- // null values means this is unmount and it should not overwrite another
- // ref with the same key
- if (value) {
- ;(doSet as SchedulerCb).id = -1
- queuePostRenderEffect(doSet, parentSuspense)
- } else {
- doSet()
- }
- } else if (isRef(ref)) {
- const doSet = () => {
- ref.value = value
- }
- if (value) {
- ;(doSet as SchedulerCb).id = -1
- queuePostRenderEffect(doSet, parentSuspense)
- } else {
- doSet()
- }
- } else if (isFunction(ref)) {
- callWithErrorHandling(ref, owner, ErrorCodes.FUNCTION_REF, [value, refs])
- } else if (__DEV__) {
- warn('Invalid template ref type:', value, `(${typeof value})`)
- }
- }
- /**
- * The createRenderer function accepts two generic arguments:
- * HostNode and HostElement, corresponding to Node and Element types in the
- * host environment. For example, for runtime-dom, HostNode would be the DOM
- * `Node` interface and HostElement would be the DOM `Element` interface.
- *
- * Custom renderers can pass in the platform specific types like this:
- *
- * ``` js
- * const { render, createApp } = createRenderer<Node, Element>({
- * patchProp,
- * ...nodeOps
- * })
- * ```
- */
- export function createRenderer<
- HostNode = RendererNode,
- HostElement = RendererElement
- >(options: RendererOptions<HostNode, HostElement>) {
- return baseCreateRenderer<HostNode, HostElement>(options)
- }
- // Separate API for creating hydration-enabled renderer.
- // Hydration logic is only used when calling this function, making it
- // tree-shakable.
- export function createHydrationRenderer(
- options: RendererOptions<Node, Element>
- ) {
- return baseCreateRenderer(options, createHydrationFunctions)
- }
- // overload 1: no hydration
- function baseCreateRenderer<
- HostNode = RendererNode,
- HostElement = RendererElement
- >(options: RendererOptions<HostNode, HostElement>): Renderer<HostElement>
- // overload 2: with hydration
- function baseCreateRenderer(
- options: RendererOptions<Node, Element>,
- createHydrationFns: typeof createHydrationFunctions
- ): HydrationRenderer
- // implementation
- function baseCreateRenderer(
- options: RendererOptions,
- createHydrationFns?: typeof createHydrationFunctions
- ): any {
- // compile-time feature flags check
- if (__ESM_BUNDLER__ && !__TEST__) {
- initFeatureFlags()
- }
- const {
- insert: hostInsert,
- remove: hostRemove,
- patchProp: hostPatchProp,
- forcePatchProp: hostForcePatchProp,
- createElement: hostCreateElement,
- createText: hostCreateText,
- createComment: hostCreateComment,
- setText: hostSetText,
- setElementText: hostSetElementText,
- parentNode: hostParentNode,
- nextSibling: hostNextSibling,
- setScopeId: hostSetScopeId = NOOP,
- cloneNode: hostCloneNode,
- insertStaticContent: hostInsertStaticContent
- } = options
- // Note: functions inside this closure should use `const xxx = () => {}`
- // style in order to prevent being inlined by minifiers.
- const patch: PatchFn = (
- n1,
- n2,
- container,
- anchor = null,
- parentComponent = null,
- parentSuspense = null,
- isSVG = false,
- optimized = false
- ) => {
- // patching & not same type, unmount old tree
- if (n1 && !isSameVNodeType(n1, n2)) {
- anchor = getNextHostNode(n1)
- unmount(n1, parentComponent, parentSuspense, true)
- n1 = null
- }
- if (n2.patchFlag === PatchFlags.BAIL) {
- optimized = false
- n2.dynamicChildren = null
- }
- const { type, ref, shapeFlag } = n2
- switch (type) {
- case Text:
- processText(n1, n2, container, anchor)
- break
- case Comment:
- processCommentNode(n1, n2, container, anchor)
- break
- case Static:
- if (n1 == null) {
- mountStaticNode(n2, container, anchor, isSVG)
- } else if (__DEV__) {
- patchStaticNode(n1, n2, container, isSVG)
- }
- break
- case Fragment:
- processFragment(
- n1,
- n2,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- break
- default:
- if (shapeFlag & ShapeFlags.ELEMENT) {
- processElement(
- n1,
- n2,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- } else if (shapeFlag & ShapeFlags.COMPONENT) {
- processComponent(
- n1,
- n2,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- } else if (shapeFlag & ShapeFlags.TELEPORT) {
- ;(type as typeof TeleportImpl).process(
- n1 as TeleportVNode,
- n2 as TeleportVNode,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized,
- internals
- )
- } else if (__FEATURE_SUSPENSE__ && shapeFlag & ShapeFlags.SUSPENSE) {
- ;(type as typeof SuspenseImpl).process(
- n1,
- n2,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized,
- internals
- )
- } else if (__DEV__) {
- warn('Invalid VNode type:', type, `(${typeof type})`)
- }
- }
- // set ref
- if (ref != null && parentComponent) {
- setRef(ref, n1 && n1.ref, parentSuspense, n2)
- }
- }
- const processText: ProcessTextOrCommentFn = (n1, n2, container, anchor) => {
- if (n1 == null) {
- hostInsert(
- (n2.el = hostCreateText(n2.children as string)),
- container,
- anchor
- )
- } else {
- const el = (n2.el = n1.el!)
- if (n2.children !== n1.children) {
- hostSetText(el, n2.children as string)
- }
- }
- }
- const processCommentNode: ProcessTextOrCommentFn = (
- n1,
- n2,
- container,
- anchor
- ) => {
- if (n1 == null) {
- hostInsert(
- (n2.el = hostCreateComment((n2.children as string) || '')),
- container,
- anchor
- )
- } else {
- // there's no support for dynamic comments
- n2.el = n1.el
- }
- }
- const mountStaticNode = (
- n2: VNode,
- container: RendererElement,
- anchor: RendererNode | null,
- isSVG: boolean
- ) => {
- // static nodes are only present when used with compiler-dom/runtime-dom
- // which guarantees presence of hostInsertStaticContent.
- ;[n2.el, n2.anchor] = hostInsertStaticContent!(
- n2.children as string,
- container,
- anchor,
- isSVG
- )
- }
- /**
- * Dev / HMR only
- */
- const patchStaticNode = (
- n1: VNode,
- n2: VNode,
- container: RendererElement,
- isSVG: boolean
- ) => {
- // static nodes are only patched during dev for HMR
- if (n2.children !== n1.children) {
- const anchor = hostNextSibling(n1.anchor!)
- // remove existing
- removeStaticNode(n1)
- // insert new
- ;[n2.el, n2.anchor] = hostInsertStaticContent!(
- n2.children as string,
- container,
- anchor,
- isSVG
- )
- } else {
- n2.el = n1.el
- n2.anchor = n1.anchor
- }
- }
- const moveStaticNode = (
- { el, anchor }: VNode,
- container: RendererElement,
- nextSibling: RendererNode | null
- ) => {
- let next
- while (el && el !== anchor) {
- next = hostNextSibling(el)
- hostInsert(el, container, nextSibling)
- el = next
- }
- hostInsert(anchor!, container, nextSibling)
- }
- const removeStaticNode = ({ el, anchor }: VNode) => {
- let next
- while (el && el !== anchor) {
- next = hostNextSibling(el)
- hostRemove(el)
- el = next
- }
- hostRemove(anchor!)
- }
- const processElement = (
- n1: VNode | null,
- n2: VNode,
- container: RendererElement,
- anchor: RendererNode | null,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean,
- optimized: boolean
- ) => {
- isSVG = isSVG || (n2.type as string) === 'svg'
- if (n1 == null) {
- mountElement(
- n2,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- } else {
- patchElement(n1, n2, parentComponent, parentSuspense, isSVG, optimized)
- }
- }
- const mountElement = (
- vnode: VNode,
- container: RendererElement,
- anchor: RendererNode | null,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean,
- optimized: boolean
- ) => {
- let el: RendererElement
- let vnodeHook: VNodeHook | undefined | null
- const {
- type,
- props,
- shapeFlag,
- transition,
- scopeId,
- patchFlag,
- dirs
- } = vnode
- if (
- !__DEV__ &&
- vnode.el &&
- hostCloneNode !== undefined &&
- patchFlag === PatchFlags.HOISTED
- ) {
- // If a vnode has non-null el, it means it's being reused.
- // Only static vnodes can be reused, so its mounted DOM nodes should be
- // exactly the same, and we can simply do a clone here.
- // only do this in production since cloned trees cannot be HMR updated.
- el = vnode.el = hostCloneNode(vnode.el)
- } else {
- el = vnode.el = hostCreateElement(
- vnode.type as string,
- isSVG,
- props && props.is
- )
- // mount children first, since some props may rely on child content
- // being already rendered, e.g. `<select value>`
- if (shapeFlag & ShapeFlags.TEXT_CHILDREN) {
- hostSetElementText(el, vnode.children as string)
- } else if (shapeFlag & ShapeFlags.ARRAY_CHILDREN) {
- mountChildren(
- vnode.children as VNodeArrayChildren,
- el,
- null,
- parentComponent,
- parentSuspense,
- isSVG && type !== 'foreignObject',
- optimized || !!vnode.dynamicChildren
- )
- }
- if (dirs) {
- invokeDirectiveHook(vnode, null, parentComponent, 'created')
- }
- // props
- if (props) {
- for (const key in props) {
- if (!isReservedProp(key)) {
- hostPatchProp(
- el,
- key,
- null,
- props[key],
- isSVG,
- vnode.children as VNode[],
- parentComponent,
- parentSuspense,
- unmountChildren
- )
- }
- }
- if ((vnodeHook = props.onVnodeBeforeMount)) {
- invokeVNodeHook(vnodeHook, parentComponent, vnode)
- }
- }
- // scopeId
- setScopeId(el, scopeId, vnode, parentComponent)
- }
- if (__DEV__ || __FEATURE_PROD_DEVTOOLS__) {
- Object.defineProperty(el, '__vnode', {
- value: vnode,
- enumerable: false
- })
- Object.defineProperty(el, '__vueParentComponent', {
- value: parentComponent,
- enumerable: false
- })
- }
- if (dirs) {
- invokeDirectiveHook(vnode, null, parentComponent, 'beforeMount')
- }
- // #1583 For inside suspense + suspense not resolved case, enter hook should call when suspense resolved
- // #1689 For inside suspense + suspense resolved case, just call it
- const needCallTransitionHooks =
- (!parentSuspense || (parentSuspense && !parentSuspense.pendingBranch)) &&
- transition &&
- !transition.persisted
- if (needCallTransitionHooks) {
- transition!.beforeEnter(el)
- }
- hostInsert(el, container, anchor)
- if (
- (vnodeHook = props && props.onVnodeMounted) ||
- needCallTransitionHooks ||
- dirs
- ) {
- queuePostRenderEffect(() => {
- vnodeHook && invokeVNodeHook(vnodeHook, parentComponent, vnode)
- needCallTransitionHooks && transition!.enter(el)
- dirs && invokeDirectiveHook(vnode, null, parentComponent, 'mounted')
- }, parentSuspense)
- }
- }
- const setScopeId = (
- el: RendererElement,
- scopeId: string | false | null,
- vnode: VNode,
- parentComponent: ComponentInternalInstance | null
- ) => {
- if (scopeId) {
- hostSetScopeId(el, scopeId)
- }
- if (parentComponent) {
- const treeOwnerId = parentComponent.type.__scopeId
- // vnode's own scopeId and the current patched component's scopeId is
- // different - this is a slot content node.
- if (treeOwnerId && treeOwnerId !== scopeId) {
- hostSetScopeId(el, treeOwnerId + '-s')
- }
- let subTree = parentComponent.subTree
- if (__DEV__ && subTree.type === Fragment) {
- subTree =
- filterSingleRoot(subTree.children as VNodeArrayChildren) || subTree
- }
- if (vnode === subTree) {
- setScopeId(
- el,
- parentComponent.vnode.scopeId,
- parentComponent.vnode,
- parentComponent.parent
- )
- }
- }
- }
- const mountChildren: MountChildrenFn = (
- children,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized,
- start = 0
- ) => {
- for (let i = start; i < children.length; i++) {
- const child = (children[i] = optimized
- ? cloneIfMounted(children[i] as VNode)
- : normalizeVNode(children[i]))
- patch(
- null,
- child,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- }
- }
- const patchElement = (
- n1: VNode,
- n2: VNode,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean,
- optimized: boolean
- ) => {
- const el = (n2.el = n1.el!)
- let { patchFlag, dynamicChildren, dirs } = n2
- // #1426 take the old vnode's patch flag into account since user may clone a
- // compiler-generated vnode, which de-opts to FULL_PROPS
- patchFlag |= n1.patchFlag & PatchFlags.FULL_PROPS
- const oldProps = n1.props || EMPTY_OBJ
- const newProps = n2.props || EMPTY_OBJ
- let vnodeHook: VNodeHook | undefined | null
- if ((vnodeHook = newProps.onVnodeBeforeUpdate)) {
- invokeVNodeHook(vnodeHook, parentComponent, n2, n1)
- }
- if (dirs) {
- invokeDirectiveHook(n2, n1, parentComponent, 'beforeUpdate')
- }
- if (__DEV__ && isHmrUpdating) {
- // HMR updated, force full diff
- patchFlag = 0
- optimized = false
- dynamicChildren = null
- }
- if (patchFlag > 0) {
- // the presence of a patchFlag means this element's render code was
- // generated by the compiler and can take the fast path.
- // in this path old node and new node are guaranteed to have the same shape
- // (i.e. at the exact same position in the source template)
- if (patchFlag & PatchFlags.FULL_PROPS) {
- // element props contain dynamic keys, full diff needed
- patchProps(
- el,
- n2,
- oldProps,
- newProps,
- parentComponent,
- parentSuspense,
- isSVG
- )
- } else {
- // class
- // this flag is matched when the element has dynamic class bindings.
- if (patchFlag & PatchFlags.CLASS) {
- if (oldProps.class !== newProps.class) {
- hostPatchProp(el, 'class', null, newProps.class, isSVG)
- }
- }
- // style
- // this flag is matched when the element has dynamic style bindings
- if (patchFlag & PatchFlags.STYLE) {
- hostPatchProp(el, 'style', oldProps.style, newProps.style, isSVG)
- }
- // props
- // This flag is matched when the element has dynamic prop/attr bindings
- // other than class and style. The keys of dynamic prop/attrs are saved for
- // faster iteration.
- // Note dynamic keys like :[foo]="bar" will cause this optimization to
- // bail out and go through a full diff because we need to unset the old key
- if (patchFlag & PatchFlags.PROPS) {
- // if the flag is present then dynamicProps must be non-null
- const propsToUpdate = n2.dynamicProps!
- for (let i = 0; i < propsToUpdate.length; i++) {
- const key = propsToUpdate[i]
- const prev = oldProps[key]
- const next = newProps[key]
- if (
- next !== prev ||
- (hostForcePatchProp && hostForcePatchProp(el, key))
- ) {
- hostPatchProp(
- el,
- key,
- prev,
- next,
- isSVG,
- n1.children as VNode[],
- parentComponent,
- parentSuspense,
- unmountChildren
- )
- }
- }
- }
- }
- // text
- // This flag is matched when the element has only dynamic text children.
- if (patchFlag & PatchFlags.TEXT) {
- if (n1.children !== n2.children) {
- hostSetElementText(el, n2.children as string)
- }
- }
- } else if (!optimized && dynamicChildren == null) {
- // unoptimized, full diff
- patchProps(
- el,
- n2,
- oldProps,
- newProps,
- parentComponent,
- parentSuspense,
- isSVG
- )
- }
- const areChildrenSVG = isSVG && n2.type !== 'foreignObject'
- if (dynamicChildren) {
- patchBlockChildren(
- n1.dynamicChildren!,
- dynamicChildren,
- el,
- parentComponent,
- parentSuspense,
- areChildrenSVG
- )
- if (__DEV__ && parentComponent && parentComponent.type.__hmrId) {
- traverseStaticChildren(n1, n2)
- }
- } else if (!optimized) {
- // full diff
- patchChildren(
- n1,
- n2,
- el,
- null,
- parentComponent,
- parentSuspense,
- areChildrenSVG
- )
- }
- if ((vnodeHook = newProps.onVnodeUpdated) || dirs) {
- queuePostRenderEffect(() => {
- vnodeHook && invokeVNodeHook(vnodeHook, parentComponent, n2, n1)
- dirs && invokeDirectiveHook(n2, n1, parentComponent, 'updated')
- }, parentSuspense)
- }
- }
- // The fast path for blocks.
- const patchBlockChildren: PatchBlockChildrenFn = (
- oldChildren,
- newChildren,
- fallbackContainer,
- parentComponent,
- parentSuspense,
- isSVG
- ) => {
- for (let i = 0; i < newChildren.length; i++) {
- const oldVNode = oldChildren[i]
- const newVNode = newChildren[i]
- // Determine the container (parent element) for the patch.
- const container =
- // - In the case of a Fragment, we need to provide the actual parent
- // of the Fragment itself so it can move its children.
- oldVNode.type === Fragment ||
- // - In the case of different nodes, there is going to be a replacement
- // which also requires the correct parent container
- !isSameVNodeType(oldVNode, newVNode) ||
- // - In the case of a component, it could contain anything.
- oldVNode.shapeFlag & ShapeFlags.COMPONENT ||
- oldVNode.shapeFlag & ShapeFlags.TELEPORT
- ? hostParentNode(oldVNode.el!)!
- : // In other cases, the parent container is not actually used so we
- // just pass the block element here to avoid a DOM parentNode call.
- fallbackContainer
- patch(
- oldVNode,
- newVNode,
- container,
- null,
- parentComponent,
- parentSuspense,
- isSVG,
- true
- )
- }
- }
- const patchProps = (
- el: RendererElement,
- vnode: VNode,
- oldProps: Data,
- newProps: Data,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean
- ) => {
- if (oldProps !== newProps) {
- for (const key in newProps) {
- // empty string is not valid prop
- if (isReservedProp(key)) continue
- const next = newProps[key]
- const prev = oldProps[key]
- if (
- next !== prev ||
- (hostForcePatchProp && hostForcePatchProp(el, key))
- ) {
- hostPatchProp(
- el,
- key,
- prev,
- next,
- isSVG,
- vnode.children as VNode[],
- parentComponent,
- parentSuspense,
- unmountChildren
- )
- }
- }
- if (oldProps !== EMPTY_OBJ) {
- for (const key in oldProps) {
- if (!isReservedProp(key) && !(key in newProps)) {
- hostPatchProp(
- el,
- key,
- oldProps[key],
- null,
- isSVG,
- vnode.children as VNode[],
- parentComponent,
- parentSuspense,
- unmountChildren
- )
- }
- }
- }
- }
- }
- const processFragment = (
- n1: VNode | null,
- n2: VNode,
- container: RendererElement,
- anchor: RendererNode | null,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean,
- optimized: boolean
- ) => {
- const fragmentStartAnchor = (n2.el = n1 ? n1.el : hostCreateText(''))!
- const fragmentEndAnchor = (n2.anchor = n1 ? n1.anchor : hostCreateText(''))!
- let { patchFlag, dynamicChildren } = n2
- if (patchFlag > 0) {
- optimized = true
- }
- if (__DEV__ && isHmrUpdating) {
- // HMR updated, force full diff
- patchFlag = 0
- optimized = false
- dynamicChildren = null
- }
- if (n1 == null) {
- hostInsert(fragmentStartAnchor, container, anchor)
- hostInsert(fragmentEndAnchor, container, anchor)
- // a fragment can only have array children
- // since they are either generated by the compiler, or implicitly created
- // from arrays.
- mountChildren(
- n2.children as VNodeArrayChildren,
- container,
- fragmentEndAnchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- } else {
- if (
- patchFlag > 0 &&
- patchFlag & PatchFlags.STABLE_FRAGMENT &&
- dynamicChildren &&
- // #2715 the previous fragment could've been a BAILed one as a result
- // of renderSlot() with no valid children
- n1.dynamicChildren
- ) {
- // a stable fragment (template root or <template v-for>) doesn't need to
- // patch children order, but it may contain dynamicChildren.
- patchBlockChildren(
- n1.dynamicChildren,
- dynamicChildren,
- container,
- parentComponent,
- parentSuspense,
- isSVG
- )
- if (__DEV__ && parentComponent && parentComponent.type.__hmrId) {
- traverseStaticChildren(n1, n2)
- } else if (
- // #2080 if the stable fragment has a key, it's a <template v-for> that may
- // get moved around. Make sure all root level vnodes inherit el.
- // #2134 or if it's a component root, it may also get moved around
- // as the component is being moved.
- n2.key != null ||
- (parentComponent && n2 === parentComponent.subTree)
- ) {
- traverseStaticChildren(n1, n2, true /* shallow */)
- }
- } else {
- // keyed / unkeyed, or manual fragments.
- // for keyed & unkeyed, since they are compiler generated from v-for,
- // each child is guaranteed to be a block so the fragment will never
- // have dynamicChildren.
- patchChildren(
- n1,
- n2,
- container,
- fragmentEndAnchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- }
- }
- }
- const processComponent = (
- n1: VNode | null,
- n2: VNode,
- container: RendererElement,
- anchor: RendererNode | null,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean,
- optimized: boolean
- ) => {
- if (n1 == null) {
- if (n2.shapeFlag & ShapeFlags.COMPONENT_KEPT_ALIVE) {
- ;(parentComponent!.ctx as KeepAliveContext).activate(
- n2,
- container,
- anchor,
- isSVG,
- optimized
- )
- } else {
- mountComponent(
- n2,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- }
- } else {
- updateComponent(n1, n2, optimized)
- }
- }
- const mountComponent: MountComponentFn = (
- initialVNode,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- ) => {
- const instance: ComponentInternalInstance = (initialVNode.component = createComponentInstance(
- initialVNode,
- parentComponent,
- parentSuspense
- ))
- if (__DEV__ && instance.type.__hmrId) {
- registerHMR(instance)
- }
- if (__DEV__) {
- pushWarningContext(initialVNode)
- startMeasure(instance, `mount`)
- }
- // inject renderer internals for keepAlive
- if (isKeepAlive(initialVNode)) {
- ;(instance.ctx as KeepAliveContext).renderer = internals
- }
- // resolve props and slots for setup context
- if (__DEV__) {
- startMeasure(instance, `init`)
- }
- setupComponent(instance)
- if (__DEV__) {
- endMeasure(instance, `init`)
- }
- // setup() is async. This component relies on async logic to be resolved
- // before proceeding
- if (__FEATURE_SUSPENSE__ && instance.asyncDep) {
- parentSuspense && parentSuspense.registerDep(instance, setupRenderEffect)
- // Give it a placeholder if this is not hydration
- // TODO handle self-defined fallback
- if (!initialVNode.el) {
- const placeholder = (instance.subTree = createVNode(Comment))
- processCommentNode(null, placeholder, container!, anchor)
- }
- return
- }
- setupRenderEffect(
- instance,
- initialVNode,
- container,
- anchor,
- parentSuspense,
- isSVG,
- optimized
- )
- if (__DEV__) {
- popWarningContext()
- endMeasure(instance, `mount`)
- }
- }
- const updateComponent = (n1: VNode, n2: VNode, optimized: boolean) => {
- const instance = (n2.component = n1.component)!
- if (shouldUpdateComponent(n1, n2, optimized)) {
- if (
- __FEATURE_SUSPENSE__ &&
- instance.asyncDep &&
- !instance.asyncResolved
- ) {
- // async & still pending - just update props and slots
- // since the component's reactive effect for render isn't set-up yet
- if (__DEV__) {
- pushWarningContext(n2)
- }
- updateComponentPreRender(instance, n2, optimized)
- if (__DEV__) {
- popWarningContext()
- }
- return
- } else {
- // normal update
- instance.next = n2
- // in case the child component is also queued, remove it to avoid
- // double updating the same child component in the same flush.
- invalidateJob(instance.update)
- // instance.update is the reactive effect runner.
- instance.update()
- }
- } else {
- // no update needed. just copy over properties
- n2.component = n1.component
- n2.el = n1.el
- instance.vnode = n2
- }
- }
- const setupRenderEffect: SetupRenderEffectFn = (
- instance,
- initialVNode,
- container,
- anchor,
- parentSuspense,
- isSVG,
- optimized
- ) => {
- // create reactive effect for rendering
- instance.update = effect(function componentEffect() {
- if (!instance.isMounted) {
- let vnodeHook: VNodeHook | null | undefined
- const { el, props } = initialVNode
- const { bm, m, parent } = instance
- // beforeMount hook
- if (bm) {
- invokeArrayFns(bm)
- }
- // onVnodeBeforeMount
- if ((vnodeHook = props && props.onVnodeBeforeMount)) {
- invokeVNodeHook(vnodeHook, parent, initialVNode)
- }
- // render
- if (__DEV__) {
- startMeasure(instance, `render`)
- }
- const subTree = (instance.subTree = renderComponentRoot(instance))
- if (__DEV__) {
- endMeasure(instance, `render`)
- }
- if (el && hydrateNode) {
- if (__DEV__) {
- startMeasure(instance, `hydrate`)
- }
- // vnode has adopted host node - perform hydration instead of mount.
- hydrateNode(
- initialVNode.el as Node,
- subTree,
- instance,
- parentSuspense
- )
- if (__DEV__) {
- endMeasure(instance, `hydrate`)
- }
- } else {
- if (__DEV__) {
- startMeasure(instance, `patch`)
- }
- patch(
- null,
- subTree,
- container,
- anchor,
- instance,
- parentSuspense,
- isSVG
- )
- if (__DEV__) {
- endMeasure(instance, `patch`)
- }
- initialVNode.el = subTree.el
- }
- // mounted hook
- if (m) {
- queuePostRenderEffect(m, parentSuspense)
- }
- // onVnodeMounted
- if ((vnodeHook = props && props.onVnodeMounted)) {
- queuePostRenderEffect(() => {
- invokeVNodeHook(vnodeHook!, parent, initialVNode)
- }, parentSuspense)
- }
- // activated hook for keep-alive roots.
- // #1742 activated hook must be accessed after first render
- // since the hook may be injected by a child keep-alive
- const { a } = instance
- if (
- a &&
- initialVNode.shapeFlag & ShapeFlags.COMPONENT_SHOULD_KEEP_ALIVE
- ) {
- queuePostRenderEffect(a, parentSuspense)
- }
- instance.isMounted = true
- } else {
- // updateComponent
- // This is triggered by mutation of component's own state (next: null)
- // OR parent calling processComponent (next: VNode)
- let { next, bu, u, parent, vnode } = instance
- let originNext = next
- let vnodeHook: VNodeHook | null | undefined
- if (__DEV__) {
- pushWarningContext(next || instance.vnode)
- }
- if (next) {
- next.el = vnode.el
- updateComponentPreRender(instance, next, optimized)
- } else {
- next = vnode
- }
- // beforeUpdate hook
- if (bu) {
- invokeArrayFns(bu)
- }
- // onVnodeBeforeUpdate
- if ((vnodeHook = next.props && next.props.onVnodeBeforeUpdate)) {
- invokeVNodeHook(vnodeHook, parent, next, vnode)
- }
- // render
- if (__DEV__) {
- startMeasure(instance, `render`)
- }
- const nextTree = renderComponentRoot(instance)
- if (__DEV__) {
- endMeasure(instance, `render`)
- }
- const prevTree = instance.subTree
- instance.subTree = nextTree
- if (__DEV__) {
- startMeasure(instance, `patch`)
- }
- patch(
- prevTree,
- nextTree,
- // parent may have changed if it's in a teleport
- hostParentNode(prevTree.el!)!,
- // anchor may have changed if it's in a fragment
- getNextHostNode(prevTree),
- instance,
- parentSuspense,
- isSVG
- )
- if (__DEV__) {
- endMeasure(instance, `patch`)
- }
- next.el = nextTree.el
- if (originNext === null) {
- // self-triggered update. In case of HOC, update parent component
- // vnode el. HOC is indicated by parent instance's subTree pointing
- // to child component's vnode
- updateHOCHostEl(instance, nextTree.el)
- }
- // updated hook
- if (u) {
- queuePostRenderEffect(u, parentSuspense)
- }
- // onVnodeUpdated
- if ((vnodeHook = next.props && next.props.onVnodeUpdated)) {
- queuePostRenderEffect(() => {
- invokeVNodeHook(vnodeHook!, parent, next!, vnode)
- }, parentSuspense)
- }
- if (__DEV__ || __FEATURE_PROD_DEVTOOLS__) {
- devtoolsComponentUpdated(instance)
- }
- if (__DEV__) {
- popWarningContext()
- }
- }
- }, __DEV__ ? createDevEffectOptions(instance) : prodEffectOptions)
- }
- const updateComponentPreRender = (
- instance: ComponentInternalInstance,
- nextVNode: VNode,
- optimized: boolean
- ) => {
- nextVNode.component = instance
- const prevProps = instance.vnode.props
- instance.vnode = nextVNode
- instance.next = null
- updateProps(instance, nextVNode.props, prevProps, optimized)
- updateSlots(instance, nextVNode.children)
- // props update may have triggered pre-flush watchers.
- // flush them before the render update.
- flushPreFlushCbs(undefined, instance.update)
- }
- const patchChildren: PatchChildrenFn = (
- n1,
- n2,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized = false
- ) => {
- const c1 = n1 && n1.children
- const prevShapeFlag = n1 ? n1.shapeFlag : 0
- const c2 = n2.children
- const { patchFlag, shapeFlag } = n2
- // fast path
- if (patchFlag > 0) {
- if (patchFlag & PatchFlags.KEYED_FRAGMENT) {
- // this could be either fully-keyed or mixed (some keyed some not)
- // presence of patchFlag means children are guaranteed to be arrays
- patchKeyedChildren(
- c1 as VNode[],
- c2 as VNodeArrayChildren,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- return
- } else if (patchFlag & PatchFlags.UNKEYED_FRAGMENT) {
- // unkeyed
- patchUnkeyedChildren(
- c1 as VNode[],
- c2 as VNodeArrayChildren,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- return
- }
- }
- // children has 3 possibilities: text, array or no children.
- if (shapeFlag & ShapeFlags.TEXT_CHILDREN) {
- // text children fast path
- if (prevShapeFlag & ShapeFlags.ARRAY_CHILDREN) {
- unmountChildren(c1 as VNode[], parentComponent, parentSuspense)
- }
- if (c2 !== c1) {
- hostSetElementText(container, c2 as string)
- }
- } else {
- if (prevShapeFlag & ShapeFlags.ARRAY_CHILDREN) {
- // prev children was array
- if (shapeFlag & ShapeFlags.ARRAY_CHILDREN) {
- // two arrays, cannot assume anything, do full diff
- patchKeyedChildren(
- c1 as VNode[],
- c2 as VNodeArrayChildren,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- } else {
- // no new children, just unmount old
- unmountChildren(c1 as VNode[], parentComponent, parentSuspense, true)
- }
- } else {
- // prev children was text OR null
- // new children is array OR null
- if (prevShapeFlag & ShapeFlags.TEXT_CHILDREN) {
- hostSetElementText(container, '')
- }
- // mount new if array
- if (shapeFlag & ShapeFlags.ARRAY_CHILDREN) {
- mountChildren(
- c2 as VNodeArrayChildren,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- }
- }
- }
- }
- const patchUnkeyedChildren = (
- c1: VNode[],
- c2: VNodeArrayChildren,
- container: RendererElement,
- anchor: RendererNode | null,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean,
- optimized: boolean
- ) => {
- c1 = c1 || EMPTY_ARR
- c2 = c2 || EMPTY_ARR
- const oldLength = c1.length
- const newLength = c2.length
- const commonLength = Math.min(oldLength, newLength)
- let i
- for (i = 0; i < commonLength; i++) {
- const nextChild = (c2[i] = optimized
- ? cloneIfMounted(c2[i] as VNode)
- : normalizeVNode(c2[i]))
- patch(
- c1[i],
- nextChild,
- container,
- null,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- }
- if (oldLength > newLength) {
- // remove old
- unmountChildren(
- c1,
- parentComponent,
- parentSuspense,
- true,
- false,
- commonLength
- )
- } else {
- // mount new
- mountChildren(
- c2,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized,
- commonLength
- )
- }
- }
- // can be all-keyed or mixed
- const patchKeyedChildren = (
- c1: VNode[],
- c2: VNodeArrayChildren,
- container: RendererElement,
- parentAnchor: RendererNode | null,
- parentComponent: ComponentInternalInstance | null,
- parentSuspense: SuspenseBoundary | null,
- isSVG: boolean,
- optimized: boolean
- ) => {
- let i = 0
- const l2 = c2.length
- let e1 = c1.length - 1 // prev ending index
- let e2 = l2 - 1 // next ending index
- // 1. sync from start
- // (a b) c
- // (a b) d e
- while (i <= e1 && i <= e2) {
- const n1 = c1[i]
- const n2 = (c2[i] = optimized
- ? cloneIfMounted(c2[i] as VNode)
- : normalizeVNode(c2[i]))
- if (isSameVNodeType(n1, n2)) {
- patch(
- n1,
- n2,
- container,
- null,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- } else {
- break
- }
- i++
- }
- // 2. sync from end
- // a (b c)
- // d e (b c)
- while (i <= e1 && i <= e2) {
- const n1 = c1[e1]
- const n2 = (c2[e2] = optimized
- ? cloneIfMounted(c2[e2] as VNode)
- : normalizeVNode(c2[e2]))
- if (isSameVNodeType(n1, n2)) {
- patch(
- n1,
- n2,
- container,
- null,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- } else {
- break
- }
- e1--
- e2--
- }
- // 3. common sequence + mount
- // (a b)
- // (a b) c
- // i = 2, e1 = 1, e2 = 2
- // (a b)
- // c (a b)
- // i = 0, e1 = -1, e2 = 0
- if (i > e1) {
- if (i <= e2) {
- const nextPos = e2 + 1
- const anchor = nextPos < l2 ? (c2[nextPos] as VNode).el : parentAnchor
- while (i <= e2) {
- patch(
- null,
- (c2[i] = optimized
- ? cloneIfMounted(c2[i] as VNode)
- : normalizeVNode(c2[i])),
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG
- )
- i++
- }
- }
- }
- // 4. common sequence + unmount
- // (a b) c
- // (a b)
- // i = 2, e1 = 2, e2 = 1
- // a (b c)
- // (b c)
- // i = 0, e1 = 0, e2 = -1
- else if (i > e2) {
- while (i <= e1) {
- unmount(c1[i], parentComponent, parentSuspense, true)
- i++
- }
- }
- // 5. unknown sequence
- // [i ... e1 + 1]: a b [c d e] f g
- // [i ... e2 + 1]: a b [e d c h] f g
- // i = 2, e1 = 4, e2 = 5
- else {
- const s1 = i // prev starting index
- const s2 = i // next starting index
- // 5.1 build key:index map for newChildren
- const keyToNewIndexMap: Map<string | number, number> = new Map()
- for (i = s2; i <= e2; i++) {
- const nextChild = (c2[i] = optimized
- ? cloneIfMounted(c2[i] as VNode)
- : normalizeVNode(c2[i]))
- if (nextChild.key != null) {
- if (__DEV__ && keyToNewIndexMap.has(nextChild.key)) {
- warn(
- `Duplicate keys found during update:`,
- JSON.stringify(nextChild.key),
- `Make sure keys are unique.`
- )
- }
- keyToNewIndexMap.set(nextChild.key, i)
- }
- }
- // 5.2 loop through old children left to be patched and try to patch
- // matching nodes & remove nodes that are no longer present
- let j
- let patched = 0
- const toBePatched = e2 - s2 + 1
- let moved = false
- // used to track whether any node has moved
- let maxNewIndexSoFar = 0
- // works as Map<newIndex, oldIndex>
- // Note that oldIndex is offset by +1
- // and oldIndex = 0 is a special value indicating the new node has
- // no corresponding old node.
- // used for determining longest stable subsequence
- const newIndexToOldIndexMap = new Array(toBePatched)
- for (i = 0; i < toBePatched; i++) newIndexToOldIndexMap[i] = 0
- for (i = s1; i <= e1; i++) {
- const prevChild = c1[i]
- if (patched >= toBePatched) {
- // all new children have been patched so this can only be a removal
- unmount(prevChild, parentComponent, parentSuspense, true)
- continue
- }
- let newIndex
- if (prevChild.key != null) {
- newIndex = keyToNewIndexMap.get(prevChild.key)
- } else {
- // key-less node, try to locate a key-less node of the same type
- for (j = s2; j <= e2; j++) {
- if (
- newIndexToOldIndexMap[j - s2] === 0 &&
- isSameVNodeType(prevChild, c2[j] as VNode)
- ) {
- newIndex = j
- break
- }
- }
- }
- if (newIndex === undefined) {
- unmount(prevChild, parentComponent, parentSuspense, true)
- } else {
- newIndexToOldIndexMap[newIndex - s2] = i + 1
- if (newIndex >= maxNewIndexSoFar) {
- maxNewIndexSoFar = newIndex
- } else {
- moved = true
- }
- patch(
- prevChild,
- c2[newIndex] as VNode,
- container,
- null,
- parentComponent,
- parentSuspense,
- isSVG,
- optimized
- )
- patched++
- }
- }
- // 5.3 move and mount
- // generate longest stable subsequence only when nodes have moved
- const increasingNewIndexSequence = moved
- ? getSequence(newIndexToOldIndexMap)
- : EMPTY_ARR
- j = increasingNewIndexSequence.length - 1
- // looping backwards so that we can use last patched node as anchor
- for (i = toBePatched - 1; i >= 0; i--) {
- const nextIndex = s2 + i
- const nextChild = c2[nextIndex] as VNode
- const anchor =
- nextIndex + 1 < l2 ? (c2[nextIndex + 1] as VNode).el : parentAnchor
- if (newIndexToOldIndexMap[i] === 0) {
- // mount new
- patch(
- null,
- nextChild,
- container,
- anchor,
- parentComponent,
- parentSuspense,
- isSVG
- )
- } else if (moved) {
- // move if:
- // There is no stable subsequence (e.g. a reverse)
- // OR current node is not among the stable sequence
- if (j < 0 || i !== increasingNewIndexSequence[j]) {
- move(nextChild, container, anchor, MoveType.REORDER)
- } else {
- j--
- }
- }
- }
- }
- }
- const move: MoveFn = (
- vnode,
- container,
- anchor,
- moveType,
- parentSuspense = null
- ) => {
- const { el, type, transition, children, shapeFlag } = vnode
- if (shapeFlag & ShapeFlags.COMPONENT) {
- move(vnode.component!.subTree, container, anchor, moveType)
- return
- }
- if (__FEATURE_SUSPENSE__ && shapeFlag & ShapeFlags.SUSPENSE) {
- vnode.suspense!.move(container, anchor, moveType)
- return
- }
- if (shapeFlag & ShapeFlags.TELEPORT) {
- ;(type as typeof TeleportImpl).move(vnode, container, anchor, internals)
- return
- }
- if (type === Fragment) {
- hostInsert(el!, container, anchor)
- for (let i = 0; i < (children as VNode[]).length; i++) {
- move((children as VNode[])[i], container, anchor, moveType)
- }
- hostInsert(vnode.anchor!, container, anchor)
- return
- }
- if (type === Static) {
- moveStaticNode(vnode, container, anchor)
- return
- }
- // single nodes
- const needTransition =
- moveType !== MoveType.REORDER &&
- shapeFlag & ShapeFlags.ELEMENT &&
- transition
- if (needTransition) {
- if (moveType === MoveType.ENTER) {
- transition!.beforeEnter(el!)
- hostInsert(el!, container, anchor)
- queuePostRenderEffect(() => transition!.enter(el!), parentSuspense)
- } else {
- const { leave, delayLeave, afterLeave } = transition!
- const remove = () => hostInsert(el!, container, anchor)
- const performLeave = () => {
- leave(el!, () => {
- remove()
- afterLeave && afterLeave()
- })
- }
- if (delayLeave) {
- delayLeave(el!, remove, performLeave)
- } else {
- performLeave()
- }
- }
- } else {
- hostInsert(el!, container, anchor)
- }
- }
- const unmount: UnmountFn = (
- vnode,
- parentComponent,
- parentSuspense,
- doRemove = false,
- optimized = false
- ) => {
- const {
- type,
- props,
- ref,
- children,
- dynamicChildren,
- shapeFlag,
- patchFlag,
- dirs
- } = vnode
- // unset ref
- if (ref != null) {
- setRef(ref, null, parentSuspense, null)
- }
- if (shapeFlag & ShapeFlags.COMPONENT_SHOULD_KEEP_ALIVE) {
- ;(parentComponent!.ctx as KeepAliveContext).deactivate(vnode)
- return
- }
- const shouldInvokeDirs = shapeFlag & ShapeFlags.ELEMENT && dirs
- let vnodeHook: VNodeHook | undefined | null
- if ((vnodeHook = props && props.onVnodeBeforeUnmount)) {
- invokeVNodeHook(vnodeHook, parentComponent, vnode)
- }
- if (shapeFlag & ShapeFlags.COMPONENT) {
- unmountComponent(vnode.component!, parentSuspense, doRemove)
- } else {
- if (__FEATURE_SUSPENSE__ && shapeFlag & ShapeFlags.SUSPENSE) {
- vnode.suspense!.unmount(parentSuspense, doRemove)
- return
- }
- if (shouldInvokeDirs) {
- invokeDirectiveHook(vnode, null, parentComponent, 'beforeUnmount')
- }
- if (
- dynamicChildren &&
- // #1153: fast path should not be taken for non-stable (v-for) fragments
- (type !== Fragment ||
- (patchFlag > 0 && patchFlag & PatchFlags.STABLE_FRAGMENT))
- ) {
- // fast path for block nodes: only need to unmount dynamic children.
- unmountChildren(
- dynamicChildren,
- parentComponent,
- parentSuspense,
- false,
- true
- )
- } else if (
- (type === Fragment &&
- (patchFlag & PatchFlags.KEYED_FRAGMENT ||
- patchFlag & PatchFlags.UNKEYED_FRAGMENT)) ||
- (!optimized && shapeFlag & ShapeFlags.ARRAY_CHILDREN)
- ) {
- unmountChildren(children as VNode[], parentComponent, parentSuspense)
- }
- // an unmounted teleport should always remove its children if not disabled
- if (
- shapeFlag & ShapeFlags.TELEPORT &&
- (doRemove || !isTeleportDisabled(vnode.props))
- ) {
- ;(vnode.type as typeof TeleportImpl).remove(vnode, internals)
- }
- if (doRemove) {
- remove(vnode)
- }
- }
- if ((vnodeHook = props && props.onVnodeUnmounted) || shouldInvokeDirs) {
- queuePostRenderEffect(() => {
- vnodeHook && invokeVNodeHook(vnodeHook, parentComponent, vnode)
- shouldInvokeDirs &&
- invokeDirectiveHook(vnode, null, parentComponent, 'unmounted')
- }, parentSuspense)
- }
- }
- const remove: RemoveFn = vnode => {
- const { type, el, anchor, transition } = vnode
- if (type === Fragment) {
- removeFragment(el!, anchor!)
- return
- }
- if (type === Static) {
- removeStaticNode(vnode)
- return
- }
- const performRemove = () => {
- hostRemove(el!)
- if (transition && !transition.persisted && transition.afterLeave) {
- transition.afterLeave()
- }
- }
- if (
- vnode.shapeFlag & ShapeFlags.ELEMENT &&
- transition &&
- !transition.persisted
- ) {
- const { leave, delayLeave } = transition
- const performLeave = () => leave(el!, performRemove)
- if (delayLeave) {
- delayLeave(vnode.el!, performRemove, performLeave)
- } else {
- performLeave()
- }
- } else {
- performRemove()
- }
- }
- const removeFragment = (cur: RendererNode, end: RendererNode) => {
- // For fragments, directly remove all contained DOM nodes.
- // (fragment child nodes cannot have transition)
- let next
- while (cur !== end) {
- next = hostNextSibling(cur)!
- hostRemove(cur)
- cur = next
- }
- hostRemove(end)
- }
- const unmountComponent = (
- instance: ComponentInternalInstance,
- parentSuspense: SuspenseBoundary | null,
- doRemove?: boolean
- ) => {
- if (__DEV__ && instance.type.__hmrId) {
- unregisterHMR(instance)
- }
- const { bum, effects, update, subTree, um } = instance
- // beforeUnmount hook
- if (bum) {
- invokeArrayFns(bum)
- }
- if (effects) {
- for (let i = 0; i < effects.length; i++) {
- stop(effects[i])
- }
- }
- // update may be null if a component is unmounted before its async
- // setup has resolved.
- if (update) {
- stop(update)
- unmount(subTree, instance, parentSuspense, doRemove)
- }
- // unmounted hook
- if (um) {
- queuePostRenderEffect(um, parentSuspense)
- }
- queuePostRenderEffect(() => {
- instance.isUnmounted = true
- }, parentSuspense)
- // A component with async dep inside a pending suspense is unmounted before
- // its async dep resolves. This should remove the dep from the suspense, and
- // cause the suspense to resolve immediately if that was the last dep.
- if (
- __FEATURE_SUSPENSE__ &&
- parentSuspense &&
- parentSuspense.pendingBranch &&
- !parentSuspense.isUnmounted &&
- instance.asyncDep &&
- !instance.asyncResolved &&
- instance.suspenseId === parentSuspense.pendingId
- ) {
- parentSuspense.deps--
- if (parentSuspense.deps === 0) {
- parentSuspense.resolve()
- }
- }
- if (__DEV__ || __FEATURE_PROD_DEVTOOLS__) {
- devtoolsComponentRemoved(instance)
- }
- }
- const unmountChildren: UnmountChildrenFn = (
- children,
- parentComponent,
- parentSuspense,
- doRemove = false,
- optimized = false,
- start = 0
- ) => {
- for (let i = start; i < children.length; i++) {
- unmount(children[i], parentComponent, parentSuspense, doRemove, optimized)
- }
- }
- const getNextHostNode: NextFn = vnode => {
- if (vnode.shapeFlag & ShapeFlags.COMPONENT) {
- return getNextHostNode(vnode.component!.subTree)
- }
- if (__FEATURE_SUSPENSE__ && vnode.shapeFlag & ShapeFlags.SUSPENSE) {
- return vnode.suspense!.next()
- }
- return hostNextSibling((vnode.anchor || vnode.el)!)
- }
- const render: RootRenderFunction = (vnode, container) => {
- if (vnode == null) {
- if (container._vnode) {
- unmount(container._vnode, null, null, true)
- }
- } else {
- patch(container._vnode || null, vnode, container)
- }
- flushPostFlushCbs()
- container._vnode = vnode
- }
- const internals: RendererInternals = {
- p: patch,
- um: unmount,
- m: move,
- r: remove,
- mt: mountComponent,
- mc: mountChildren,
- pc: patchChildren,
- pbc: patchBlockChildren,
- n: getNextHostNode,
- o: options
- }
- let hydrate: ReturnType<typeof createHydrationFunctions>[0] | undefined
- let hydrateNode: ReturnType<typeof createHydrationFunctions>[1] | undefined
- if (createHydrationFns) {
- ;[hydrate, hydrateNode] = createHydrationFns(internals as RendererInternals<
- Node,
- Element
- >)
- }
- return {
- render,
- hydrate,
- createApp: createAppAPI(render, hydrate)
- }
- }
- export function invokeVNodeHook(
- hook: VNodeHook,
- instance: ComponentInternalInstance | null,
- vnode: VNode,
- prevVNode: VNode | null = null
- ) {
- callWithAsyncErrorHandling(hook, instance, ErrorCodes.VNODE_HOOK, [
- vnode,
- prevVNode
- ])
- }
- /**
- * #1156
- * When a component is HMR-enabled, we need to make sure that all static nodes
- * inside a block also inherit the DOM element from the previous tree so that
- * HMR updates (which are full updates) can retrieve the element for patching.
- *
- * #2080
- * Inside keyed `template` fragment static children, if a fragment is moved,
- * the children will always moved so that need inherit el form previous nodes
- * to ensure correct moved position.
- */
- export function traverseStaticChildren(n1: VNode, n2: VNode, shallow = false) {
- const ch1 = n1.children
- const ch2 = n2.children
- if (isArray(ch1) && isArray(ch2)) {
- for (let i = 0; i < ch1.length; i++) {
- // this is only called in the optimized path so array children are
- // guaranteed to be vnodes
- const c1 = ch1[i] as VNode
- let c2 = ch2[i] as VNode
- if (c2.shapeFlag & ShapeFlags.ELEMENT && !c2.dynamicChildren) {
- if (c2.patchFlag <= 0 || c2.patchFlag === PatchFlags.HYDRATE_EVENTS) {
- c2 = ch2[i] = cloneIfMounted(ch2[i] as VNode)
- c2.el = c1.el
- }
- if (!shallow) traverseStaticChildren(c1, c2)
- }
- // also inherit for comment nodes, but not placeholders (e.g. v-if which
- // would have received .el during block patch)
- if (__DEV__ && c2.type === Comment && !c2.el) {
- c2.el = c1.el
- }
- }
- }
- }
- // https://en.wikipedia.org/wiki/Longest_increasing_subsequence
- function getSequence(arr: number[]): number[] {
- const p = arr.slice()
- const result = [0]
- let i, j, u, v, c
- const len = arr.length
- for (i = 0; i < len; i++) {
- const arrI = arr[i]
- if (arrI !== 0) {
- j = result[result.length - 1]
- if (arr[j] < arrI) {
- p[i] = j
- result.push(i)
- continue
- }
- u = 0
- v = result.length - 1
- while (u < v) {
- c = ((u + v) / 2) | 0
- if (arr[result[c]] < arrI) {
- u = c + 1
- } else {
- v = c
- }
- }
- if (arrI < arr[result[u]]) {
- if (u > 0) {
- p[i] = result[u - 1]
- }
- result[u] = i
- }
- }
- }
- u = result.length
- v = result[u - 1]
- while (u-- > 0) {
- result[u] = v
- v = p[v]
- }
- return result
- }
|