vitest-browser-solid

Render SolidJS components in Vitest Browser Mode. This library follows testing-library principles and exposes only locators and utilities that encourage you to write tests that closely resemble how your SolidJS components are used.

vitest-browser-solid aims to deliver a good developer experience in Vitest Browser Mode by incorporating the locators API and retry-ability mechanism directly into the render result. This allows you to call user methods without needing to verify the element's existence or wait for external events (like API calls) to render the element.

Requires vitest >= 2.1.0, @vitest/browser >= 2.1.0, and solid-js >= 1.8.0.

Tested and developed using vitest 3.1.1, @vitest/browser 3.1.1, and solid-js 1.9.5.

Installation

pnpm add -D vitest-browser-solid

Usage

check render.test.tsx for up to date example.

this library test uses itself to render components in vite browser mode.

Setup

// vitest.config.ts
import { defineConfig } from 'vitest/config'
import solidPlugin from 'vite-plugin-solid' // Use the Solid plugin

export default defineConfig({
  plugins: [
    // Add the Solid plugin
    solidPlugin()
  ],
  test: {
    globals: true,
    browser: {
      provider: "playwright",
      enabled: true,
      instances: [{ browser: "chromium" }],
    },
  },
})

Basic test

import { render } from 'vitest-browser-solid'
import { expect, test } from 'vitest'
import { Counter } from './Counter' // Your SolidJS component

test('counter button increments the count', async () => {
  // JSX containing your component and props
  const screen = render( <Counter initialCount={1} />)

  // Interact using Vitest locators (async)
  await screen.getByRole('button', { name: 'Increment' }).click()

  // Assert using Vitest async assertions (waits automatically)
  await expect.element(screen.getByText('Count is 2')).toBeVisible()
})

Testing Updates

SolidJS updates are driven by fine-grained reactivity. To test component updates:

Pass Signals as Props: Design components to accept signals for props that change.

Modify Signals in Test: Update the signal's value directly in your test code.

Assert on Result: Use await expect.element(...) to verify the DOM updates reactively.

Testing Composables / Primitives

Solid's composable functions or custom primitives (create...) can typically be tested:

Directly: By calling them within createRoot from solid-js if they don't rely on component context.

Via a Small Test Component: Render a minimal component using the composable with render and test its output/behavior.

Inspired by

vitest-browser-react / vitest-browser-vue / vitest-browser-svelte