https://github.com/ivstudio/tyger-avatar

Tyger-avatar offers a unique collection of avatar illustrations for React. These avatars are SVG-based and provide a wide range of customization options.
https://github.com/ivstudio/tyger-avatar

avatar illustrated libraries reactjs

Last synced: 10 months ago
JSON representation

Tyger-avatar offers a unique collection of avatar illustrations for React. These avatars are SVG-based and provide a wide range of customization options.

• Host: GitHub
• URL: https://github.com/ivstudio/tyger-avatar
• Owner: ivstudio
• Created: 2021-08-21T18:06:56.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-27T00:31:43.000Z (over 1 year ago)
• Last Synced: 2024-11-27T01:23:26.390Z (over 1 year ago)
• Topics: avatar, illustrated, libraries, reactjs
• Language: TypeScript
• Homepage: https://main--662d180db0870d8238437262.chromatic.com/
• Size: 6.3 MB
• Stars: 7
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# tyger-avatar

![npm](https://img.shields.io/npm/v/tyger-avatar) ![npm type definitions](https://img.shields.io/npm/types/tyger-avatar) ![npm](https://img.shields.io/npm/dm/tyger-avatar) ![tests](https://img.shields.io/badge/tests-passing-brightgreen)

> An illustrated avatar react library

Tyger-avatar offers a unique collection of avatar illustrations for React. These avatars are SVG-based and provide a wide range of customization options.

-   [Tyger-Avatar Storybook](https://main--662d180db0870d8238437262.chromatic.com/)

---

## Installation

```bash

npm i tyger-avatar

```

## Usage

```jsx

import { TygerAvatar } from 'tyger-avatar';

;

```

or

```jsx

import { TygerAvatar } from 'tyger-avatar';

import 'tyger-avatar/lib/bundle/styles.css';

;

```

## Options

| Prop    | Type                                                                                                                                                                                                                      |

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

| name    | `TrChelsea`, `TrEric`, `TrSamantha`, `TrTorsten`, `TrIggy`, `TrFranklin`, `TrImran`, `TrMaria`, `TrRachel`, `TrShamila`, `TrAlex`, `TrFelix`, `TrEnrique`, `TrSophia`, `TrHarry`, `TrHelen`, `TrStu`, `TrNancy`, `TrChad` |

| size    | `2xs`, `xs`, `sm`, `md`, `lg`, `xl`, `2xl`, `3xl`                                                                                                                                                                         |

| title   | string                                                                                                                                                                                                                    |

| id      | string                                                                                                                                                                                                                    |

| rounded | boolean                                                                                                                                                                                                                   |

-   [Storybook](https://main--662d180db0870d8238437262.chromatic.com/)

## License

MIT