Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chewhx/ui-avatar-emoji
Generate an avatar with Apple Color Emoji
https://github.com/chewhx/ui-avatar-emoji
apple-color-emoji avatar emoji emojis profile-picture profile-picture-generator ui ui-avatars
Last synced: 2 days ago
JSON representation
Generate an avatar with Apple Color Emoji
- Host: GitHub
- URL: https://github.com/chewhx/ui-avatar-emoji
- Owner: chewhx
- Created: 2023-11-02T00:56:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-02T01:17:45.000Z (about 1 year ago)
- Last Synced: 2024-11-19T12:37:23.286Z (2 months ago)
- Topics: apple-color-emoji, avatar, emoji, emojis, profile-picture, profile-picture-generator, ui, ui-avatars
- Language: TypeScript
- Homepage: https://ui-avatar-emoji.vercel.app
- Size: 80.1 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ui-avatar-emoji
API for generating avatars with Apple Color Emoji.
- [vercel/og](https://www.npmjs.com/package/@vercel/og) for server generated images
- [Open Color](https://yeun.github.io/open-color/) for colors
- [apple-emoji-linux](https://github.com/samuelngs/apple-emoji-linux) for emoji png
- [ui-avatars](https://ui-avatars.com) for inspiration
# Endpoint
```plaintext
https://ui-avatar-emoji.vercel.app/api/avatar
```
# API
### Emoji
Default: `👻`
```plaintext
https://ui-avatar-emoji.vercel.app/api/avatar?emoji=😀
```
### Background
Default: `d0ebff`
HEX color code without '#'
```plaintext
https://ui-avatar-emoji.vercel.app/api/avatar?background=c3fae8
```
Random color
```plaintext
https://ui-avatar-emoji.vercel.app/api/avatar?background=random
```
### Rounded
Default: `0`
```plaintext
https://ui-avatar-emoji.vercel.app/api/avatar?rounded=15
```
For circle
```plaintext
https://ui-avatar-emoji.vercel.app/api/avatar?rounded=true
```
### Size
Default: `64`
```plaintext
https://ui-avatar-emoji.vercel.app/api/avatar?size=128
```
Size is restricted to min `32` and max `256`.
- Smaller than `min` will return `32`.
- Larger than `max` will return `256`.
###