Blame view

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