[Glitch] Add type annotation for Blurhash component
Port f50105779b to glitch-soc
Signed-off-by: Claire <claire.github-309c@sitedethib.com>
			
			
This commit is contained in:
		
				
					committed by
					
						
						Claire
					
				
			
			
				
	
			
			
			
						parent
						
							20f1f3aa7d
						
					
				
				
					commit
					9ab89bb832
				
			@@ -1,65 +0,0 @@
 | 
			
		||||
// @ts-check
 | 
			
		||||
 | 
			
		||||
import { decode } from 'blurhash';
 | 
			
		||||
import React, { useRef, useEffect } from 'react';
 | 
			
		||||
import PropTypes from 'prop-types';
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * @typedef BlurhashPropsBase
 | 
			
		||||
 * @property {string?} hash Hash to render
 | 
			
		||||
 * @property {number} width
 | 
			
		||||
 * Width of the blurred region in pixels. Defaults to 32
 | 
			
		||||
 * @property {number} [height]
 | 
			
		||||
 * Height of the blurred region in pixels. Defaults to width
 | 
			
		||||
 * @property {boolean} [dummy]
 | 
			
		||||
 * Whether dummy mode is enabled. If enabled, nothing is rendered
 | 
			
		||||
 * and canvas left untouched
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/** @typedef {JSX.IntrinsicElements['canvas'] & BlurhashPropsBase} BlurhashProps */
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Component that is used to render blurred of blurhash string
 | 
			
		||||
 * @param {BlurhashProps} param1 Props of the component
 | 
			
		||||
 * @returns {JSX.Element} Canvas which will render blurred region element to embed
 | 
			
		||||
 */
 | 
			
		||||
function Blurhash({
 | 
			
		||||
  hash,
 | 
			
		||||
  width = 32,
 | 
			
		||||
  height = width,
 | 
			
		||||
  dummy = false,
 | 
			
		||||
  ...canvasProps
 | 
			
		||||
}) {
 | 
			
		||||
  const canvasRef = /** @type {import('react').MutableRefObject<HTMLCanvasElement>} */ (useRef());
 | 
			
		||||
 | 
			
		||||
  useEffect(() => {
 | 
			
		||||
    const { current: canvas } = canvasRef;
 | 
			
		||||
    canvas.width = canvas.width; // resets canvas
 | 
			
		||||
 | 
			
		||||
    if (dummy || !hash) return;
 | 
			
		||||
 | 
			
		||||
    try {
 | 
			
		||||
      const pixels = decode(hash, width, height);
 | 
			
		||||
      const ctx = canvas.getContext('2d');
 | 
			
		||||
      const imageData = new ImageData(pixels, width, height);
 | 
			
		||||
 | 
			
		||||
      // @ts-expect-error
 | 
			
		||||
      ctx.putImageData(imageData, 0, 0);
 | 
			
		||||
    } catch (err) {
 | 
			
		||||
      console.error('Blurhash decoding failure', { err, hash });
 | 
			
		||||
    }
 | 
			
		||||
  }, [dummy, hash, width, height]);
 | 
			
		||||
 | 
			
		||||
  return (
 | 
			
		||||
    <canvas {...canvasProps} ref={canvasRef} width={width} height={height} />
 | 
			
		||||
  );
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
Blurhash.propTypes = {
 | 
			
		||||
  hash: PropTypes.string.isRequired,
 | 
			
		||||
  width: PropTypes.number,
 | 
			
		||||
  height: PropTypes.number,
 | 
			
		||||
  dummy: PropTypes.bool,
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export default React.memo(Blurhash);
 | 
			
		||||
							
								
								
									
										45
									
								
								app/javascript/flavours/glitch/components/blurhash.tsx
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										45
									
								
								app/javascript/flavours/glitch/components/blurhash.tsx
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,45 @@
 | 
			
		||||
import { decode } from 'blurhash';
 | 
			
		||||
import React, { useRef, useEffect } from 'react';
 | 
			
		||||
 | 
			
		||||
type Props = {
 | 
			
		||||
  hash: string;
 | 
			
		||||
  width?: number;
 | 
			
		||||
  height?: number;
 | 
			
		||||
  dummy?: boolean; // Whether dummy mode is enabled. If enabled, nothing is rendered and canvas left untouched
 | 
			
		||||
  children?: never;
 | 
			
		||||
  [key: string]: any;
 | 
			
		||||
}
 | 
			
		||||
function Blurhash({
 | 
			
		||||
  hash,
 | 
			
		||||
  width = 32,
 | 
			
		||||
  height = width,
 | 
			
		||||
  dummy = false,
 | 
			
		||||
  ...canvasProps
 | 
			
		||||
}: Props) {
 | 
			
		||||
  const canvasRef = useRef<HTMLCanvasElement>(null);
 | 
			
		||||
 | 
			
		||||
  useEffect(() => {
 | 
			
		||||
    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 | 
			
		||||
    const canvas = canvasRef.current!;
 | 
			
		||||
    // eslint-disable-next-line no-self-assign
 | 
			
		||||
    canvas.width = canvas.width; // resets canvas
 | 
			
		||||
 | 
			
		||||
    if (dummy || !hash) return;
 | 
			
		||||
 | 
			
		||||
    try {
 | 
			
		||||
      const pixels = decode(hash, width, height);
 | 
			
		||||
      const ctx = canvas.getContext('2d');
 | 
			
		||||
      const imageData = new ImageData(pixels, width, height);
 | 
			
		||||
 | 
			
		||||
      ctx?.putImageData(imageData, 0, 0);
 | 
			
		||||
    } catch (err) {
 | 
			
		||||
      console.error('Blurhash decoding failure', { err, hash });
 | 
			
		||||
    }
 | 
			
		||||
  }, [dummy, hash, width, height]);
 | 
			
		||||
 | 
			
		||||
  return (
 | 
			
		||||
    <canvas {...canvasProps} ref={canvasRef} width={width} height={height} />
 | 
			
		||||
  );
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export default React.memo(Blurhash);
 | 
			
		||||
		Reference in New Issue
	
	Block a user