Merge pull request #103 from Cavallando/main

fix!: Console error when using MutableRef from useRef

Author: nzambello

dist/index.d.ts

@@ -14,13 +14,12 @@ export interface CSVReaderProps {
     inputId?: string;
     inputName?: string;
     inputStyle?: object;
-    inputRef?: React.LegacyRef<HTMLInputElement>;
     label?: string | React.ReactNode;
     onError?: (error: Error) => void;
     onFileLoaded: (data: Array<any>, fileInfo: IFileInfo, originalFile?: File) => any;
     parserOptions?: PapaParse.ParseConfig;
     disabled?: boolean;
     strict?: boolean;
 }
-declare const CSVReader: React.FC<CSVReaderProps>;
+declare const CSVReader: React.ForwardRefExoticComponent<CSVReaderProps & React.RefAttributes<HTMLInputElement>>;
 export default CSVReader;

dist/react-csv-reader.js.map

@@ -107,8 +107,22 @@ test('prop-types error when give RefObject to inputRef', async () => {
   console.error = jest.fn()
   const inputRef: React.RefObject<HTMLInputElement> = { current: null }
   React.createElement(CSVReader, {
-    inputRef,
+    ref: inputRef,
     onFileLoaded: (data, fileInfo) => console.dir(data, fileInfo),
   })
   expect(console.error).toHaveBeenCalledTimes(0)
 })
+
+test('prop-types in Production do not error when given MutableRef to inputRef', async () => {
+  // @ts-ignore
+  const ProductionCSVReader = (await import('../dist/react-csv-reader')).default as typeof CSVReader
+
+  console.error = jest.fn()
+  const inputRef: React.MutableRefObject<HTMLInputElement> = { current: null }
+  React.createElement(ProductionCSVReader, {
+    ref: inputRef,
+    onFileLoaded: (data, fileInfo) => console.dir(data, fileInfo),
+  })
+
+  expect(console.error).toHaveBeenCalledTimes(0)
+})

src/index.test.tsx

@@ -17,7 +17,6 @@ export interface CSVReaderProps {
   inputId?: string
   inputName?: string
   inputStyle?: object
-  inputRef?: React.LegacyRef<HTMLInputElement>
   label?: string | React.ReactNode
   onError?: (error: Error) => void
   onFileLoaded: (data: Array<any>, fileInfo: IFileInfo, originalFile?: File) => any
@@ -26,75 +25,79 @@ export interface CSVReaderProps {
   strict?: boolean
 }
 
-const CSVReader: React.FC<CSVReaderProps> = ({
-  accept = '.csv, text/csv',
-  cssClass = 'csv-reader-input',
-  cssInputClass = 'csv-input',
-  cssLabelClass = 'csv-label',
-  fileEncoding = 'UTF-8',
-  inputId = 'react-csv-reader-input',
-  inputName = 'react-csv-reader-input',
-  inputStyle = {},
-  inputRef,
-  label,
-  onError = () => {},
-  onFileLoaded,
-  parserOptions = {} as PapaParse.ParseConfig,
-  disabled = false,
-  strict = false,
-}) => {
-  const handleChangeFile = (e: React.ChangeEvent<HTMLInputElement>) => {
-    let reader: FileReader = new FileReader()
-    const files: FileList = e.target.files!
+const CSVReader = React.forwardRef<HTMLInputElement, CSVReaderProps>(
+  (
+    {
+      accept = '.csv, text/csv',
+      cssClass = 'csv-reader-input',
+      cssInputClass = 'csv-input',
+      cssLabelClass = 'csv-label',
+      fileEncoding = 'UTF-8',
+      inputId = 'react-csv-reader-input',
+      inputName = 'react-csv-reader-input',
+      inputStyle = {},
+      label,
+      onError = () => {},
+      onFileLoaded,
+      parserOptions = {} as PapaParse.ParseConfig,
+      disabled = false,
+      strict = false,
+    },
+    inputRef,
+  ) => {
+    const handleChangeFile = (e: React.ChangeEvent<HTMLInputElement>) => {
+      let reader: FileReader = new FileReader()
+      const files: FileList = e.target.files!
 
-    if (files.length > 0) {
-      const fileInfo: IFileInfo = {
-        name: files[0].name,
-        size: files[0].size,
-        type: files[0].type,
-      }
+      if (files.length > 0) {
+        const fileInfo: IFileInfo = {
+          name: files[0].name,
+          size: files[0].size,
+          type: files[0].type,
+        }
 
-      if (strict && accept.indexOf(fileInfo.type) <= 0) {
-        onError(new Error(`[strict mode] Accept type not respected: got '${fileInfo.type}' but not in '${accept}'`))
-        return
-      }
+        if (strict && accept.indexOf(fileInfo.type) <= 0) {
+          onError(new Error(`[strict mode] Accept type not respected: got '${fileInfo.type}' but not in '${accept}'`))
+          return
+        }
 
-      reader.onload = (_event: Event) => {
-        const csvData = PapaParse.parse(
-          reader.result as string,
-          Object.assign(parserOptions, {
-            error: onError,
-            encoding: fileEncoding,
-          }),
-        )
-        onFileLoaded(csvData?.data ?? [], fileInfo, files[0])
-      }
+        reader.onload = (_event: Event) => {
+          const csvData = PapaParse.parse(
+            reader.result as string,
+            Object.assign(parserOptions, {
+              error: onError,
+              encoding: fileEncoding,
+            }),
+          )
+          onFileLoaded(csvData?.data ?? [], fileInfo, files[0])
+        }
 
-      reader.readAsText(files[0], fileEncoding)
+        reader.readAsText(files[0], fileEncoding)
+      }
     }
-  }
 
-  return (
-    <div className={cssClass}>
-      {label && (
-        <label className={cssLabelClass} htmlFor={inputId}>
-          {label}
-        </label>
-      )}
-      <input
-        className={cssInputClass}
-        type="file"
-        id={inputId}
-        name={inputName}
-        style={inputStyle}
-        accept={accept}
-        onChange={handleChangeFile}
-        disabled={disabled}
-        ref={inputRef}
-      />
-    </div>
-  )
-}
+    return (
+      <div className={cssClass}>
+        {label && (
+          <label className={cssLabelClass} htmlFor={inputId}>
+            {label}
+          </label>
+        )}
+        <input
+          className={cssInputClass}
+          type="file"
+          id={inputId}
+          name={inputName}
+          style={inputStyle}
+          accept={accept}
+          onChange={handleChangeFile}
+          disabled={disabled}
+          ref={inputRef}
+        />
+      </div>
+    )
+  },
+)
 
 CSVReader.propTypes = {
   accept: PropTypes.string,