/react-avatar-stack

ReactJS component that will stack the child that you pass to it and add +n placeholder to it.

Primary LanguageJavaScript

Build Status

WIP, demo coming soon !

Example

react-avatar-stack component for ReactJS

ReactJS component that will stack the child that you pass to it and add +n placeholder to it.

Installation

  npm install react-avatar-stack

Getting started

<AvatarStack>
 <div>Avatar1</div>
 <div>Avatar2</div>
</AvatarStack>

Props:

  • onNumberLeftClick: function -> (), When the user click on the +n icon

  • nextOverlapPrevious: boolean, default true. The avatar on the right will overlap the one on the left

  • avatarSize: number, default 32, the size of the one child.

  • maxAvatarNumber: number, default 9, the max children number you want to show before adding a +n.

  • numberLeftBackgroundColor: string, +n background color

  • numberLeftColor: string, +n text color

Development

  • npm run build - produces production version
  • npm run dev - produces development version
  • npm test - run the tests