Function testComponentSnapshot

testComponentSnapshot(
    name: string,
    Component: ComponentType,
    skip?: boolean,
): void

Test a component snapshot.

Parameters

name: string
Component: ComponentType
skip: boolean = false

Returns void

Example: Use with Storybook stories:

describe("Snapshots", () => {
	storyTable.forEach(([name, Story]) => {
		const StoryComponent = composeStory(Story, Meta);
		testComponentSnapshot(name, StoryComponent, StoryComponent.parameters?.storyshots?.skip);
	});
});

Note

Real timers must be used before taking snapshots. Or set fake timers with vi.useFakeTimers({ shouldAdvanceTime: true });.

Example: Use with fake timers in tests:

describe("Snapshots", () => {
	beforeEach(() => {
		vi.useRealTimers();
	});

	storyTable.forEach(([name, Story]) => {
		const StoryComponent = composeStory(Story, Meta);
		testComponentSnapshot(name, StoryComponent, StoryComponent.parameters?.storyshots?.skip);
	});
});