{"id":23900115,"url":"https://github.com/simplr-sh/avatar","last_synced_at":"2026-02-02T09:42:01.561Z","repository":{"id":270921272,"uuid":"911538199","full_name":"simplr-sh/avatar","owner":"simplr-sh","description":"A TypeScript library for generating beautiful gradient-based avatars with customizable text overlays.","archived":false,"fork":false,"pushed_at":"2025-01-04T03:04:29.000Z","size":90,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-02T09:06:47.135Z","etag":null,"topics":["avatar","avatar-generator","avatar-placeholder","gradient-image","npm-package","placeholder-generator","placeholder-image","typescript","typescript-library","vercel-avatar"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@simplr-sh/avatar","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simplr-sh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-03T08:55:26.000Z","updated_at":"2025-01-04T03:07:49.000Z","dependencies_parsed_at":"2025-01-04T04:17:07.616Z","dependency_job_id":"1e25cad2-74f0-4e0b-ba0c-a6db98d6926f","html_url":"https://github.com/simplr-sh/avatar","commit_stats":null,"previous_names":["simplr-sh/avatar"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/simplr-sh/avatar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplr-sh%2Favatar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplr-sh%2Favatar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplr-sh%2Favatar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplr-sh%2Favatar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simplr-sh","download_url":"https://codeload.github.com/simplr-sh/avatar/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplr-sh%2Favatar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29009633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-02T08:40:12.472Z","status":"ssl_error","status_checked_at":"2026-02-02T08:40:10.926Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["avatar","avatar-generator","avatar-placeholder","gradient-image","npm-package","placeholder-generator","placeholder-image","typescript","typescript-library","vercel-avatar"],"created_at":"2025-01-04T19:14:33.535Z","updated_at":"2026-02-02T09:42:01.539Z","avatar_url":"https://github.com/simplr-sh.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @simplr-sh/avatar\n\nA TypeScript library for generating beautiful gradient-based avatars with customizable text overlays.\n\n![Example Images](./example.png)\n\n## Installation\n\n```bash\n# Using bun\nbun i @simplr-sh/avatar\n```\n\n```bash\n# Using NPM\nnpm i @simplr-sh/avatar\n```\n\n```bash\n# Using Yarn\nyarn add @simplr-sh/avatar\n```\n\n## Features\n\n- Generate gradient-based avatars\n- Customizable size and border radius\n- Text overlay support\n- Full TypeScript support\n- Returns Base64 SVG data URI\n\n## API Reference\n\n### getAvatar(options)\n\nGenerate an avatar with a gradient background and text overlay.\n\nOptions:\n\n- `name` (string): Name used to generate the gradient\n- `text` (string): Text to display on the avatar\n- `size` (number, optional): Size of the avatar in pixels (default: 128)\n- `rounded` (number, optional): Border radius of the avatar (default: 0)\n\nReturns a Promise that resolves to a Base64 SVG data URI.\n\n## Usage\n\n### Vanilla JavaScript\n\n```typescript\nimport { getAvatar } from '@simplr-sh/avatar'\n\n// Generate a simple avatar\nconst avatar = await getAvatar({\n  name: 'John Doe',\n  text: 'JD',\n  size: 128,\n  rounded: 16,\n})\n\n// Use in HTML\nconst img = document.createElement('img')\nimg.src = avatar\ndocument.body.appendChild(img)\n```\n\n### React\n\n```tsx\nimport { useEffect, useState } from 'react'\nimport { getAvatar } from '@simplr-sh/avatar'\n\nfunction Avatar({ name, text, size = 128, rounded = 16 }) {\n  const [avatarSrc, setAvatarSrc] = useState\u003cstring\u003e('')\n\n  useEffect(() =\u003e {\n    getAvatar({ name, text, size, rounded })\n      .then(setAvatarSrc)\n      .catch(console.error)\n  }, [name, text, size, rounded])\n\n  return \u003cimg src={avatarSrc} alt={`Avatar for ${name}`} /\u003e\n}\n\n// Usage\nfunction App() {\n  return \u003cAvatar name=\"John Doe\" text=\"JD\" /\u003e\n}\n```\n\n## Attribution\n\nThis package is inspired by and contains code adapted from [Vercel's Avatar](https://github.com/vercel/avatar) repository. We're grateful to Vercel for their original work on avatar generation.\n\n## Development\n\n```bash\nbun install\nbun run index.ts\n```\n\nThis project was created using `bun init` in bun v1.1.42.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplr-sh%2Favatar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimplr-sh%2Favatar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplr-sh%2Favatar/lists"}