feat: improve returned type for element getter (#2406)

vuejs · Apr 9, 2024 · 5c22b4e · 5c22b4e
1 parent 4e3bda3
commit 5c22b4e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/src/vueWrapper.ts b/src/vueWrapper.ts
@@ -213,7 +213,7 @@ export class VueWrapper<
     }
   }
 
-  get element(): Element {
+  get element(): T['$el'] {
     // if the component has multiple root elements, we use the parent's element
     return this.hasMultipleRoots ? this.parentElement : this.vm.$el
   }

diff --git a/test-dts/wrapper.d-test.ts b/test-dts/wrapper.d-test.ts
@@ -14,6 +14,16 @@ const domWrapper = wrapper.find('#other')
 let inputMaybe = wrapper.find('input')
 expectType<HTMLInputElement | undefined>(inputMaybe.element)
 
+let buttonComp = mount(
+  defineComponent({ template: '<button>Click me</button>' })
+)
+expectType<HTMLButtonElement>(buttonComp.element)
+
+let multiRootComp = mount(defineComponent({ template: '<span /><span />' }))
+// this will be a wrapper div element like so: <div data-v-app="">
+expectType<HTMLDivElement>(multiRootComp.element)
+expectType<HTMLSpanElement>(multiRootComp.element.firstElementChild)
+
 // SVG element selector
 let lineMaybe = wrapper.find('line')
 expectType<SVGLineElement | undefined>(lineMaybe.element)