@atomic-testing/react-18

Adapter for integrating Atomic Testing with React 18. It maps React components to the core scene part APIs.

The problem

Writing maintainable tests for UIs built with third–party component libraries like Material UI or Bootstrap can be tricky. Documentation on how a test should communicate with these components is often lacking, so tests easily end up coupled to implementation details. As your application grows you need your tests to scale without constantly reworking them.

The solution

Atomic Testing provides a consistent way to interact with both third–party and first–party components across different test environments. It focuses on reusability, composability and adaptability, letting you build higher–level test strategies that work for DOM or end–to–end testing alike.

Installation

npm install @atomic-testing/core @atomic-testing/react-18 --save-dev

Refer to the React integration guide for examples.

Example

If you use MUI/Material UI components, have a look at the @atomic-testing/component-driver-mui-v7 package for a dedicated example.

1. Install the core library and basic HTML drivers along with this React adapter:

   npm install @atomic-testing/core @atomic-testing/react-18 @atomic-testing/component-driver-html --save-dev
   

2. Create a small component and assign data-testid values to the elements you want to interact with:

   import { useState } from 'react';
   
   export function Counter() {
     const [count, setCount] = useState(0);
     return (
       <div>
         <span data-testid='count'>{count}</span>
         <button data-testid='increment' onClick={() => setCount(c => c + 1)}>
           Increment
         </button>
       </div>
     );
   }
   

3. Define a ScenePart describing the count display and button using the HTML drivers:

   import { HTMLButtonDriver, HTMLElementDriver } from '@atomic-testing/component-driver-html';
   import { byDataTestId, ScenePart } from '@atomic-testing/core';
   
   export const counterScenePart = {
     count: { locator: byDataTestId('count'), driver: HTMLElementDriver },
     increment: { locator: byDataTestId('increment'), driver: HTMLButtonDriver },
   } satisfies ScenePart;
   

4. Write a test using createTestEngine to render the component and interact with it:

    import { createTestEngine } from '@atomic-testing/react-18';
   
    import { Counter } from './Counter';
    import { counterScenePart } from './counterScenePart';
   
    test('increments when the button is clicked', async () => {
      const engine = createTestEngine(<Counter />, counterScenePart);
   
      expect(await engine.parts.count.getText()).toBe('0');
      await engine.parts.increment.click();
      expect(await engine.parts.count.getText()).toBe('1');
   
      await engine.cleanUp();
    });
   

For more in‑depth information, visit https://atomic-testing.dev.

Public API & stability

The stable surface of this package is its . barrel exports, frozen under SemVer and machine-checked by the committed API Extractor report at etc/react-18.api.md. Exports tagged @internal are not part of that guarantee. See the 1.0 API freeze & evolution policy.