{"id":13459001,"url":"https://github.com/boringdesigners/boring-avatars","last_synced_at":"2025-03-24T16:31:14.343Z","repository":{"id":37461834,"uuid":"323913869","full_name":"boringdesigners/boring-avatars","owner":"boringdesigners","description":"Boring avatars is a tiny JavaScript React library that generates custom, SVG-based avatars from any username and color palette.","archived":false,"fork":false,"pushed_at":"2024-04-09T13:57:43.000Z","size":2979,"stargazers_count":5415,"open_issues_count":2,"forks_count":183,"subscribers_count":23,"default_branch":"master","last_synced_at":"2024-05-01T09:43:40.087Z","etag":null,"topics":["avatar","avatar-component","avatar-generator","avatar-placeholder","avatar-service","avatars-constructor","beautiful-avatars","javascript","random-avatars","react","svg"],"latest_commit_sha":null,"homepage":"https://boringavatars.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/boringdesigners.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":"boringdesigners"}},"created_at":"2020-12-23T13:47:36.000Z","updated_at":"2024-06-14T07:42:17.838Z","dependencies_parsed_at":"2024-06-14T07:42:04.771Z","dependency_job_id":"857b7ee1-24df-40aa-aef6-6e21d3068eac","html_url":"https://github.com/boringdesigners/boring-avatars","commit_stats":{"total_commits":185,"total_committers":5,"mean_commits":37.0,"dds":"0.44324324324324327","last_synced_commit":"392e7fc571503e3292bd6dfd2332875b8d2a1261"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boringdesigners%2Fboring-avatars","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boringdesigners%2Fboring-avatars/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boringdesigners%2Fboring-avatars/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boringdesigners%2Fboring-avatars/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boringdesigners","download_url":"https://codeload.github.com/boringdesigners/boring-avatars/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245308536,"owners_count":20594263,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-component","avatar-generator","avatar-placeholder","avatar-service","avatars-constructor","beautiful-avatars","javascript","random-avatars","react","svg"],"created_at":"2024-07-31T09:01:00.808Z","updated_at":"2025-03-24T16:31:13.890Z","avatar_url":"https://github.com/boringdesigners.png","language":"JavaScript","funding_links":["https://github.com/sponsors/boringdesigners"],"categories":["JavaScript","DevTools","TypeScript","Uncategorized"],"sub_categories":["Languages","Uncategorized"],"readme":"# Boring avatars\n\nBoring avatars is a tiny JavaScript React library that generates custom, SVG-based avatars from any username and color palette.\n\u003ca href=\"https://www.npmjs.com/package/boring-avatars\"\u003e\n\n![hi](https://badgen.net/npm/v/boring-avatars)\n\n\u003c/a\u003e\n\n## Install\n\n```\nnpm install boring-avatars\n```\n\n## Usage\n\n```jsx\nimport Avatar from 'boring-avatars';\n\n\u003cAvatar name=\"Maria Mitchell\" /\u003e;\n```\n\n### Props\n\n| Prop    | Type                                                         | Default                                                   |\n|---------|--------------------------------------------------------------|-----------------------------------------------------------|\n| size    | number or string                                             | `40px`                                                    |\n| square  | boolean                                                      | `false`                                                   |\n| title   | boolean                                                      | `false`                                                   |\n| name    | string                                                       | `Clara Barton`                                            |\n| variant | oneOf: `marble`, `beam`, `pixel`,`sunset`, `ring`, `bauhaus` | `marble`                                                  |\n| colors  | array                                                        | `['#92A1C6', '#146A7C', '#F0AB3D', '#C271B4', '#C20D90']` | \n\n\n#### Name\nThe `name` prop is used to generate the avatar. It can be the username, email or any random string.\n\n```jsx\n\u003cAvatar name=\"Maria Mitchell\"/\u003e\n```\n\n#### Variant\nThe `variant` prop is used to change the theme of the avatar. The available variants are: `marble`, `beam`, `pixel`, `sunset`, `ring` and `bauhaus`.\n\n```jsx\n\u003cAvatar name=\"Alice Paul\" variant=\"beam\"/\u003e\n```\n\n#### Size\nThe `size` prop is used to change the size of the avatar.\n\n```jsx\n\u003cAvatar name=\"Ada Lovelace\" size={88}/\u003e\n```\n\n#### Colors\nThe `colors` prop is used to change the color palette of the avatar.\n\n```jsx\n\u003cAvatar name=\"Grace Hopper\" colors={[\"#fb6900\", \"#f63700\", \"#004853\", \"#007e80\", \"#00b9bd\"]}/\u003e\n```\n\n#### Square\nThe `square` prop is used to make the avatar square.\n\n```jsx\n\u003cAvatar name=\"Helen Keller\" square/\u003e\n```\n\n## API service\n\n\u003e [!IMPORTANT]  \n\u003e Please note that the old service was paused in July 31st 2024. We recommend transitioning to our new API service to ensure uninterrupted access and support.\n\nGet access to the Boring avatars API service [here →](https://boringdesigners.gumroad.com/l/boring-avatars-service).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboringdesigners%2Fboring-avatars","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboringdesigners%2Fboring-avatars","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboringdesigners%2Fboring-avatars/lists"}