www.aleph1.co.uk Git - yaffs-website/blob - node_modules/figures/readme.md

   1 # figures [![Build Status: Linux](https://travis-ci.org/sindresorhus/figures.svg?branch=master)](https://travis-ci.org/sindresorhus/figures) [![Build status: Windows](https://ci.appveyor.com/api/projects/status/mb743hl70269be3r/branch/master?svg=true)](https://ci.appveyor.com/project/sindresorhus/figures/branch/master)
   2
   3 > Unicode symbols with Windows CMD fallbacks
   4
   5 [![](screenshot.png)](index.js)
   6
   7 [*and more...*](index.js)
   8
   9 Windows CMD only supports a [limited character set](http://en.wikipedia.org/wiki/Code_page_437).
  10
  11
  12 ## Install
  13
  14 ```
  15 $ npm install --save figures
  16 ```
  17
  18
  19 ## Usage
  20
  21 See the [source](index.js) for supported symbols.
  22
  23 ```js
  24 const figures = require('figures');
  25
  26 console.log(figures('✔︎ check'));
  27 // On real OSes:  ✔︎ check
  28 // On Windows:    √ check
  29
  30 console.log(figures.tick);
  31 // On real OSes:  ✔︎
  32 // On Windows:    √
  33 ```
  34
  35
  36 ## API
  37
  38 ### figures(input)
  39
  40 Returns the input with replaced fallback unicode symbols on Windows.
  41
  42 All the below [figures](#figures) are attached to the main export as shown in the example above.
  43
  44 #### input
  45
  46 Type: `string`
  47
  48 String where the unicode symbols will be replaced with fallback symbols depending on the OS.
  49
  50
  51 ## Figures
  52
  53 | Name               | Real OSes | Windows |
  54 | ------------------ | :-------: | :-----: |
  55 | tick               |     ✔     |    √    |
  56 | cross              |     ✖     |    ×    |
  57 | star               |     ★     |    *    |
  58 | square             |     ▇     |    █    |
  59 | squareSmall        |     ◻     |   [ ]   |
  60 | squareSmallFilled  |     ◼     |   [█]   |
  61 | play               |     ▶     |    ►    |
  62 | circle             |     ◯     |   ( )   |
  63 | circleFilled       |     ◉     |   (*)   |
  64 | circleDotted       |     ◌     |   ( )   |
  65 | circleDouble       |     ◎     |   ( )   |
  66 | circleCircle       |     ⓞ     |   (○)   |
  67 | circleCross        |     ⓧ     |   (×)   |
  68 | circlePipe         |     Ⓘ     |   (│)   |
  69 | circleQuestionMark |     ?⃝    |   (?)   |
  70 | bullet             |     ●     |    *    |
  71 | dot                |     ․     |    .    |
  72 | line               |     ─     |    ─    |
  73 | ellipsis           |     …     |   ...   |
  74 | pointer            |     ❯     |    >    |
  75 | pointerSmall       |     ›     |    »    |
  76 | info               |     ℹ     |    i    |
  77 | warning            |     ⚠     |    ‼    |
  78 | hamburger          |     ☰     |    ≡    |
  79 | smiley             |     ㋡     |    ☺    |
  80 | mustache           |     ෴     |   ┌─┐   |
  81 | heart              |     ♥     |    ♥    |
  82 | arrowUp            |     ↑     |    ↑    |
  83 | arrowDown          |     ↓     |    ↓    |
  84 | arrowLeft          |     ←     |    ←    |
  85 | arrowRight         |     →     |    →    |
  86 | radioOn            |     ◉     |   (*)   |
  87 | radioOff           |     ◯     |   ( )   |
  88 | checkboxOn         |     ☒     |   [×]   |
  89 | checkboxOff        |     ☐     |   [ ]   |
  90 | checkboxCircleOn   |     ⓧ     |   (×)   |
  91 | checkboxCircleOff  |     Ⓘ     |   ( )   |
  92 | questionMarkPrefix |     ?⃝    |    ？    |
  93 | oneHalf            |     ½     |   1/2   |
  94 | oneThird           |     ⅓     |   1/3   |
  95 | oneQuarter         |     ¼     |   1/4   |
  96 | oneFifth           |     ⅕     |   1/5   |
  97 | oneSixth           |     ⅙     |   1/6   |
  98 | oneSeventh         |     ⅐     |   1/7   |
  99 | oneEighth          |     ⅛     |   1/8   |
 100 | oneNinth           |     ⅑     |   1/9   |
 101 | oneTenth           |     ⅒     |   1/10  |
 102 | twoThirds          |     ⅔     |   2/3   |
 103 | twoFifths          |     ⅖     |   2/5   |
 104 | threeQuarters      |     ¾     |   3/4   |
 105 | threeFifths        |     ⅗     |   3/5   |
 106 | threeEighths       |     ⅜     |   3/8   |
 107 | fourFifths         |     ⅘     |   4/5   |
 108 | fiveSixths         |     ⅚     |   5/6   |
 109 | fiveEighths        |     ⅝     |   5/8   |
 110 | sevenEighths       |     ⅞     |   7/8   |
 111
 112
 113 ## License
 114
 115 MIT © [Sindre Sorhus](https://sindresorhus.com)