https://github.com/urbit/sigil-js
~4.2 billion default profile pics
https://github.com/urbit/sigil-js
Last synced: about 1 year ago
JSON representation
~4.2 billion default profile pics
- Host: GitHub
- URL: https://github.com/urbit/sigil-js
- Owner: urbit
- License: mit
- Created: 2018-04-10T21:31:19.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-22T18:07:51.000Z (over 2 years ago)
- Last Synced: 2025-03-29T18:08:30.106Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 5.38 MB
- Stars: 154
- Watchers: 18
- Forks: 22
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# sigil-js
[](https://www.npmjs.com/package/@tlon/sigil-js)
[→ Github](https://github.com/urbit/sigil-js)
Urbit 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.
## Basic Usage
### React
```js
import '@urbit/sigil-js'
const config = {
point: '~zod', // or 'zod'
size: 348,
background:'#010101',
foreground:'yellow',
detail:'none',
space:'none',
}
const Sigil = ({ config }) => {
return (
)
}
```
## Install
`npm install @urbit/sigil-js`
## API
|Param|Explanation|Type|Optional?
|-----|-----------|----|---------
|`point`|Any valid urbit point name|`string`|No, and can only accept galaxies, stars and planets.
|`size`| Size of desired SVG output| `integer`| Yes, defaults to 128px
|`foreground`| Foreground color| `string` | Yes, defaults to '#FFF'
|`background`| Background color| `string` | Yes, defaults to '#000'
|`detail`| Controls whether or not details should be rendered. Useful for small sizes below 48px | `none` or `default` | Yes, defaults to `default`
|`space`| space between edge of sigil and edge of background| `none`, `large` or `default` | Yes, defaults to `default`
### Build
|Commands | Description |
| -------------------- | --------------------------------------------- |
|`npm run build`| Build the library from source |
|`npm run dev`| Build the library from source and copies build into `/preview` |
### Tests and Performance
`npm run test`
### Contributing
Please read [CONTRIBUTING.md](https://github.com/urbit/sigil-js/CONTRIBUTING.md) for details on the process for submitting pull requests to us.
### Authors
- ~ridlur-figbud
### License
This project is licensed under the MIT License - see the [LICENSE.txt](https://github.com/urbit/sigil-js/LICENSE.md) file for details
