Search packages, repositories and app categories

Package detailsv3.0.4

over_react_test

A library for testing OverReact components

Web
30-day downloads
9.7K
Likes
1
Pub points
85

Install package

flutter pub add over_react_test

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A testing library designed specifically for OverReact components, enabling developers to write reliable unit and integration tests for React-like UI components in Flutter. It provides utilities to render components, simulate user interactions, and verify output, ensuring component behavior matches expectations. Built by Workiva, it integrates seamlessly with Flutter's testing ecosystem and is tailored for web platforms. The library simplifies testing complex component hierarchies and state management within OverReact applications.

Use cases

  • Testing OverReact component rendering
  • Simulating user interactions like clicks and input
  • Validating component state changes
  • Verifying DOM output in web apps
  • Writing unit and integration tests for UI logic

Key features

  • Component rendering utilities
  • Event simulation helpers
  • DOM assertion tools
  • Web platform optimization
  • Seamless integration with Flutter test framework

Suitable for

  • Flutter developers using OverReact
  • Teams building complex web UIs
  • Test-driven development workflows
  • Frontend teams focused on component reliability

Considerations

  • Limited to web platform
  • Requires OverReact dependency
  • May need additional setup for complex state
  • Best suited for projects already using OverReact

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

OverReact Test

Pub Build Status Documentation

A library for testing OverReact components.

Using it in your project

  1. Import it into your test files:

    import 'package:over_react_test/over_react_test.dart';
    
  2. Run your tests:

    $ dart run test test/your_test_file.dart
    

Naming Conventions

Variables and Types
Usage Actual Type Suggested Referencing
render and render helper functions ReactComponent | Element instance
Component class ReactClass type
VDOM Instance (invoked UiProps) ReactElement -ReactElement or not suffixed
findDomNode, queryByTestId, etc. Element node
The Dart component react.Component (backed by ReactComponent) dartInstance
Invoked UiFactory UiProps builder

Example:

test('my test' () {
  var sampleBuilder = Sample();
  var sampleReactElement = sampleBuilder(); // Or var sample = sampleBuilder();
  var instance = render(sampleInstance);
  SampleComponent sampleDartInstance = getDartComponent(instance);
  var sampleNode = findDomNode(instance);
});
Test IDs

When coming up with test ID strings:

  • DO NOT use spaces; space-delimited strings will be treated as separate test IDs

    Just like CSS class names, you can use multiple test IDs together, and use any one of them to target a given component/node.

  • PREFER following our naming scheme for consistency across projects:

    <library>.<Component>[.<subpart>...].<part>

    We recommend including a library abbreviation and component name within a test ID so that it's easy to track down where that ID came from.

    Namespacing (.<subpart>) can be added however it makes sense.

    Finally, test IDs should be descriptive and useful in the context of tests.

    Examples:

    • wsd.DatepickerPrimitive.goToSelectedButton
    • sox.AbstractDataLayoutGroup.headerBlock.title
  • CONSIDER adding multiple IDs to serve different purposes

    for (var i = 0; i < items.length; i++) {
      // ...
        ..addTestId('foo.Bar.menuItem')
        ..addTestId('foo.Bar.menuItem.$i')
        ..addTestId('foo.Bar.menuItem.${items[i].id}')
      // ...
    }
    

    With the output of above code, you can:

    • target all of the Bar component's menu items using foo.Bar.menuItem
    • target the 4th item using foo.Bar.menuItem.3
    • target the item corresponding to an item with id baz123 using foo.Bar.menuItem.baz123

    This won't always be needed, but it comes in handy in certain cases.

Documentation

You would never skip reading the docs for a new language you are asked to learn, so please don't skip over reading our API documentation either.

Contributing

Yes please! (Please read our contributor guidelines first)

Versioning

The over_react_test library adheres to Semantic Versioning:

  • Any API changes that are not backwards compatible will bump the major version (and reset the minor / patch).
  • Any new functionality that is added in a backwards-compatible manner will bump the minor version (and reset the patch).
  • Any backwards-compatible bug fixes that are added will bump the patch version.

Categories

Dependencies

Dependency list 6 items

Source repository

Projects using this package

No data available yet.