npm package: @keyvaluesystems/react-inline-avatars
Description: A customizable Inline Avatar stack
Author: Keyvalue
Latest version: 1.2.0

# React Inline Avatars

<a href="https://www.npmjs.com/package/@keyvaluesystems/react-inline-avatars"><img src="https://badgen.net/npm/v/@keyvaluesystems/react-inline-avatars?color=blue" alt="npm version"></a> <a href="https://www.npmjs.com/package/@keyvaluesystems/react-inline-avatars" ><img src="https://img.shields.io/npm/dw/@keyvaluesystems/react-inline-avatars?label=Downloads" /></a> <a href="https://github.com/KeyValueSoftwareSystems/react-inline-avatars"><img src="https://github.com/KeyValueSoftwareSystems/react-inline-avatars/actions/workflows/deploy.yml/badge.svg" alt="" /></a>

<div align="center">
<img src="./screenshot.png" alt="" width="280" height="80"/>
</div>

> A customizable ready to use Inline Avatar stack for React

Try tweaking a inline avatar stack using this codesandbox link <a href="https://codesandbox.io/p/sandbox/react-inline-avatars-2lvdgf" >here</a>

## Installation

The easiest way to use react-inline-avatars is to install it from npm and build it into your app with Webpack.

```bash
npm install @keyvaluesystems/react-inline-avatars
```

You’ll need to install React separately since it isn't included in the package.

Note for **Next.js** users, if you are using Next.js version 13 or later, you will have to use the `use client` feature to ensure proper compatibility.

## Usage

React Inline Avatars can run in a very basic mode by just providing the `data` like given below:

```jsx
import InlineImages from "@keyvaluesystems/react-inline-avatars";

<InlineImages data={dataArray} />;
```

The data is an array of objects with the following keys:

- `name` - a string that represents each user's name
- `avatarUrl` - a string to specify the user image
- `renderComponent` - a JSX element that, when provided, enables the dynamic rendering of custom content when hovering over user's image

An example for data array is shown below:

```jsx
const dataArray = [
  {
    name: "Jon Dew",
    avatarUrl: "example.svg"
  },
  {
    name: "Jack",
    renderComponent: () => (
      <div className="sample-class"> Sample Component </div>
    )
  }
];
```

If no avatarUrl is specified for the user, following default Image will be considered.

<div align="center">
<img src="./src/assets/default-avatar.svg" alt="" width="40" height="40"/>
</div>


## v1.0.0 (Major Version Change)

This release includes breaking changes, new features, and updates. Please read this document carefully before upgrading

### Breaking Changes

- `elivateOnHover` prop is renamed to `elevateOnHover`.
- `nameOnHover` prop is renamed to `showNameOnHover`.
- `ExtraValue` class is renamed to `ExtraCount`.


### Migration Steps

- Replace `elivateOnHover` with elevateOnHover: The `elivateOnHover` prop has been replaced with `elevateOnHover`.
- Replace `nameOnHover` with showNameOnHover: The `nameOnHover` prop has been replaced with `showNameOnHover`.
- Utilize `ExtraCount` class instead of `ExtraValue` class: To override the style of additional count displayed at last bubble.

<b>Before</b>

```jsx
<InlineImages
  data={dataArray}
  elivateOnHover={true}
  nameOnHover={true}
  styles={{
    Avatar: () => ({ ...styles }),
    Name: () => ({ ...styles }),
    ExtraValue: () => ({ ...styles })
  }}
/>
```

<b>After</b>

```jsx
<InlineImages
  data={dataArray}
  elevateOnHover={true}
  showNameOnHover={true}
  styles={{
    Avatar: () => ({ ...styles }),
    Name: () => ({ ...styles }),
    ExtraCount: () => ({ ...styles })
  }}
/>
```

## Props

Props that can be passed to the component are listed below:

<table>
  <thead>
    <tr>
      <th>Prop</th>
      <th>Description</th>
      <th>Default</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code><b>data:</b> object[]</code></td>
      <td>
      An array of user objects to specify the name and avatar url (image url)
      </td>
      <td><code>undefined</code></td>
    </tr>
    <tr>
      <td><code><b>totalUserCount?:</b> number</code></td>
      <td>
      To specify the total number of users present if the additional count is to be displayed at the end of the image stack. The additional count displayed will be the difference between this value and length of data array
      </td>
      <td><code>0</code></td>
    </tr>
     <tr>
      <td><code><b>size?:</b> number</code></td>
      <td>
      To specify the size of the image element
      </td>
      <td><code>40</code></td>
    </tr>
     <tr>
      <td><code><b>variant?:</b> 'circular' | 'square' | 'rounded'</code></td>
      <td>
      To specify the shape of the image element
      </td>
      <td><code>'circular'</code></td>
    </tr>
    <tr>
      <td><code><b>elevateOnHover?:</b> boolean</code></td>
      <td>
      To add an elevation effect on hover action for user images
      </td>
      <td><code>false</code></td>
    </tr>
    <tr>
      <td><code><b>showNameOnHover?:</b> boolean</code></td>
      <td>
        To show the name of each user on hovering over the user image. If there is a specified render component in the data array, it will be displayed instead of the name when you hover over the user's image
      </td>
      <td><code>false</code></td>
    </tr>
      <tr>
      <td><code><b>defaultAvatarImage?:</b> string</code></td>
      <td>
       To show a default avatar, if no avatarUrl is specified for a user. if there is no specified avatarUrl and defaultAvatarImage, default image will be considered.
      </td>
      <td><code><img src="./src/assets/default-avatar.svg" alt="" width="40" height="40"/></code></td>
    </tr>
    <tr>
      <td><code><b>onUserClick?:</b>(user: object) => void</code></td>
      <td>
        A callback function to be triggered on image click
      </td>
      <td><code>undefined</code></td>
    </tr>
     <tr>
      <td><code><b>onCountClick?:</b>() => void</code></td>
      <td>
        A callback function to be triggered on additional count(last bubble) click
      </td>
      <td><code>undefined</code></td>
    </tr>
    <tr>
      <td><code><b>spaceBetweenPics?:</b> number</code></td>
      <td>
        To specify the distance between each avatar (user image)
      </td>
      <td><code>20</code></td>
    </tr>
     <tr>
      <td><code><b>styles?:</b> object</code></td>
      <td>
        To override the default styles provided by this package. 
      </td>
      <td><code>undefined</code></td>
    </tr>
  </tbody>
</table>

## Style Customizations

All the default styles provided by this package are overridable using the `styles` prop.
The below code shows all the overridable styles:

```jsx
<InlineImages
  data={dataArray}
  styles={{
    Avatar: () => ({ ...styles }),
    Name: () => ({ ...styles }),
    ExtraCount: () => ({ ...styles }),
  }}
/>

```

- `Avatar` - Overrides the avatar (user image) style
- `Name` - Overrides the user name style
- `ExtraCount` - Overrides the style of additional count displayed at last bubble

Example with the usage of other props

```jsx
<InlineImages
  data={dataArray}
  styles= {
    Avatar: () => ({
      border: "1px solid white"
    }),
    Name: () => ({
      color: "white",
      fontSize: "16px",
      backgroundColor: "grey",
      padding: "5px",
      borderRadius: "10px"
    }),
    ExtraCount: () => ({
      backgroundColor: "yellow",
      border: "1px solid white"
    })
  }
/>

```