/reactuse

useScript

Loads a script and returns its status.

Usage

import { useScript } from "@siberiacancode/reactuse";

const status = useScript("https://example.com/script.js");

Example

import { useScript } from "@siberiacancode/reactuse";

const status = useScript("https://example.com/script.js");
return <div>Status: {status}</div>;

async:

const status = useScript("https://example.com/script.js", { async: false });

removeOnUnmount:

const status = useScript("https://example.com/script.js", {
  removeOnUnmount: false,
});

Type Declarations

import type { ComponentProps } from "react";

export type UseScriptStatus = "error" | "loading" | "ready" | "unknown";
export interface UseScriptOptions extends ComponentProps<"script"> {
  removeOnUnmount?: boolean;
}
export declare const useScript: (
  src: string,
  options?: UseScriptOptions
) => UseScriptStatus;