3.14.1 • Published 12 days ago

@shipengine/react-api v3.14.1

Weekly downloads
-
License
-
Repository
-
Last release
12 days ago

ShipEngine React Api

The shipengine/react-api library provides React bindings for the shipengine/js-api client, with the addition of data sharing and cache management via React Query (hereon "RQ").

The client interface is exposed via hooks^1 sharing a single RQ client instance; this allows multiple components to access data from the same ShipEngine API endpoint with a single network request.

For instance, if ComponentA, ComponentB and ComponentC separately invoke the useListShipments hook on a single render, the API requests will be deduped to a single GET /v1/shipments, with all three components sharing the data / loading / error / etc states from the RQ cache. Revalidating the request in one component similarly updates the others.

Basic usage

import { ShipEngine, useListShipments } from "@shipengine/react-api";

const MyComponent = () => {
  const { data, isLoading, error } = useListShipments();

  if (isLoading) return <div>Loading...</div>;
  if (error) return <div>{error.message}</div>;

  console.log(data);
  // > an object matching the response schema of https://shipengine.github.io/shipengine-openapi/#operation/list_shipments

  return <div>Retrieved {data.shipments.length} shipments</div>;
};

const MyApp = () => {
  return (
    <ShipEngine getToken={() => "your-platform-token"}>
      <MyComponent />
      <MyComponent />
      <MyComponent />
      {/* All three components will share the same data and only 1 request will be made */}
    </ShipEngine>
  );
};
@shipengine/elements
3.13.2

22 days ago

3.13.1

22 days ago

3.12.1

27 days ago

3.12.0

28 days ago

3.14.1

12 days ago

3.14.0

14 days ago

3.13.0

26 days ago

3.9.0

4 months ago

3.10.1

3 months ago

3.8.0

5 months ago

3.10.0

4 months ago

3.10.3

2 months ago

3.10.2

3 months ago

3.12.2

27 days ago

3.8.3

4 months ago

3.8.2

5 months ago

3.8.1

5 months ago

3.11.0

2 months ago

3.7.0

6 months ago

3.6.2

7 months ago

3.6.1

7 months ago

3.6.0

8 months ago

3.10.5

2 months ago

3.10.4

2 months ago

3.6.3

6 months ago

3.5.1

8 months ago

3.5.0

8 months ago

3.4.0

9 months ago

3.3.2

9 months ago

2.11.0

1 year ago

2.11.1

1 year ago

3.2.2

10 months ago

3.2.1

10 months ago

3.2.0

10 months ago

3.2.3

9 months ago

2.11.8

12 months ago

2.9.1

1 year ago

2.15.2

10 months ago

2.11.6

12 months ago

2.15.3

10 months ago

2.11.7

12 months ago

2.15.0

11 months ago

2.11.4

1 year ago

2.15.1

11 months ago

2.11.5

1 year ago

2.11.2

1 year ago

2.11.3

1 year ago

2.10.0

1 year ago

3.1.2

10 months ago

3.1.1

10 months ago

3.1.0

10 months ago

2.8.2

1 year ago

2.14.0

11 months ago

2.13.6

11 months ago

2.13.4

11 months ago

2.13.5

11 months ago

3.0.0

10 months ago

2.13.2

11 months ago

2.13.3

11 months ago

2.13.0

11 months ago

2.13.1

11 months ago

2.12.0

11 months ago

2.9.0

1 year ago

3.3.1

9 months ago

3.3.0

9 months ago

2.8.1

1 year ago

2.8.0

1 year ago

2.7.2

1 year ago

2.7.1

1 year ago

2.7.0

1 year ago

2.6.0

1 year ago

2.5.0

1 year ago

2.4.0

1 year ago

2.3.1

1 year ago

2.3.0

1 year ago

2.2.0

1 year ago

2.1.2

1 year ago

2.1.1

1 year ago

2.0.3

1 year ago

2.1.0

1 year ago

2.0.2

1 year ago

2.0.1

1 year ago

2.0.0

1 year ago

1.14.0

1 year ago

1.12.3

1 year ago

1.12.4

1 year ago

1.13.0

1 year ago

1.12.2

1 year ago

1.12.1

1 year ago

1.12.0

1 year ago

1.11.8

1 year ago

1.11.7

1 year ago

1.11.6

1 year ago

1.11.5

1 year ago

1.11.4

1 year ago

1.11.3

1 year ago

1.11.2

1 year ago

1.11.1

1 year ago

1.11.0

1 year ago

1.10.4

1 year ago

1.10.3

1 year ago

1.10.2

1 year ago

1.10.1

1 year ago

1.9.1

1 year ago

1.9.0

1 year ago

1.10.0

1 year ago

1.8.0

1 year ago

1.9.2

1 year ago

1.6.1

1 year ago

1.6.0

1 year ago

1.7.0

1 year ago

1.5.2

1 year ago

1.5.1

1 year ago

1.5.0

1 year ago

1.4.2

1 year ago

1.4.1

1 year ago

1.4.0

1 year ago

1.3.1

1 year ago

1.3.0

1 year ago

1.2.2

2 years ago

1.2.1

2 years ago

1.2.0

2 years ago

1.1.0

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

0.23.3

2 years ago

0.23.2

2 years ago

0.23.1

2 years ago

0.23.0

2 years ago

0.22.1

2 years ago

0.22.0

2 years ago

0.21.5

2 years ago

0.21.4

2 years ago

0.21.3

2 years ago

0.21.2

2 years ago

0.21.1

2 years ago

0.21.0

2 years ago

0.20.1

2 years ago

0.20.0

2 years ago

0.19.1

2 years ago

0.19.0

2 years ago

0.18.0

2 years ago

0.17.0

2 years ago

0.16.1

2 years ago

0.16.0

2 years ago

0.15.1

2 years ago

0.15.0

2 years ago

0.14.1

2 years ago

0.14.0

2 years ago

0.13.1

2 years ago

0.13.0

2 years ago

0.12.1

2 years ago

0.12.0

2 years ago

0.11.0

2 years ago

0.10.3

2 years ago

0.10.2

2 years ago

0.10.1

2 years ago

0.10.0

2 years ago

0.9.2

2 years ago

0.9.1

2 years ago

0.9.0

2 years ago

0.8.3

2 years ago

0.8.2

2 years ago

0.8.1

2 years ago

0.8.0

2 years ago

0.7.0

2 years ago

0.6.0

2 years ago

0.5.6

2 years ago

0.5.5

2 years ago

0.5.4

2 years ago

0.5.3

2 years ago

0.5.2

2 years ago

0.5.1

2 years ago

0.5.0

2 years ago

0.4.10

2 years ago

0.4.9

2 years ago

0.4.8

2 years ago

0.4.7

2 years ago

0.4.6

2 years ago

0.4.5

2 years ago

0.4.4

2 years ago

0.4.3

2 years ago

0.4.2

2 years ago

0.4.1

2 years ago

0.4.0

2 years ago

0.3.3

2 years ago

1.0.0-next.5

2 years ago

1.0.0-next.4

2 years ago

0.3.2-next.0

2 years ago

0.3.2

2 years ago

0.3.1

2 years ago

0.3.0

2 years ago

0.2.5

2 years ago

0.2.4

2 years ago

0.2.3

2 years ago

0.2.2

2 years ago

0.2.1

2 years ago

0.2.0

2 years ago

0.1.3

2 years ago

0.1.2

2 years ago

1.0.0-next.3

2 years ago

1.0.0-next.2

2 years ago

1.0.0-next.1

2 years ago

1.0.0-next.0

2 years ago

0.1.2-next.0

2 years ago

1.0.0-0

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago