Unicode radio button symbol, for toggling on/off in prompts.
npm install radio-symbol> Unicode radio button symbol, for toggling on/off in prompts.
- Install
- Styles
- Usage
* Circle symbol
* Ballot symbol
* Star symbol
- About
_(TOC generated by verb using markdown-toc)_
Install with npm:
``sh`
$ npm install --save radio-symbol
Have an idea for another radio-symbol style? Pull requests greatly appreciated!
* All of the off states are unstyled.on
* All of the states are styled using ansi green.disabled
* All of the states are styled using ansi gray.
Unstyled
A .nocolor property is exposed with all states unstyled:
`js`
var radio = require('radio-symbol').nocolor;
The main export is a circle. This is the only symbol that has a windows-specific alternative.
_(I haven't tested the star or ballot symbols on windows, if you try them let us know if they have issues!)._
`js
var radio = require('radio-symbol');
console.log(radio.on);
//=> '◉'
console.log(radio.off);
//=> '◯'
console.log(radio.disabled);
//=> 'ⓧ'
`
Windows
`js
console.log(radio.on);
//=> '(*)'
console.log(radio.off);
//=> '( )'
console.log(radio.disabled);
//=> '(x)'
`
`js
var radio = require('radio-symbol');
console.log(radio.ballot.on);
//=> '☑'
console.log(radio.ballot.off);
//=> '☐
console.log(radio.ballot.disabled);
//=> '☒'
`
`js
var radio = require('radio-symbol');
console.log(radio.star.on);
//=> '★'
console.log(radio.star.off);
//=> '☆'
console.log(radio.star.disabled);
//=> '☆' // same as "off"
`
* error-symbol: Cross-platform error symbol. | homepage
* info-symbol: Cross-platform info symbol. | homepage
* success-symbol: Cross-platform success symbol. | homepage
* warning-symbol: Cross-platform warning symbol. | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
_(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)_
To generate the readme, run the following command:
`sh`
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
`sh``
$ npm install && npm test
Jon Schlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2017, Jon Schlinkert.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.6.0, on May 21, 2017._