Interface: 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.

wrapper?

optional wrapper?: any

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.

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 { customRenderHook as renderHook }

#Interface: RenderHookOptions<Props>

#Type Parameters

#Properties

#initialProps?