{"id":13688675,"url":"https://github.com/urbit/sigil-js","last_synced_at":"2025-04-05T20:08:12.492Z","repository":{"id":33602867,"uuid":"128997301","full_name":"urbit/sigil-js","owner":"urbit","description":"~4.2 billion default profile pics","archived":false,"fork":false,"pushed_at":"2024-02-22T18:07:51.000Z","size":5638,"stargazers_count":154,"open_issues_count":13,"forks_count":22,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-03-29T18:08:30.106Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/urbit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","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":"2018-04-10T21:31:19.000Z","updated_at":"2025-03-24T23:45:58.000Z","dependencies_parsed_at":"2024-01-17T06:10:03.095Z","dependency_job_id":"5ba4ea07-5d16-4a40-a036-c2907c92a674","html_url":"https://github.com/urbit/sigil-js","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbit%2Fsigil-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbit%2Fsigil-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbit%2Fsigil-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbit%2Fsigil-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/urbit","download_url":"https://codeload.github.com/urbit/sigil-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247393570,"owners_count":20931813,"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":[],"created_at":"2024-08-02T15:01:19.700Z","updated_at":"2025-04-05T20:08:12.473Z","avatar_url":"https://github.com/urbit.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# sigil-js\n\n[![npm (scoped)](https://img.shields.io/npm/v/@tlon/sigil-js?style=flat)](https://www.npmjs.com/package/@tlon/sigil-js)\n\n[→ Github](https://github.com/urbit/sigil-js)\n\nUrbit address space contains ~4.2 billion unique points. Each has a pronounceable, easily memorized name, something like ~ravmel-ropdyl. Sigils visualize these names – there are as many unique Sigils as there are Azimuth points. `@urbit/sigil-js` is a javascript library that converts one of these names into its corresponding Sigil.\n\n![sigil intro image](https://github.com/urbit/sigil-js/blob/master/docs/intro.png?raw=true)\n\n## Basic Usage\n\n\n### React\n ```js\nimport '@urbit/sigil-js'\n\nconst config = {\n  point: '~zod', // or 'zod'\n  size: 348,\n  background:'#010101', \n  foreground:'yellow',\n  detail:'none',\n  space:'none',\n}\n\nconst Sigil = ({ config }) =\u003e {\n  return (\n    \u003curbit-sigil {...config} /\u003e\n  )\n}\n ```\n\n## Install\n\n`npm install @urbit/sigil-js`\n\n## API\n\n|Param|Explanation|Type|Optional?\n|-----|-----------|----|---------\n|`point`|Any valid urbit point name|`string`|No, and can only accept galaxies, stars and planets.\n|`size`| Size of desired SVG output| `integer`| Yes, defaults to 128px \n|`foreground`| Foreground color| `string` | Yes, defaults to '#FFF' \n|`background`| Background color| `string` | Yes, defaults to '#000' \n|`detail`| Controls whether or not details should be rendered. Useful for small sizes below 48px | `none` or `default` | Yes, defaults to `default`\n|`space`| space between edge of sigil and edge of background| `none`, `large` or `default` | Yes, defaults to `default`\n\n\n### Build\n\n|Commands              | Description                                   |\n| -------------------- | --------------------------------------------- |\n|`npm run build`| Build the library from source              |\n|`npm run dev`| Build the library from source and copies build into `/preview`             |\n\n\n### Tests and Performance\n\n`npm run test`\n\n### Contributing\nPlease read [CONTRIBUTING.md](https://github.com/urbit/sigil-js/CONTRIBUTING.md) for details on the process for submitting pull requests to us.\n\n### Authors\n- ~ridlur-figbud\n\n### License\nThis project is licensed under the MIT License - see the [LICENSE.txt](https://github.com/urbit/sigil-js/LICENSE.md) file for details\n\n![sigil outro image](https://github.com/urbit/sigil-js/blob/master/docs/outro.png?raw=true)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Furbit%2Fsigil-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Furbit%2Fsigil-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Furbit%2Fsigil-js/lists"}