request-registry-react
v0.12.3
Published
RequestRegistryReact is a helper to use RequestRegistry ajax endpoints inside react.
Downloads
77
Keywords
Readme
Request Registry React
RequestRegistryReact is a helper to use RequestRegistry ajax endpoints inside react.
Features:
- lazy loading: ajax requests will be done only if a react component using the endpoint is mounted
- auto refresh: if a cache gets outdated and components are still on the page they will request a new version and render again
- garbage collection: once all React components using endpoints have been unmounted the cache will be freed
Getting started
npm install --save request-registry request-registry-react
Api
useGetEndPoint
The useGetEndPoint can be used to load ajax data and handling the loading state in the same component:
import { useGetEndPoint } from "registry-request-react";
const UserDetails = props => {
const endpointState = useGetEndPoint(userEndpoint, { id: props.id });
if (endpointState.state !== "DONE") {
return <div>Loading...</div>;
}
const { name } = endpointState.value;
return <div>{name}</div>;
};
Conditional data loading is possible by providing a third executeAjax
argument:
// Execute ajax
useGetEndPoint(userEndpoint, { id: props.id }, true);
// Don't execute ajax
useGetEndPoint(userEndpoint, { id: props.id }, false);
useGetEndPointSuspendable
⚠️ React.Suspense is not supported by React Server Side Rendering
The useGetEndPointSuspendable can be used in combination with React.Suspense
to load
ajax data:
import { useGetEndPointSuspendable } from "registry-request-react";
const UserDetails = props => {
const { name } = useGetEndPointSuspendable(userEndpoint, { id: props.id });
return <div>{name}</div>;
};
const UserDetailsContainer = () => {
return (
<Suspense fallback={"Loading..."}>
<UserDetails id="4" />
</Suspense>
);
};
useGetEndPointLazy
The useGetEndPointLazy
can be used to load ajax data and handling the loading state in the same component
exactly like useGetEndPoint
however the request will only be executed on client side (if the window object exists)
endpointState
The return value of useGetEndPoint
can have the following states:
state: 'LOADING'
: The endpoint is executed the first time or after an error occured.state: 'UPDATING'
: The endpoint is executed altough data have already been loaded before.state: 'DONE'
: The endpoint is done executing.state: 'ERROR'
: The endpoint is done executing but received an error