redwoodjs-react-query-provider
TypeScript icon, indicating that this package has built-in type declarations

0.1.2 • Public • Published

RedwoodJS React Query Provider

A provider that replaces RedwoodProvder with react-query + graphql-request

Usage

Install dependencies

$ yarn add react-query graphql-request redwoodjs-react-query-provider

Add to src/index.js

import { AuthProvider } from '@redwoodjs/auth'
import { FatalErrorBoundary } from '@redwoodjs/web'
import { QueryClientProvider, QueryClient } from 'react-query'
import { RedwoodReactQueryProvider } from 'redwoodjs-react-query-provider'
import FatalErrorPage from 'src/pages/FatalErrorPage'
import MainLayout from './layouts/MainLayout/MainLayout'
import ReactDOM from 'react-dom'
import Routes from 'src/Routes'

const queryClient = new QueryClient()

ReactDOM.render(
  <FatalErrorBoundary page={FatalErrorPage}>
    <QueryClientProvider client={queryClient}>
      <AuthProvider client={auth0} type="auth0">
        <RedwoodReactQueryProvider>
          <MainLayout>
            <Routes />
          </MainLayout>
        </RedwoodReactQueryProvider>
      </AuthProvider>
    </QueryClientProvider>
  </FatalErrorBoundary>,
  document.getElementById('redwood-app')
)

Development

This project is bootstrapped using TSDX

If you’re new to TypeScript and React, checkout this handy cheatsheet

Commands

TSDX scaffolds your new library inside /src, and also sets up a Parcel-based playground for it inside /example.

The recommended workflow is to run TSDX in one terminal:

npm start # or yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

Then run the example inside another:

cd example
npm i # or yarn to install dependencies
npm start # or yarn start

The default example imports and live reloads whatever is in /dist, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. No symlinking required, we use Parcel's aliasing.

To do a one-off build, use npm run build or yarn build.

To run tests, use npm test or yarn test.

Configuration

Code quality is set up for you with prettier, husky, and lint-staged. Adjust the respective fields in package.json accordingly.

Jest

Jest tests are set up to run with npm test or yarn test.

Bundle analysis

Calculates the real cost of your library using size-limit with npm run size and visulize it with npm run analyze.

Setup Files

This is the folder structure we set up for you:

/example
  index.html
  index.tsx       # test your component here in a demo app
  package.json
  tsconfig.json
/src
  index.tsx       # EDIT THIS
/test
  blah.test.tsx   # EDIT THIS
.gitignore
package.json
README.md         # EDIT THIS
tsconfig.json

React Testing Library

We do not set up react-testing-library for you yet, we welcome contributions and documentation on this.

Rollup

TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.

TypeScript

tsconfig.json is set up to interpret dom and esnext types, as well as react for jsx. Adjust according to your needs.

Continuous Integration

GitHub Actions

Two actions are added by default:

  • main which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
  • size which comments cost comparison of your library on every pull request using size-limit

Optimizations

Please see the main tsdx optimizations docs. In particular, know that you can take advantage of development-only optimizations:

// ./types/index.d.ts
declare var __DEV__: boolean

// inside your code...
if (__DEV__) {
  console.log('foo')
}

You can also choose to install and use invariant and warning functions.

Module Formats

CJS, ESModules, and UMD module formats are supported.

The appropriate paths are configured in package.json and dist/index.js accordingly. Please report if any issues are found.

Deploying the Example Playground

The Playground is just a simple Parcel app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for manually deploying with the Netlify CLI (npm i -g netlify-cli):

cd example # if not already in the example folder
npm run build # builds to dist
netlify deploy # deploy the dist folder

Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:

netlify init
# build command: yarn build && cd example && yarn && yarn build
# directory to deploy: example/dist
# pick yes for netlify.toml

Named Exports

Per Palmer Group guidelines, always use named exports. Code split inside your React app instead of your React library.

Readme

Keywords

none

Package Sidebar

Install

npm i redwoodjs-react-query-provider

Weekly Downloads

2

Version

0.1.2

License

MIT

Unpacked Size

225 kB

Total Files

12

Last publish

Collaborators

  • marceloalves