/// import { ImgHTMLAttributes } from "react"; declare type NativeImageProps = ImgHTMLAttributes; export interface UseImageProps { /** * The image `src` attribute */ src?: string; /** * The image `srcset` attribute */ srcSet?: string; /** * The image `sizes` attribute */ sizes?: string; /** * A callback for when the image `src` has been loaded */ onLoad?: NativeImageProps["onLoad"]; /** * A callback for when there was an error loading the image `src` */ onError?: NativeImageProps["onError"]; /** * If `true`, opt out of the `fallbackSrc` logic and use as `img` */ ignoreFallback?: boolean; /** * The key used to set the crossOrigin on the HTMLImageElement into which the image will be loaded. * This tells the browser to request cross-origin access when trying to download the image data. */ crossOrigin?: NativeImageProps["crossOrigin"]; loading?: NativeImageProps["loading"]; } declare type Status = "loading" | "failed" | "pending" | "loaded"; /** * React hook that loads an image in the browser, * and let's us know the `status` so we can show image * fallback if it is still `pending` * * @returns the status of the image loading progress * * @example * * ```jsx * function App(){ * const status = useImage({ src: "image.png" }) * return status === "loaded" ? : * } * ``` */ export declare function useImage(props: UseImageProps): Status; export declare type UseImageReturn = ReturnType; export {};