12345678910111213141516171819202122232425262728293031 |
- declare type State = {
- image: HTMLImageElement | null;
- error: unknown | null;
- };
- /**
- * Fetch and load an image for programatic use such as in a `<canvas>` element.
- *
- * @param imageOrUrl The `HtmlImageElement` or image url to load
- * @param crossOrigin The `crossorigin` attribute to set
- *
- * ```ts
- * const { image, error } = useImage('/static/kittens.png')
- * const ref = useRef<HTMLCanvasElement>()
- *
- * useEffect(() => {
- * const ctx = ref.current.getContext('2d')
- *
- * if (image) {
- * ctx.drawImage(image, 0, 0)
- * }
- * }, [ref, image])
- *
- * return (
- * <>
- * {error && "there was a problem loading the image"}
- * <canvas ref={ref} />
- * </>
- * ```
- */
- export default function useImage(imageOrUrl?: string | HTMLImageElement | null | undefined, crossOrigin?: 'anonymous' | 'use-credentials' | string): State;
- export {};
|