Function renderStub

docs/tests/setup.browser.tsx:11–56

(args?: {
	props?: RoutesTestStubProps
	entries?: StubRouteEntry[]
	i18n?: {
		lng?: Language
		ns?: Namespace | Namespace[]
	}
})

export type StubRouteEntry = Parameters<typeof createRoutesStub>[0][0]

const renderStub = async (args?: {
	props?: RoutesTestStubProps
	entries?: StubRouteEntry[]
	i18n?: {
		lng?: Language
		ns?: Namespace | Namespace[]
	}
}) => {
	const instance = createInstance()
	// Initialize the i18next instance
	await instance
		.use(initReactI18next) // Tell our instance to use react-i18next
		.init({
			...i18n, // spread the configuration
			lng: args?.i18n?.lng ?? "en", // The locale can be set per test or defaults to english
			ns: args?.i18n?.ns ?? "common", // The namespaces can be set in the test or defaults to common
			resources,
		})

	// We create the entries array to be rendered by react-router
	const entries: StubRouteEntry[] = [
		{
			id: "root",
			path: "/",
			children: args?.entries ?? [],
			Component: () => (
				<div data-testid="root">
					<I18nextProvider i18n={instance}>
						<Outlet />
					</I18nextProvider>
				</div>
			),
		},
	]
	// We generate the props to be passed into the react-router stub
	const props: RoutesTestStubProps = {
		...args?.props,
		initialEntries: args?.props?.initialEntries ?? ["/"],
	}
	// We generate the stub using the entries and props
	const Stub = createRoutesStub(entries)
	// We render the container so it can be used in tests
	const renderedScreen = render(<Stub {...props} />)

	return renderedScreen
}

const renderHook = renderReactHook