Packages

trait ReactTestUtils extends ReactTestUtilExtensions

Linear Supertypes
ReactTestUtilExtensions, ReactTestUtilExtensions1, AnyRef, Any
Known Subclasses
ReactTestUtils
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReactTestUtils
  2. ReactTestUtilExtensions
  3. ReactTestUtilExtensions1
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type CompType = ComponentRaw { type Raw <: japgolly.scalajs.react.facade.React.ComponentClassUntyped }
  2. type Mounted = MountedRaw
  3. type MountedOutput = MountedWithRoot[Id, util.DefaultEffects.Async, Object, Object, RawMounted[Object, Object], Object, Object]
  4. type Unmounted[M] = component.Generic.Unmounted[_, M]

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def act[A](body: => A): A

    When writing UI tests, tasks like rendering, user events, or data fetching can be considered as "units" of interaction with a user interface.

    When writing UI tests, tasks like rendering, user events, or data fetching can be considered as "units" of interaction with a user interface. React provides a helper called act() that makes sure all updates related to these "units" have been processed and applied to the DOM before you make any assertions:

    act {
  // render components
}
// make assertions

    This helps make your tests run closer to what real users would experience when using your application.

  5. def actAsync[F[_], A](body: F[A])(implicit F: Async[F]): F[A]

    When writing UI tests, tasks like rendering, user events, or data fetching can be considered as "units" of interaction with a user interface.

    When writing UI tests, tasks like rendering, user events, or data fetching can be considered as "units" of interaction with a user interface. React provides a helper called act() that makes sure all updates related to these "units" have been processed and applied to the DOM before you make any assertions:

    await act(async () => {
  // render components
});
// make assertions

    This helps make your tests run closer to what real users would experience when using your application.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def findAllInRenderedTree(tree: Mounted, test: (MountedOutput) => Boolean): Vector[MountedOutput]

    Traverse all components in tree and accumulate all components where test(component) is true.

    Traverse all components in tree and accumulate all components where test(component) is true. This is not that useful on its own, but it's used as a primitive for other test utils.

  11. def findRenderedComponentWithType(tree: Mounted, c: CompType): MountedOutput

    Same as scryRenderedComponentsWithType() but expects there to be one result and returns that one result, or throws exception if there is any other number of matches besides one.

  12. def findRenderedDOMComponentWithClass(tree: Mounted, className: String): MountedOutput

    Like scryRenderedDOMComponentsWithClass() but expects there to be one result, and returns that one result, or throws exception if there is any other number of matches besides one.

  13. def findRenderedDOMComponentWithTag(tree: Mounted, tagName: String): MountedOutput

    Like scryRenderedDOMComponentsWithTag() but expects there to be one result, and returns that one result, or throws exception if there is any other number of matches besides one.

  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def modifyProps[P, U <: component.Generic.Unmounted[P, M], M <: MountedImpure[P, _]](c: internal.CoreGeneral.GenericComponent[P, Props, U], m: M)(f: (P) => P): M
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def newBodyElement(): Element
  20. def newDocumentElement(): Element
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. implicit final def reactTestExtMountedImpure[A[_], P, S](m: MountedSimple[Id, A, P, S]): ReactTestExt_MountedSimple[Id, A, P, S]
    Definition Classes
    ReactTestUtilExtensions
  24. implicit final def reactTestExtMountedSimple[F[_], A[_], P, S](m: MountedSimple[F, A, P, S]): ReactTestExt_MountedSimple[F, A, P, S]
    Definition Classes
    ReactTestUtilExtensions1
  25. def removeNewBodyElement(e: Element): Unit
  26. def removeNewDocumentElement(e: Element): Unit
  27. def removeReactInternals(html: String): String

    Turn <div data-reactroot="">hello&lt/div> into <div>hello&lt/div>

  28. def renderIntoBody[M](u: Unmounted[M]): M

    Renders a component into the document body via ReactDOM.render().

    Renders a component into the document body via ReactDOM.render().

    Unlike ReactTestUtils.renderIntoDocument(), this allows DOM focus to work.

  29. def renderIntoDocument(e: VdomElement): MountedOutput
  30. def renderIntoDocument[M](unmounted: Unmounted[M]): M

    Render a component into a detached DOM node in the document.

    Render a component into a detached DOM node in the document. This function requires a DOM.

  31. def replaceProps[P, U <: component.Generic.Unmounted[P, M], M <: MountedImpure[P, _]](c: internal.CoreGeneral.GenericComponent[P, Props, U], m: M)(p: P): M
  32. def scryRenderedComponentsWithType(tree: Mounted, c: CompType): Vector[MountedOutput]

    Finds all instances of components with type equal to componentClass.

  33. def scryRenderedDOMComponentsWithClass(tree: Mounted, className: String): Vector[MountedOutput]

    Finds all instance of components in the rendered tree that are DOM components with the class name matching className.

  34. def scryRenderedDOMComponentsWithTag(tree: Mounted, tagName: String): Vector[MountedOutput]

    Finds all instance of components in the rendered tree that are DOM components with the tag name matching tagName.

  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. def unmountRawComponent(c: |[ComponentUntyped, Null]): Unit
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. def withNewBodyElement[A](use: (Element) => A): A
  42. def withNewBodyElementAsync[F[_], A](use: (Element) => F[A])(implicit F: Async[F]): F[A]
  43. def withNewBodyElementFuture[A](use: (Element) => Future[A])(implicit ec: ExecutionContext): Future[A]
  44. def withNewDocumentElement[A](use: (Element) => A): A
  45. def withNewDocumentElementAsync[F[_], A](use: (Element) => F[A])(implicit F: Async[F]): F[A]
  46. def withNewDocumentElementFuture[A](use: (Element) => Future[A])(implicit ec: ExecutionContext): Future[A]
  47. def withRendered[M](u: Unmounted[M], intoBody: Boolean): WithRenderedDsl[M, Element]

    Renders a component then unmounts and cleans up after use.

    Renders a component then unmounts and cleans up after use.

    intoBody

    Whether to use renderIntoBody() or ReactTestUtils.renderIntoDocument().

  48. def withRenderedAsync[M](u: Unmounted[M], intoBody: Boolean): WithRenderedDslF[util.DefaultEffects.Async, M, Element]

    Renders a component then unmounts and cleans up after use.

    Renders a component then unmounts and cleans up after use.

    intoBody

    Whether to use renderIntoBodyAsync() or renderIntoDocumentAsync().

  49. def withRenderedFuture[M, A](u: Unmounted[M], intoBody: Boolean)(f: (M) => Future[A])(implicit ec: ExecutionContext): Future[A]

    Renders a component then unmounts and cleans up after use.

    Renders a component then unmounts and cleans up after use.

    intoBody

    Whether to use renderIntoBodyFuture() or renderIntoDocumentFuture().

  50. def withRenderedIntoBody[M](u: Unmounted[M]): WithRenderedDsl[M, Element]

    Renders a component into the document body via ReactDOM.render(), then unmounts and cleans up after use.

    Renders a component into the document body via ReactDOM.render(), then unmounts and cleans up after use.

    Unlike ReactTestUtils.renderIntoDocument(), this allows DOM focus to work.

  51. def withRenderedIntoBodyAsync[M](u: Unmounted[M]): WithRenderedDslF[util.DefaultEffects.Async, M, Element]

    Renders a component into the document body via ReactDOM.render(), and asynchronously waits for the Async to complete before unmounting.

  52. def withRenderedIntoBodyFuture[M, A](u: Unmounted[M])(f: (M) => Future[A])(implicit ec: ExecutionContext): Future[A]

    Renders a component into the document body via ReactDOM.render(), and asynchronously waits for the Future to complete before unmounting.

  53. def withRenderedIntoDocument[M](u: Unmounted[M]): WithRenderedDsl[M, Element]

    Renders a component into detached DOM via ReactTestUtils.renderIntoDocument(), then unmounts and cleans up after use.

  54. def withRenderedIntoDocumentAsync[M](u: Unmounted[M]): WithRenderedDslF[util.DefaultEffects.Async, M, Element]

    Renders a component into the document body via ReactDOM.render(), and asynchronously waits for the Async to complete before unmounting.

  55. def withRenderedIntoDocumentFuture[M, A](u: Unmounted[M])(f: (M) => Future[A])(implicit ec: ExecutionContext): Future[A]

    Renders a component into detached DOM via ReactTestUtils.renderIntoDocument(), and asynchronously waits for the Future to complete before unmounting.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from ReactTestUtilExtensions

Inherited from ReactTestUtilExtensions1

Inherited from AnyRef

Inherited from Any

Ungrouped