# react-username-avatar

> Create username avatar and profile image

Latest version **1.0.6** (published 2023-08-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install react-username-avatar
pnpm add react-username-avatar
yarn add react-username-avatar
bun add react-username-avatar
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2023-08-12 |
| First published | 2022-07-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 3.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | madhukar |
| Maintainers | madhukarsingh |

## Links

- npm: https://www.npmjs.com/package/react-username-avatar
- npm.io page: https://npm.io/package/react-username-avatar

## Dependencies (3)

- [react](https://npm.io/package/react.md) ^18.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [react-scripts](https://npm.io/package/react-scripts.md) 5.0.1

## Recent versions

- 1.0.6 (latest) — 2023-08-12
- 1.0.5 — 2023-08-12
- 1.0.4 — 2022-07-31
- 1.0.3 — 2022-07-24
- 1.0.2 — 2022-07-24
- 1.0.1 — 2022-07-24
- 1.0.0 — 2022-07-24

## README

# Getting Started with React username avatar

To begin, you'll need to install `react-username-avatar`

## How to Use

```
npm i react-username-avatar
```

## Example

[Check on CODE SANDBOX](https://codesandbox.io/s/frosty-chaum-914izu?file=/src/App.js)

```
import ReactAvatar from "react-username-avatar";
const App = () => {
  return (
    <div>
     <ReactAvatar
    fname="user"
    lname="Name"
    backgroundcolour="red"
    textcolour="white"
    image="https://fakeimg.pl/300/"
    size="100"
    fontsize="50"
    borderradius="2"
    borderColor="black"
    className="my-class"
  />
    </div>
  );
}

export default App;
```

## Usage

- `fname` is used to pass name of user firts name. TYPE: `string`
- `lname` is used to pass name of user last name. TYPE: `string`
- `backgroundcolour` is used to change background color. TYPE: `string`
- `textcolour` is used to change text color. TYPE: `string`
- `image` is used to show user image. TYPE: `string`
- `size` is used to change avatar size. TYPE: `string`
- `fontsize` is used to change font size of avatar. TYPE: `string`
- `borderradius` is used for border radius in avatar. TYPE: `number`
- `borderColor` is used to change border color. TYPE: `string`
- `className` is used to add own class. TYPE: `string`

---
_Source: https://npm.io/package/react-username-avatar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._