README.md

rn-firebase-image-uploader-hook

• Easily Upload Photos to fire-base with react native firebase library & Expo
• Hooks to return state of Progress, downloadUrl, success, error, uploading

installation

to install using npm: npm i rn-firebase-image-uploader-hook

to install using yarn yarn add rn-firebase-image-uploader-hook

Usage

import the package import useImageUpload from "rn-firebase-image-uploader-hook"

Example

const Profile = () => {
  const [
    pickImage,
    selectedImage,
    uploadProgress,
    downloadUrl,
    uploading,
    success,
    error,
    reset,
  ] = useImageUpload();

  return (
    <View>
      <Pressable onPress={pickImage}>
        {user.image || downloadUrl ? (
          <Image
            source={{ uri: user.image || downloadUrl }}
            style={{ width: 100, height: 100 }}
          />
        ) : (
        )}
      </Pressable>

      {uploading && <Text>Uploading... {uploadProgress}/100</Text>}
      {success && <Text>Uploaded successfully</Text>}
      {error && <Text>Upload failed</Text>}
    </View>
  );
};

Common Use

When destructing consts from useImageUpload() hook you get

return	Type	Description
pickImage	function	asks for permission to view photos from device, and views Image Picker
selectedImage	uri	uri to the selected image
uploadProgress	number (1..100)	Indicates precentage of upload progress
downloadUrl	string	url of uploaded photo to firebase storage
uploading	Boolean	if uploading process is in progress
success	Boolean	if uploading has finished successfully
error	Boolean	if error has occoured
reset	method	resets the state of downloadUrl, selectedImage, uploading, success, error

resize photo before upload

useImageUpload(config) can have config to resize photo

  const config = {
    refFolder:  "/images/" //  to select subfolders for storage reference
    resize: {
      width: 500, // Optional, Image resized width
      height: 500, // Optiona;, Image resized height
      quality: 1, // Optional, image resized quality
      format: "jpeg", // "jpeg", "png", "webp"
      compress: 1 // compress rate, recommended 0.9,
    },
  };

  const [
    pickImage,
    selectedImage,
    uploadProgress,
    downloadUrl,
    uploading,
    success,
    error,
    reset,
  ] = useImageUpload(config);

###End