kotlin-testing-library-react/testing.library.react

Package-level declarations

Types

external interface Config : Config

external interface ConfigFn

HydrateableContainer

typealias HydrateableContainer = Any?

RendererableContainer

typealias RendererableContainer = Any

RenderHookOptions

external interface RenderHookOptions<Props, Container, BaseElement> : RenderOptions<Container, BaseElement>

RenderHookResult

external interface RenderHookResult<Result, Props>

RenderHookResultResult

external interface RenderHookResultResult<Result>

external interface RenderOptions<Container, BaseElement>

external interface RenderResult<Container, BaseElement> : BoundFunctions

Functions

external fun cleanup()

Unmounts React trees that were mounted with render.

external fun configure(configDelta: Config)

external fun configure(configDelta: ConfigFn)

external fun getConfig(): Config

external fun render(ui: ReactNode, options: RenderOptions<*, *>? = definedExternally): RenderResult<*, *>

external fun <Container, BaseElement> render(ui: ReactNode, options: RenderOptions<Container, BaseElement>): RenderResult<Container, BaseElement>

Render into a container which is appended to document.body. It should be used with cleanup.

external fun <Result, Props, Container, BaseElement> renderHook(render: (initialProps: Props) -> Result, options: RenderHookOptions<Props, Container, BaseElement>? = definedExternally): RenderHookResult<Result, Props>

Allows you to render a hook within a test React component without having to create that component yourself.