@aaroncadillac/react-use-fetch

useFetch:

A simple hook for data fetching in React

This README explains how to use the useFetch React hook to simplify data fetching within your React components. It handles asynchronous requests, manages loading and error states, and offers customization options for tailored data fetching behavior.

Features:

• Data Fetching: Makes asynchronous requests to specified URLs using the fetch API.
• Error Handling: Catches potential errors during the fetch process and stores them for convenient access and handling in your UI.
• Loading State: Provides a boolean loading state to indicate when data is being fetched, allowing you to display appropriate UI elements like loading spinners.
• Customization: Offers customization through options and a validator function:
  • [options]: Modify the fetch request behavior and specify additional parameters (e.g., method, headers, body). Refer to the Fetch API documentation for details.
  • [validator]: Implement a custom function to control when the fetch request is triggered based on your application logic. By default, it returns true for unconditional fetching.

Installation

Assuming you're using a module bundler like Webpack or Parcel, install the required dependency: Bash

Using npm

npm i @aaroncadillac/react-use-fetch

Using Yarn

yarn add @aaroncadillac/react-use-fetch

Usage

Simple use

import React, { useState } from 'react';
import { useFetch } from 'react-use-fetch';

function MyComponent() {
  const { response, error, loading } = useFetch({
    url: 'https://api.example.com/data',
    options: {
      method: 'POST',
      body: JSON.stringify({ data: 'Some data' }),
    },
  });

  if (loading) {
    return <p>Loading...</p>;
  }

  if (error) {
    return <p>Error: {error.message}</p>;
  }

  return (
    <div>
      {/* Display the fetched data here */}
      <p>Data: {JSON.stringify(response)}</p>
    </div>
  );
}

export default MyComponent;

Custom validator usage

import React, { useState } from 'react';
import { useFetch } from 'react-use-fetch';

function MyComponent() {
  const [shouldFetch, setShouldFetch] = useState(false);

  const { response, error, loading } = useFetch({
    url: 'https://api.example.com/data',
    validator: () => shouldFetch,
  });

  const handleClick = () => {
    setShouldFetch(true);
  };

  if (loading) {
    return <p>Loading...</p>;
  }

  if (error) {
    return <p>Error: {error.message}</p>;
  }

  return (
    <div>
      <button onClick={handleClick}>Fetch Data</button>
      <p>Data: {JSON.stringify(response)}</p>
    </div>
  );
}

export default MyComponent;

Properties

• url (string): The URL to fetch data from.
• [options] (object, optional): An optional object containing additional options for the fetch request (e.g., method, headers, body).
• [validator] (function, optional): An optional function that determines when to trigger the fetch request. By default, it returns true for unconditional fetching.

Returned Values

The useFetch hook returns an object containing the following properties:

• response (any, optional): The fetched data as a JSON object, if the request was successful.
• error (Error, optional): An Error object if an error occurs during the fetch process.
• loading (boolean): A boolean indicating whether data is currently being fetched.

Aditional Notes

By incorporating this useFetch hook into your React applications, you can streamline data fetching logic, manage loading and error states effectively, and create a more robust and user-friendly experience.