radio-symbol

Unicode radio button symbol, for toggling on/off in prompts.

Table of Contents

• Install
• Styles
• Usage
  • Circle symbol
  • Ballot symbol
  • Star symbol
• About

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm install --save radio-symbol

Styles

Have an idea for another radio-symbol style? Pull requests greatly appreciated!

Usage

• All of the off states are unstyled.
• All of the on states are styled using ansi green.
• All of the disabled states are styled using ansi gray.

Unstyled

A .nocolor property is exposed with all states unstyled:

var radio = require('radio-symbol').nocolor;

Circle symbol

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!).

var radio = require('radio-symbol');
console.log(radio.on);
//=> '◉'
 
console.log(radio.off);
//=> '◯'
 
console.log(radio.disabled);
//=> 'ⓧ'

Windows

console.log(radio.on);
//=> '(*)'
 
console.log(radio.off);
//=> '( )'
 
console.log(radio.disabled);
//=> '(x)'

Ballot symbol

var radio = require('radio-symbol');
console.log(radio.ballot.on);
//=> '☑'
 
console.log(radio.ballot.off);
//=> '☐
 
console.log(radio.ballot.disabled);
//=> '☒' 

Star symbol

var radio = require('radio-symbol');
console.log(radio.star.on);
//=> '★'
 
console.log(radio.star.off);
//=> '☆'
 
console.log(radio.star.disabled);
//=> '☆' // same as "off"

About

Related projects

• 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

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(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:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

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:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on May 21, 2017.