Skip to content
Merged
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
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -68,9 +68,11 @@
"lodash.merge": "^4.6.2",
"msw": "^1.3.2",
"tsd": "^0.29.0",
"type-fest": "~2.19",
"typescript": "^5.2.2",
"vee-validate": "^4.11.8",
"vue": "^3.3.5",
"vue-component-type-helpers": "^2.0.19",
"vue-eslint-parser": "^9.3.2",
"vue-i18n": "^9.5.0",
"vue-router": "^4.2.5",
2 changes: 1 addition & 1 deletion src/__tests__/render.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {render, cleanup} from '..'
import {h, defineComponent} from 'vue'
import '@testing-library/jest-dom'
import {render, cleanup} from '..'

test('baseElement defaults to document.body', () => {
const {baseElement} = render({template: '<div />'})
27 changes: 22 additions & 5 deletions types/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
// Minimum TypeScript Version: 4.0
/* eslint-disable @typescript-eslint/no-explicit-any */

import {VNodeChild} from 'vue'
import {MountingOptions} from '@vue/test-utils'
import {queries, EventType, BoundFunctions} from '@testing-library/dom'
// eslint-disable-next-line import/no-extraneous-dependencies
import {OptionsReceived as PrettyFormatOptions} from 'pretty-format'
import {ComponentProps, ComponentSlots} from 'vue-component-type-helpers'
import {RemoveIndexSignature} from 'type-fest'

// NOTE: fireEvent is overridden below
export * from '@testing-library/dom'
@@ -44,12 +47,26 @@ interface VueTestingLibraryRenderOptions {
container?: Element
baseElement?: Element
}
export type RenderOptions = VueTestingLibraryRenderOptions &
VueTestUtilsRenderOptions

export function render(
TestComponent: any, // this makes me sad :sob:
options?: RenderOptions,
type AllowNonFunctionSlots<Slots> = {
[K in keyof Slots]: Slots[K] | VNodeChild
}
type ExtractSlots<C> = AllowNonFunctionSlots<
Partial<RemoveIndexSignature<ComponentSlots<C>>>
>

export interface RenderOptions<C>
extends Omit<
VueTestingLibraryRenderOptions & VueTestUtilsRenderOptions,
'props' | 'slots'
> {
props?: ComponentProps<C>
slots?: ExtractSlots<C>
}

export function render<C>(
TestComponent: C,
options?: RenderOptions<C>,
): RenderResult

export type AsyncFireObject = {
2 changes: 1 addition & 1 deletion types/index.test-d.ts
Original file line number Diff line number Diff line change
@@ -68,7 +68,7 @@ export async function testWaitFor() {
export function testOptions() {
render(SomeComponent, {
attrs: {a: 1},
props: {c: 1}, // ideally it would fail because `c` is not an existing prop…
props: {foo: 1},
data: () => ({b: 2}),
slots: {
default: '<div />',