# figures [![Build Status](https://travis-ci.org/sindresorhus/figures.svg?branch=master)](https://travis-ci.org/sindresorhus/figures)

> 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 figures
```

## Usage

See the [source](index.js) for supported symbols.

```js
const figures = require('figures');

console.log(figures('鉁旓笌 check'));
// On non-Windows OSes:  鉁旓笌 check
// On Windows:           鈭� check

console.log(figures.tick);
// On non-Windows OSes:  鉁旓笌
// On Windows:           鈭�

console.log(figures.main.tick);
// On all OSes:  鉁旓笌

console.log(figures.windows.tick);
// On all OSes:  鈭�
```

## API

### figures(string)

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.

#### string

Type: `string`

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.


## Figures

| 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               |      鈩�      |    i    |
| 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   |


## Related

- [log-symbols](https://github.com/sindresorhus/log-symbols) - Colored symbols for various log levels

---

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