2022-04-07 07:06:43 +00:00
# figures [](https://travis-ci.org/sindresorhus/figures)
2022-01-21 08:28:41 +00:00
> Unicode symbols with Windows CMD fallbacks
[](index.js)
[*and more...* ](index.js )
Windows CMD only supports a [limited character set ](http://en.wikipedia.org/wiki/Code_page_437 ).
## Install
```
2022-04-07 07:06:43 +00:00
$ npm install figures
2022-01-21 08:28:41 +00:00
```
## Usage
See the [source ](index.js ) for supported symbols.
```js
const figures = require('figures');
console.log(figures('✔︎ check'));
2022-04-07 07:06:43 +00:00
// On non-Windows OSes: ✔︎ check
// On Windows: √ check
2022-01-21 08:28:41 +00:00
console.log(figures.tick);
2022-04-07 07:06:43 +00:00
// On non-Windows OSes: ✔︎
// On Windows: √
2022-01-21 08:28:41 +00:00
2022-04-07 07:06:43 +00:00
console.log(figures.main.tick);
// On all OSes: ✔︎
console.log(figures.windows.tick);
// On all OSes: √
```
2022-01-21 08:28:41 +00:00
## API
2022-04-07 07:06:43 +00:00
### figures(string)
2022-01-21 08:28:41 +00:00
2022-04-07 07:06:43 +00:00
Returns the input with replaced fallback Unicode symbols on Windows.
2022-01-21 08:28:41 +00:00
All the below [figures ](#figures ) are attached to the main export as shown in the example above.
2022-04-07 07:06:43 +00:00
#### string
2022-01-21 08:28:41 +00:00
Type: `string`
2022-04-07 07:06:43 +00:00
String where the Unicode symbols will be replaced with fallback symbols depending on the OS.
### figures.main
Symbols to use when not running on Windows.
### figures.windows
Symbols to use when running on Windows.
2022-01-21 08:28:41 +00:00
## Figures
2022-04-07 07:06:43 +00:00
| Name | Non-Windows | Windows |
| ------------------ | :---------: | :-----: |
| tick | ✔ | √ |
| cross | ✖ | ×
| star | ★ | * |
| square | ▇ | █ |
| squareSmall | ◻ | [ ] |
| squareSmallFilled | ◼ | [█] |
| play | ▶ | ► |
| circle | ◯ | ( ) |
| circleFilled | ◉ | (*) |
| circleDotted | ◌ | ( ) |
| circleDouble | ◎ | ( ) |
| circleCircle | ⓞ | (○) |
| circleCross | ⓧ | (×
| circlePipe | Ⓘ | (│) |
| circleQuestionMark | ?⃝ | (?) |
| bullet | ● | * |
| dot | ․
| line | ─ | ─ |
| ellipsis | … | ... |
| pointer | ❯
| pointerSmall | ›
| info | ℹ
| warning | ⚠ | ‼ |
| hamburger | ☰ | ≡ |
| smiley | ㋡ | ☺ |
| mustache | ෴ | ┌─┐ |
| heart | ♥ | ♥ |
| nodejs | ⬢ | ♦ |
| 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 |
2022-01-21 08:28:41 +00:00
## Related
- [log-symbols ](https://github.com/sindresorhus/log-symbols ) - Colored symbols for various log levels
2022-04-07 07:06:43 +00:00
---
< div align = "center" >
< b >
< a href = "https://tidelift.com/subscription/pkg/npm-figures?utm_source=npm-figures&utm_medium=referral&utm_campaign=readme" > Get professional support for this package with a Tidelift subscription< / a >
< / b >
< br >
< sub >
Tidelift helps make open source sustainable for maintainers while giving companies< br > assurances about security, maintenance, and licensing for their dependencies.
< / sub >
< / div >
