Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/minagishl/hono-avatars
Avatar generation service using Hono and Cloudflare Pages
https://github.com/minagishl/hono-avatars
cloudflare-pages hono typescript
Last synced: 2 months ago
JSON representation
Avatar generation service using Hono and Cloudflare Pages
- Host: GitHub
- URL: https://github.com/minagishl/hono-avatars
- Owner: minagishl
- License: mit
- Created: 2024-07-26T13:57:42.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-11T16:44:53.000Z (3 months ago)
- Last Synced: 2024-10-25T10:37:14.530Z (2 months ago)
- Topics: cloudflare-pages, hono, typescript
- Language: TypeScript
- Homepage: https://hono-avatars.pages.dev
- Size: 149 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hono Avatars
This repository contains code that uses the REST API to generate avatars and return them as images.
## Usage
All requests return an image stream to be used directly in an `![]()
` tag.
**Generate an avatar with default settings, for user "John Doe":**
```
https://hono-avatars.pages.dev/?name=john+doe
```
**Generate a blue avatar:**
```
https://hono-avatars.pages.dev/?background=0D8ABC&color=fff
```
## Parameters
> **Note:** This project is compatible with `ui-avatars.com`, some parameters are not supported but should work the same.
- `background` - The background color of the avatar. Default is `#DDDDDD`.
- `blur` - The blur of the avatar. Default is `0`.
- `bold` - The font weight of the text. Default is `false`.
- `border` - The border of the avatar. Default is `false`.
- `border-style` - The border style of the avatar. Default is `solid`.
- `border-width` - The border width of the avatar. Default is `0.5`.
- `color` - The text color of the avatar. Default is `#222222`.
- `font-family` - The font family of the text. Default is `sans`.
- `font-size` - The font size of the text. Default is `0.5`.
- `format` - The format of the image. Default is `png`.
- `length` - The length of the text. Default is `2`.
- `name` - The name of the user to generate the avatar.
- `oblique` - The font style of the text. Default is `false`.
- `opacity` - The opacity of the avatar. Default is `1`.
- `reverse` - The reverse of the text. Default is `false`.
- `rotate` - The rotation of the text. Default is `0`.
- `rounded` - The border radius of the avatar. Default is `false`.
- `shadow` - The text shadow of the text. Default is `false`.
- `size` - The size of the avatar. Default is `64`.
- `uppercase` - The text transform of the text. Default is `true`.
- `preset` - The preset of the avatar. Default is `default`.
## Detailed Parameters Usage
Click to expand!
### background
- **Description**: The background color of the avatar.
- **Default**: `#DDDDDD`
- **Example**: `background=0D8ABC`
- **Values**: Any valid hex color code
### blur
- **Description**: The blur of the avatar.
- **Default**: `0`
- **Example**: `blur=1`
- **Values**: Any integer between `0` and `1`
### bold
- **Description**: The font weight of the text.
- **Default**: `false`
- **Example**: `bold=true`
- **Values**: `true`, `false`
### border
- **Description**: The border of the avatar.
- **Default**: `false`
- **Example**: `border=0D8ABC`
- **Values**: Any valid hex color code or `false`
### border-style
- **Description**: The border style of the avatar.
- **Default**: `solid`
- **Example**: `border-style=dashed`
- **Values**: `solid`, `dashed`
### border-width
- **Description**: The border width of the avatar.
- **Default**: `0.5`
- **Example**: `border-width=1`
- **Values**: Any decimal between `0.1` and `1`
### color
- **Description**: The text color of the avatar.
- **Default**: `#222222`
- **Example**: `color=fff`
- **Values**: Any valid hex color code
### font-family
- **Description**: The font family of the text.
- **Default**: `sans`
- **Example**: `font-family=serif`
- **Values**: `mono`, `sans`, `serif` (`mono` is English only)
### font-size
- **Description**: The font size of the text.
- **Default**: `0.5`
- **Example**: `font-size=0.7`
- **Values**: Any decimal between `0.1` and `1`
### format
- **Description**: The format of the image.
- **Default**: `png`
- **Example**: `format=svg`
- **Values**: `png`, `svg`
### length
- **Description**: The length of the text.
- **Default**: `2`
- **Example**: `length=full`
- **Values**: Any positive integer or `full`
### name
- **Description**: The name of the user to generate the avatar.
- **Default**: None
- **Example**: `name=John+Doe`
- **Values**: Any string value (max 40 characters)
### oblique
- **Description**: The font style of the text.
- **Default**: `false`
- **Example**: `oblique=true`
- **Values**: `true`, `false`
### opacity
- **Description**: The opacity of the avatar.
- **Default**: `1`
- **Example**: `opacity=0.5`
- **Values**: Any decimal between `0` and `1`
### reverse
- **Description**: The reverse of the text.
- **Default**: `false`
- **Example**: `reverse=true`
- **Values**: `true`, `false`
### rotate
- **Description**: The rotation of the text.
- **Default**: `0`
- **Example**: `rotate=45`
- **Values**: Any integer between `-360` and `360`
### rounded
- **Description**: The border radius of the avatar.
- **Default**: `false`
- **Example**: `rounded=true`
- **Values**: `true`, `false`
### shadow
- **Description**: The text shadow of the text.
- **Default**: `false`
- **Example**: `shadow=true`
- **Values**: `true`, `false`
### size
- **Description**: The size of the avatar.
- **Default**: `64`
- **Example**: `size=128`
- **Values**: Any integer between `16` and `512`
### uppercase
- **Description**: The text transform of the text.
- **Default**: `true`
- **Example**: `uppercase=false`
- **Values**: `true`, `false`
### preset
- **Description**: The preset of the avatar.
- **Default**: `default`
- **Example**: `preset=google`
- **Values**: `default`, `google`
## License
`hono-avatars` project is licensed under the [MIT License](LICENSE).