react-script-hook

What is react-script-hook?

The react-script-hook package allows you to dynamically load external scripts in your React applications. This can be useful for integrating third-party libraries or services that require script tags to be added to your HTML.

What are react-script-hook's main functionalities?

Load External Scripts

This feature allows you to load external scripts dynamically. The useScript hook takes an object with a 'src' property pointing to the script URL. It returns a loading state and an error state, which you can use to handle the script loading process in your component.

import { useScript } from 'react-script-hook';

function MyComponent() {
  const [loading, error] = useScript({
    src: 'https://example.com/some-external-script.js',
  });

  if (loading) return <div>Loading...</div>;
  if (error) return <div>Error loading script</div>;

  return <div>Script loaded successfully!</div>;
}

Handle Script Loading States

This feature allows you to handle different states of script loading, such as loading, error, and success. You can display appropriate messages or UI elements based on the current state.

import { useScript } from 'react-script-hook';

function MyComponent() {
  const [loading, error] = useScript({
    src: 'https://example.com/some-external-script.js',
  });

  if (loading) return <div>Loading...</div>;
  if (error) return <div>Error loading script</div>;

  return <div>Script loaded successfully!</div>;
}

Load Multiple Scripts

This feature allows you to load multiple scripts simultaneously. You can use multiple useScript hooks to load different scripts and handle their loading states independently.

import { useScript } from 'react-script-hook';

function MyComponent() {
  const [loading1, error1] = useScript({
    src: 'https://example.com/first-script.js',
  });
  const [loading2, error2] = useScript({
    src: 'https://example.com/second-script.js',
  });

  if (loading1 || loading2) return <div>Loading...</div>;
  if (error1 || error2) return <div>Error loading scripts</div>;

  return <div>Scripts loaded successfully!</div>;
}

Other packages similar to react-script-hook

react-async-script-loader

The react-async-script-loader package provides a higher-order component (HOC) to load external scripts asynchronously. It offers similar functionality to react-script-hook but uses a different approach by wrapping your component with a HOC.

react-load-script

The react-load-script package allows you to load external scripts in your React components. It provides a simple component-based API for loading scripts and handling their loading states. It is similar to react-script-hook but uses a component-based approach instead of a hook.

react-helmet

The react-helmet package is primarily used for managing changes to the document head, but it can also be used to add script tags dynamically. It offers more comprehensive functionality for managing the document head compared to react-script-hook, which focuses solely on loading scripts.

README

react-script-hook

React hook to dynamically load an external script and know when its loaded

Install

// with npm
npm install react-script-hook

// with yarn
yarn add react-script-hook

How to use

import React from 'react';
import { StripeProvider } from 'react-stripe-elements';
import useScript from 'react-script-hook';

import MyCheckout from './my-checkout';

function App() {
    const [loading, error] = useScript({ src: 'https://js.stripe.com/v3/' });

    if (loading) return <h3>Loading Stripe API...</h3>;
    if (error) return <h3>Failed to load Stripe API: {error.message}</h3>;

    return (
        <StripeProvider apiKey="pk_test_6pRNASCoBOKtIshFeQd4XMUh">
            <MyCheckout />
        </StripeProvider>
    );
}

export default App;

Use with callbacks

useScript({
    src: 'https://js.stripe.com/v3/',
    onload: () => console.log('Script loaded!'),
});

Check for Existing

The hook automatically handles when the script was already loaded (or started loading) from another instance of the hook. So you can safely add identical useScript hooks to multiple components that depend on the same external script, and they will properly block on the loading of only one copy.

If you're in an environment where the script may have already been loaded in some other way (not from this hook), pass an checkForExisting flag of true. In this case, the hook will ensure the script is placed on the page only once by querying for script tags with the same src. Useful for SSR or SPAs with client-side routing.

const [loading, error] = useScript({
    src: 'https://js.stripe.com/v3/',
    checkForExisting: true,
});

Conditionally calling a script

If you want to conditionally call a script you can do so by setting the src value to either the script or null. Note that the script is not removed if the src is set to null after it was previously set to a value causing the script to be appended.

const [loading, error] = useScript({
    /** Only append stripeJS script when shouldLoadStripe is true */
    src: shouldLoadStripe ? 'https://js.stripe.com/v3/' : null,
});

License

MIT