compose-providers
v1.0.3
Published
My awesome typescript library
Downloads
12
Readme
compose-providers
Compose your React provider components to avoid boilerplates.
Install
npm i compose-providers
Usage
Assume you're using serveral libraries that requires using their provider components like:
- react-error-boundary
- react-intl
- react-query
- react-router
and you have to nest them around your app to get everything work
render(
<ErrorBoundary>
<QueryClientProvider client={queryClient}>
<IntlProvider locale={locale} messages={messages}>
<BrowserRouter>{/** your app */}</BrowserRouter>
</IntlProvider>
</QueryClientProvider>
</ErrorBoundary>,
)
With compose-providers
you can compose those providers into one component so that you get rid of all those boilerplates.
import { composeProviders } from "compose-providers"
const AppContainer = composeProviders([
ErrorBoundary,
// You won't be unfamiliar if you have configured tools like babel/eslint
[
QueryClientProvider,
{
client: queryClient,
},
],
[
IntlProvider,
{
locale,
messages,
},
],
BrowserRouter,
])
render(<AppContainer>{/** your app */}</AppContainer>)
This is especiall useful when you are writing tests and need to combine different providers as wrappers to get your component work:
// RouteComponent.test.tsx
import { render } from "@testing-library/react"
// const wrapper = (props) => (
// <QueryClientProvider>
// <BrowserRouter>{props.children}</BrowserRouter>
// </QueryClientProvider>
// )
const wrapper = composeProviders([QueryClientProvider, BrowserRouter])
render(<RouteComponent />, {
wrapper,
})
// IntlComponent.test.tsx
import { render } from "@testing-library/react"
// const wrapper = (props) => (
// <QueryClientProvider>
// <IntlProvider>{props.children}</IntlProvider>
// </QueryClientProvider>
// )
const wrapper = composeProviders([QueryClientProvider, IntlProvider])
render(<IntlComponent />, {
wrapper,
})
License
MIT © SevenOutman