sigil-js

→ Github

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

import '@urbit/sigil-js'

const config = {
 point: '~zod', // or 'zod'
 size: 348,
 background:'#010101', 
 foreground:'yellow',
 detail:'none',
 space:'none',
}

const Sigil = ({ config }) => {
 return (
   <urbit-sigil {...config} />
 )
}

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 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 file for details

License

urbit/sigil-js

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Contributors 12

Languages

Packages