readme.md

Path: unified-ai-platform/node_modules/figures/readme.md
Size: 4,740 bytes
Lines: 140
Type: markdown
markdown
# 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>
← Back to Index ⬇ Download