Skip to content

fix(runtime-core): the same ref key should save the last non-null val… #1808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions packages/runtime-core/__tests__/apiTemplateRef.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -268,4 +268,68 @@ describe('api: template refs', () => {
// ref should be updated
expect(serializeInner(root)).toBe(`<div id="foo">foo</div>`)
})

// #1789
test('the same ref should save the last non-null value', async () => {
const root = nodeOps.createElement('div')
const toggle = ref(true)
const el = ref(null)

const Comp = {
render() {
return [
h('div', { ref: el }),
toggle.value ? h('div', { ref: el }) : null
]
}
}
render(h(Comp), root)
expect(el.value).toBe(root.children[2])

toggle.value = false
await nextTick()
expect(el.value).toBe(root.children[1])

toggle.value = true
await nextTick()
expect(el.value).toBe(root.children[2])
})

// #1789
test('the same ref should save the last non-null value about setupState', async () => {
const root = nodeOps.createElement('div')
const toggle = ref(true)
const el = ref(null)
let instanceProxy: any

const Comp = {
setup() {
return {
el
}
},
render() {
return [
h('div', { ref: 'el' }),
toggle.value ? h('div', { ref: 'el' }) : null
]
},
mounted() {
instanceProxy = this
}
}
render(h(Comp), root)
expect(el.value).toBe(root.children[2])
expect(instanceProxy.$refs.el).toBe(root.children[2])

toggle.value = false
await nextTick()
expect(el.value).toBe(root.children[1])
expect(instanceProxy.$refs.el).toBe(root.children[1])

toggle.value = true
await nextTick()
expect(el.value).toBe(root.children[2])
expect(instanceProxy.$refs.el).toBe(root.children[2])
})
})
24 changes: 19 additions & 5 deletions packages/runtime-core/src/renderer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -319,14 +319,28 @@ export const setRef = (
}

if (isString(ref)) {
refs[ref] = value
if (hasOwn(setupState, ref)) {
queuePostRenderEffect(() => {
// #1789, should save the last non-null value
if (value == null) {
refs[ref] = value
if (hasOwn(setupState, ref)) {
setupState[ref] = value
}, parentSuspense)
}
return
}
queuePostRenderEffect(() => {
refs[ref] = value
if (hasOwn(setupState, ref)) {
setupState[ref] = value
}
}, parentSuspense)
} else if (isRef(ref)) {
ref.value = value
if (value == null) {
ref.value = value
return
}
queuePostRenderEffect(() => {
ref.value = value
}, parentSuspense)
} else if (isFunction(ref)) {
callWithErrorHandling(ref, parentComponent, ErrorCodes.FUNCTION_REF, [
value,
Expand Down
35 changes: 35 additions & 0 deletions packages/vue/__tests__/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,41 @@ describe('compiler + runtime integration', () => {
expect(one.destroyed).toHaveBeenCalledTimes(0)
})

// #1789
it('$refs should refer to the correct value', async () => {
const container = document.createElement('div')
const toggle = ref(true)
let instanceProxy: any
const App = {
template: `
<div v-if="toggle" ref="divEl">true</div>
<div v-if="!toggle" ref="divEl">false</div>
`,
data() {
return {
toggle
}
},
mounted() {
instanceProxy = this
}
}

createApp(App).mount(container)
expect(container.innerHTML).toBe('<div>true</div><!--v-if-->')
expect(instanceProxy.$refs.divEl).toBe(container.children[0])

toggle.value = false
await nextTick()
expect(container.innerHTML).toBe('<!--v-if--><div>false</div>')
expect(instanceProxy.$refs.divEl).toBe(container.children[0])

toggle.value = true
await nextTick()
expect(container.innerHTML).toBe('<div>true</div><!--v-if-->')
expect(instanceProxy.$refs.divEl).toBe(container.children[0])
})

it('should support runtime template via CSS ID selector', () => {
const container = document.createElement('div')
const template = document.createElement('div')
Expand Down