@testing-library/react

property initialProps

initialProps?: Props;

• The argument passed to the renderHook callback. Can be useful if you plan to use the rerender utility to change the values passed to your hook.

property baseElement

baseElement?: BaseElement;

• Defaults to the container if the container is specified. Otherwise document.body is used for the default. This is used as the base element for the queries as well as what is printed when you use debug().

  See Also

  • https://testing-library.com/docs/react-testing-library/api/#baseelement

property container

container?: Container;

• By default, React Testing Library will create a div and append that div to the document.body. Your React component will be rendered in the created div. If you provide your own HTMLElement container via this option, it will not be appended to the document.body automatically.

  For example: If you are unit testing a <tbody> element, it cannot be a child of a div. In this case, you can specify a table as the render container.

  See Also

  • https://testing-library.com/docs/react-testing-library/api/#container

property hydrate

hydrate?: boolean;

• If hydrate is set to true, then it will render with ReactDOM.hydrate. This may be useful if you are using server-side rendering and use ReactDOM.hydrate to mount your components.

  See Also

  • https://testing-library.com/docs/react-testing-library/api/#hydrate)

property legacyRoot

legacyRoot?: boolean;

• Only works if used with React 18. Set to true if you want to force synchronous ReactDOM.render. Otherwise render will default to concurrent React if available.

property queries

queries?: Q;

• Queries to bind. Overrides the default set from DOM Testing Library unless merged.

  See Also

  • https://testing-library.com/docs/react-testing-library/api/#queries

property wrapper

wrapper?: React.JSXElementConstructor<{ children: React.ReactNode }>;

• Pass a React Component as the wrapper option to have it rendered around the inner element. This is most useful for creating reusable custom render functions for common data providers. See setup for examples.

  See Also

  • https://testing-library.com/docs/react-testing-library/api/#wrapper

property hydrate

hydrate?: false | undefined;

• If hydrate is set to true, then it will render with ReactDOM.hydrate. This may be useful if you are using server-side rendering and use ReactDOM.hydrate to mount your components.

  See Also

  • https://testing-library.com/docs/react-testing-library/api/#hydrate)

property hydrate

hydrate?: false | undefined;

• If hydrate is set to true, then it will render with ReactDOM.hydrate. This may be useful if you are using server-side rendering and use ReactDOM.hydrate to mount your components.

  See Also

  • https://testing-library.com/docs/react-testing-library/api/#hydrate)

property reactStrictMode

reactStrictMode: boolean;

call signature

(existingConfig: Config): Partial<Config>;

property hydrate

hydrate: true;

• If hydrate is set to true, then it will render with ReactDOM.hydrate. This may be useful if you are using server-side rendering and use ReactDOM.hydrate to mount your components.

  See Also

  • https://testing-library.com/docs/react-testing-library/api/#hydrate)

property hydrate

hydrate: true;

• If hydrate is set to true, then it will render with ReactDOM.hydrate. This may be useful if you are using server-side rendering and use ReactDOM.hydrate to mount your components.

  See Also

  • https://testing-library.com/docs/react-testing-library/api/#hydrate)

property rerender

rerender: (props?: Props) => void;

• Triggers a re-render. The props will be passed to your renderHook callback.

property result

result: {
    /**
     * The value returned by your renderHook callback
     */
    current: Result;
};

• This is a stable reference to the latest value returned by your renderHook callback

property unmount

unmount: () => void;

• Unmounts the test component. This is useful for when you need to test any cleanup your useEffects have.