For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/reactlynx-testing-library/Interface.RenderHookOptions.md.
Lynx
  • English

      • reactlynx-testing-library / RenderHookOptions

      RenderHookOptions<Props>

      The options for renderHook

      Type Parameters

      Type Parameter
      Props

      Properties

      initialProps?

      optional 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.

      Defined in

      index.d.ts:1347

      wrapper?

      optional wrapper: JSXElementConstructor<object>;

      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.

      Type declaration

      children
      children: ReactNode;

      Example

      import { renderHook } from '@lynx-js/react/testing-library'
import { ThemeProvider } from 'my-ui-lib'
import { TranslationProvider } from 'my-i18n-lib'
import defaultStrings from 'i18n/en-x-default'

const AllTheProviders = ({children}) => {
  return (
    <ThemeProvider theme="light">
      <TranslationProvider messages={defaultStrings}>
        {children}
      </TranslationProvider>
    </ThemeProvider>
  )
}

const customRenderHook = (ui, options) =>
  renderHook(ui, { wrapper: AllTheProviders, ...options })

// re-export everything
export * from '@lynx-js/react/testing-library'

// override renderHook method
export { customRender as renderHook }

      Defined in

      index.d.ts:1380

      Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.