https://github.com/abhijithvijayan/react-initials-avatar

Minimal initials avatar component for React
https://github.com/abhijithvijayan/react-initials-avatar

Last synced: 3 days ago
JSON representation

Minimal initials avatar component for React

• Host: GitHub
• URL: https://github.com/abhijithvijayan/react-initials-avatar
• Owner: abhijithvijayan
• License: mit
• Created: 2020-10-30T18:30:01.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-06-15T15:16:18.000Z (over 2 years ago)
• Last Synced: 2024-11-02T10:52:43.802Z (10 days ago)
• Language: JavaScript
• Size: 16.6 KB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/FUNDING.yml
  • License: license

Awesome Lists containing this project

README

        
react-initials-avatar

  



  

    

  

  

    

  

  

  

    

  

  

    

  

  

     

  



🙋‍♂️ Made by @abhijithvijayan





  Donate:

  PayPal,

  Patreon





  

    

  





❤️ it? ⭐️ it on [GitHub](https://github.com/abhijithvijayan/react-initials-avatar/stargazers) or [Tweet](https://twitter.com/intent/tweet?text=Check%20out%20react-initials-avatar%21%20by%20%40_abhijithv%0A%0AMinimal%20initials%20avatar%20component%20for%20React%0Ahttps%3A%2F%2Fgithub.com%2Fabhijithvijayan%2Freact-initials-avatar%0A%0A%23react%20%23initialsavatar%20%23library%20%23javascript%20%23typescript) about it.

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [API](#api)

- [Issues](#issues)

  - [🐛 Bugs](#-bugs)

- [LICENSE](#license)

## Installation

Ensure you have [Node.js](https://nodejs.org) 10 or later installed. Then run the following:

```

# via npm

npm install react-initials-avatar

# or yarn

yarn add react-initials-avatar

```

## Usage



```js

import React from 'react';

import InitialsAvatar from 'react-initials-avatar';

import 'react-initials-avatar/lib/ReactInitialsAvatar.css';

function App() {

    return (

      <>

        

      >

    );

}

```

## API

#### name

Type: `string`

Name for Initials generation

#### className

Type: `string`

Default: `initial-avatar` (with basic styles if css file is imported)

class name for the root div element.

## Issues

_Looking to contribute? Look for the [Good First Issue](https://github.com/abhijithvijayan/react-initials-avatar/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)

label._

### 🐛 Bugs

Please file an issue [here](https://github.com/abhijithvijayan/react-initials-avatar/issues/new) for bugs, missing documentation, or unexpected behavior.

[**See Bugs**](https://github.com/abhijithvijayan/react-initials-avatar/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22type%3A+bug%22)

### Linting & TypeScript Config

- Shared Eslint & Prettier Configuration - [`@abhijithvijayan/eslint-config`](https://www.npmjs.com/package/@abhijithvijayan/eslint-config)

- Shared TypeScript Configuration - [`@abhijithvijayan/tsconfig`](https://www.npmjs.com/package/@abhijithvijayan/tsconfig)

## License

MIT © [Abhijith Vijayan](https://abhijithvijayan.in)