use-axios

Simple Axios hook for React. Use React Suspense to show loading indicator and Error Boundary to handle request errors.

TodoMVC example

ℹ This is a React hook for data fetching inside a function component body. Use regular axios for requests in onSubmit, onClick etc.

Install

npm install axios use-axios

useAxios(url[, config])

Params

Same as axios.

Returns

Success response from axios.

Throws

Response error from axios or promise for React Suspense.

Example

import { Suspense } from 'react';
import useAxios from 'use-axios';

function User({ id }) {
  const { data } = useAxios(`/api/users/${id}`);

  return <div>First name: {data.first_name}</div>;
}

function App() {
  return (
    <Suspense fallback="Loading...">
      <User id="1" />
    </Suspense>
  );
}

Handle errors

Create an error boundary, for example using react-error-boundary.

import { Suspense } from 'react';
import ErrorBoundary from 'react-error-boundary';

function MyFallbackComponent({ error, componentStack }) {
  return (
    <>
      <p>
        <strong>Oops! A request error occurred!</strong>
      </p>
      <pre>
        status: {error.response.status}
        {'\n'}
        statusText: {error.response.statusText}
        {'\n'}
        Stacktrace:
        {componentStack}
      </pre>
    </>
  );
}

function App() {
  return (
    <Suspense fallback="Loading...">
      <ErrorBoundary FallbackComponent={MyFallbackComponent}>
        <User id="23" />
      </ErrorBoundary>
    </Suspense>
  );
}

To handle error inside a component, use useAxiosSafe:

import { useAxiosSafe } from 'use-axios';

function User({ id }) {
  const [error, { data }] = useAxiosSafe(`/api/users/${id}`);
  if (error) {
    return (
      <>
        <p>
          <strong>Oops! A request error occurred!</strong>
        </p>
        <pre>
          status: {error.response.status}
          {'\n'}
          statusText: {error.response.statusText}
        </pre>
      </>
    );
  }
  return <div>First name: {data.first_name}</div>;
}

Caching and refetching

Successful responses with the same (stable JSON stringified) arguments are cached across the application. Components may rerender and call useAxios multiple times, and only one HTTP request is made, as long as there is some component mounted using the same arguments.

refetch(url[, config])

Refetch data and update components. Calling this does nothing, if there are no components currently mounted using useAxios and same (stable JSON stringified) arguments.

Params

Same as axios.

Refetch example

Add/remove user and update the list of users:

import { Suspense } from 'react';
import { useAxios, refetch } from 'use-axios';
import { delete as del, post } from 'axios';

function Users() {
  const { data } = useAxios('/api/users');
  return (
    <ul>
      <UserForm />
      {data.map((user) => (
        <User key={user.id} {...user} />
      ))}
    </ul>
  );
}

function UserForm() {
  // ...
  return (
    <form
      onSubmit={async (event) => {
        event.preventDefault();
        // Add user
        await post('/api/users', user);
        // Refetch paths that might have been affected by the POST request
        await refetch('/api/users');
      }}
    >
      ...
    </form>
  );
}

function User({ id, first_name }) {
  return (
    <li>
      {first_name}
      <span
        onClick={async () => {
          // Remove user
          await del(`/api/users/${id}`);
          // Refetch paths that might have been affected by the DELETE request
          refetch('/api/users');
        }}
      >
        ❌
      </span>
    </li>
  );
}

function App() {
  return (
    <Suspense fallback="Loading...">
      <Users />
    </Suspense>
  );
}

Using a custom axios instance

You can use a custom axios instance by calling create.

create([axios|config])

Params

An axios instance or an optional config object for axios.create.

Returns

An object with properties useAxios, useAxiosSafe and refetch.

Custom axios instance example

import { create } from 'use-axios';

const { useAxios } = create({
  baseURL: 'https://api.example.com',
});

Not ready for Suspense?

Import from use-axios/loading-state to use the { isLoading, data, error } style API. Example:

import { useAxiosSafe } from 'use-axios/loading-state';

function User({ id }) {
  const { isLoading, data, error } = useAxiosSafe(`/api/users/${id}`);

  if (isLoading) {
    return 'Loading...';
  }

  return <div>First name: {data.data.first_name}</div>;
}