https://github.com/narcello/react-avatar-firebase

:raising_hand: Easily Avatar on Firebase Storage
https://github.com/narcello/react-avatar-firebase

avatar firebase firebase-storage npm-package reactjs

Last synced: 6 months ago
JSON representation

:raising_hand: Easily Avatar on Firebase Storage

• Host: GitHub
• URL: https://github.com/narcello/react-avatar-firebase
• Owner: narcello
• License: mit
• Created: 2019-10-08T03:54:19.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T22:26:41.000Z (over 2 years ago)
• Last Synced: 2024-03-25T14:04:18.423Z (over 1 year ago)
• Topics: avatar, firebase, firebase-storage, npm-package, reactjs
• Language: JavaScript
• Homepage:
• Size: 4.89 MB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 51
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-avatar-firebase

> Easily Avatar on Firebase Storage

[![](https://img.shields.io/npm/v/react-avatar-firebase.svg)](https://www.npmjs.com/package/react-avatar-firebase) [![](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

![](https://img.shields.io/david/peer/MarcelloVSilva/react-avatar-firebase)

![](https://img.shields.io/bundlephobia/min/react-avatar-firebase)

![](https://img.shields.io/david/dev/MarcelloVSilva/react-avatar-firebase)

## Install

```bash

npm install --save react-avatar-firebase

```

## Documentation

Use react-avatar-firebase for upload avatar on Firebase Storage.

| Props  |  Definition |

| ------------ | ------------ |

| pathToStorage  |  Name of folder/path where you will save your avatar on storage |

| imageSrc |  Pass a image url to render |

| handleGetImage | Callback that gives you a return of upload of image on storage |

| animationTime | defines hover avatar wrapper animation time |

| size | defines avatar wrapper px size |

| borderColor | defines border color |

| borderOpacity | defines border opacity |

| readOnly | True for disable image selection  |

| storage | Object ref of firebase storage reference  |

## Usage

```jsx

import React from 'react'

import RAF from 'react-avatar-firebase'

const App = () => {

  return (

    


      '}

       />

    

  )

}

export default App

```


## Local test

Run `yarn start` at root folder and at example folder

## License

MIT © [MarcelloVSilva](https://github.com/MarcelloVSilva)