1.0.6 • Published 3 months ago

firebase-file-uploader-react v1.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
3 months ago

Firebase File Uploader React

React component for uploading files to Firebase

You need to initialize a firebase application and create the storage object.

import { initializeApp } from "firebase/app";
import { getStorage } from "firebase/storage";
import firebaseConfig from "./config";

const app = initializeApp(firebaseConfig);
const storage = getStorage(app);

const Firebase = {
  storage,
};

export default Firebase;
export { storage };

How To Install?

npm i firebase-file-uploader-react

Custom Hook Required Config object:

const config = {
    storage,
    path: 'products'
    includeExt?: false optional:BOOLEAN to include file extension type to file name
    filename?: (filename) => "t-shirt", optional: STRING or FUNCTION for custom filename\
    or uploaded cloud file,as FUNCTION passes the original filename as\
    func args e.g filename: (originalFilename)=>{ return `${originalFilename}-fancyname`}\
    e.g 2 filename: (originalFilename)=>originalFilename to keep original filename
}

How To Use?

import { useFirebaseFileUploader } from 'firebase-file-uploader-react';

const App = () => {
    const { FileUploaderUI, uploading, progress, error, fileURL, originalFilename, inputElement, fileType } =
    useFirebaseFileUploader({
      storage,
      path: "products",
      filename: "t-shirt"
    });
    return (
      <FileUploaderUI
        className="shadow appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline"
        accept="image/*"
        id="imagen"
        name="imagen"
        draggable="true"
      />
    )
}

Style

this component haven't any style;

You can use the way you like to style it.

FileUploaderUI Default Props

PropTypeIs Required?Comment
typepropertyDefault (file)Read more in MDN
Accept input type file properties
1.0.6

3 months ago

1.0.5

3 months ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago