use-storybook-testing-library.md

Use storybook testing library package (use-storybook-testing-library)

Included in these configurations:

• addon-interactions
• flat/addon-interactions
• recommended
• flat/recommended

Rule Details

Storybook provides an instrumented version of testing library in the @storybook/test library (formerly available in @storybook/testing-library library). When writing interactions, make sure to use the helper functions from @storybook/test, so that addon-interactions can intercept these helper functions and allow you to step through them when debugging.

Examples of incorrect code for this rule:

// wrong import!
import { within } from '@testing-library/react'

Default.play = async (context) => {
  const canvas = within(context.canvasElement)
}

Examples of correct code for this rule:

// correct import.
import { within } from '@storybook/test'
// or this, which is now considered legacy
import { within } from '@storybook/testing-library'

Default.play = async (context) => {
  const canvas = within(context.canvasElement)
}

When Not To Use It

This rule should not be applied in test files. Please ensure you are defining the storybook rules only for story files. You can see more details here.