react-swr-store

React bindings for swr-store

Install

1npm install --save swr-store react-swr-store

1yarn add swr-store react-swr-store

Usage

1import React, { Suspense } from 'react';
2import { createSWRStore } from 'swr-store';
3import { useSWRStore, SWRStoreRoot } from 'react-swr-store';
4
5const API = 'https://dog.ceo/api/breed/';
6const API_SUFFIX = '/images/random';
7
8interface APIResult {
9  message: string;
10  status: string;
11}
12
13const dogAPI = createSWRStore<APIResult, [string]>({
14  key: (breed: string) => breed,
15  get: async (breed: string) => {
16    const response = await fetch(`${API}${breed}${API_SUFFIX}`);
17    return (await response.json()) as APIResult;
18  },
19  revalidateOnFocus: true,
20  revalidateOnNetwork: true,
21});
22
23function DogImage(): JSX.Element {
24  const data = useSWRStore(dogAPI, ['shiba'], {
25    suspense: true,
26  });
27
28  return <img src={data.message} alt={data.message} />;
29}
30
31function Trigger(): JSX.Element {
32  return (
33    <button
34      type="button"
35      onClick={() => {
36        dogAPI.trigger(['shiba']);
37      }}
38    >
39      Trigger
40    </button>
41  );
42}
43
44export default function App(): JSX.Element {
45  return (
46    <SWRStoreRoot>
47      <Trigger />
48      <div>
49        <Suspense fallback={<h1>Loading...</h1>}>
50          <DogImage />
51        </Suspense>
52      </div>
53    </SWRStoreRoot>
54  );
55}

API

<SWRStoreRoot>

Must be located at the root of the app/tree.

useSWRStore(store, args, options)

Subscribes to an SWR store, passing args, which are received by the corresponding store for data-fetching and cache updates.

options has the following properties:

• suspense: When true, suspends the component when receiving the result, if the result status is 'pending' until the result resolves,where useSWRStore returns the resolved data. Otherwise, useSWRStore returns the result. Defaults to false.
• initialData: Allows lazy hydration when reading the store. If the store does not have cache, initialData hydrates the cache and attempts a revalidation. If no initialData is provided, defaults to store's options.initialData.
• shouldRevalidate: If true, goes through the revalidation process when reading through the cache. Defaults to true.

License

MIT © lxsmnsyc