Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/figures
Unicode symbols with fallbacks for older terminals
https://github.com/sindresorhus/figures
command-line command-line-utility node-module npm-package terminal unicode unicode-symbols
Last synced: about 1 month ago
JSON representation
Unicode symbols with fallbacks for older terminals
- Host: GitHub
- URL: https://github.com/sindresorhus/figures
- Owner: sindresorhus
- License: mit
- Created: 2014-07-10T00:02:21.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T19:16:08.000Z (7 months ago)
- Last Synced: 2024-04-14T11:09:11.395Z (5 months ago)
- Topics: command-line, command-line-utility, node-module, npm-package, terminal, unicode, unicode-symbols
- Language: JavaScript
- Homepage:
- Size: 95.7 KB
- Stars: 582
- Watchers: 13
- Forks: 23
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
- Security: .github/security.md
Awesome Lists containing this project
- awesome-cross-platform-nodejs - figures - Unicode symbols with Windows fallbacks. (Libraries / Shell)
- awesome-nodejs - figures - Unicode symbols with Windows CMD fallbacks. (Packages / Command-line utilities)
- awesome-f2e-libs - **figures** - ✔︎ 等特殊字符，做了 windows 兼容处理。 (命令行 / redux 扩展)
- awesome-nodejs-cn - figures - Windows CMD后备的Unicode符号. (目录 / 命令行工具)
- awesome - sindresorhus/figures - Unicode symbols with fallbacks for older terminals (JavaScript)
- awesome-nodejs - figures - Unicode symbols with Windows fallbacks.  (Repository / Command-line Utilities)
- awesome-nodejs-cn - figures - 支援 Windows CMD 回退方案的 Unicode 符号 (包 / 命令行工具)
- awesome-starred-test - sindresorhus/figures - Unicode symbols with fallbacks for older terminals (JavaScript)
- awesome-nodejs - figures - Unicode symbols with Windows CMD fallbacks. (Packages / Command-line utilities)
- awesome-node - figures - Unicode symbols with Windows CMD fallbacks. (Packages / Command-line utilities)
- awesome-nodejs - figures - 在 windows 或其他终端显示 Unicode 符号 (Uncategorized / Uncategorized)
- awesome - sindresorhus/figures - Unicode symbols with fallbacks for older terminals (terminal)
- awesome-andy-node - figures - Unicode symbols with Windows CMD fallbacks. (Packages / Command-line utilities)
- awesome-nodejs-precise - figures - square)]() | Unicode symbols with Windows CMD fallbacks. | (Packages / Command-line utilities)
- awesome-fe - **figures** - ✔︎ 等特殊字符，做了 windows 兼容处理。 (命令行 / macros)
- awesome-nodejs - figures - Unicode symbols with Windows CMD fallbacks - ★ 296 (Command-line utilities)
- awesome-nodejs-new - figures - Unicode symbols with Windows CMD fallbacks. (Packages / Command-line utilities)
- awesome-nodejs-cn - figures - **star:591** 带有Windows CMD回退的Unicode符号 (包 / 命令行实用工具)
- awesome-nodejs-cn - figures - Unicode symbols with Windows CMD fallbacks. (包 / Command-line utilities)
README
# figures
> Unicode symbols with fallbacks for older terminals
[](index.js)
[*and more...*](index.js)
Terminals such as Windows Console Host (and CMD) only support a [limited character set](http://en.wikipedia.org/wiki/Code_page_437).
## Install
```sh
npm install figures
```
## Usage
```js
import figures, {mainSymbols, fallbackSymbols, replaceSymbols} from 'figures';
console.log(figures.tick);
// On terminals with Unicode symbols: ✔
// On other terminals: √
console.log(mainSymbols.tick);
// On all terminals: ✔
console.log(fallbackSymbols.tick);
// On all terminals: √
console.log(replaceSymbols('✔ check'));
// On terminals with Unicode symbols: ✔ check
// On other terminals: √ check
```
## API
### figures (default export)
Type: `object`
Symbols to use on any terminal.
### mainSymbols
Symbols to use when the terminal supports Unicode symbols.
### fallbackSymbols
Symbols to use when the terminal does not support Unicode symbols.
### replaceSymbols(string, options?)
Returns the input with replaced fallback symbols if the terminal has poor Unicode support.
All the below [figures](#figures) are attached to the default export as shown in the example above.
#### string
Type: `string`
String where the Unicode symbols will be replaced with fallback symbols depending on the terminal.
#### options
Type: `object`
##### useFallback
Type: `boolean`\
Default: `true` if the terminal has poor Unicode support
Whether to replace symbols with fallbacks.
This can be set to `true` to always use fallback symbols, whether the terminal has poor Unicode support or not.
```js
import {replaceSymbols} from 'figures';
console.log(replaceSymbols('✔ check', {useFallback: true}));
// On terminals with Unicode symbols: √ check
// On other terminals: √ check
```
## Figures
`Fallback` characters are only shown when they differ from the `Main` ones.
| Name | Main | Fallback |
| ------------------------------------------- | :--: | :------: |
| tick | `✔` | `√` |
| info | `ℹ` | `i` |
| warning | `⚠` | `‼` |
| cross | `✘` | `×` |
| square | `█` | |
| squareSmall | `◻` | `□` |
| squareSmallFilled | `◼` | `■` |
| squareDarkShade | `▓` | |
| squareMediumShade | `▒` | |
| squareLightShade | `░` | |
| squareTop | `▀` | |
| squareBottom | `▄` | |
| squareLeft | `▌` | |
| squareRight | `▐` | |
| squareCenter | `■` | |
| circle | `◯` | `( )` |
| circleFilled | `◉` | `(*)` |
| circleDotted | `◌` | `( )` |
| circleDouble | `◎` | `( )` |
| circleCircle | `ⓞ` | `(○)` |
| circleCross | `ⓧ` | `(×)` |
| circlePipe | `Ⓘ` | `(│)` |
| circleQuestionMark | `?⃝ ` | `(?)` |
| radioOn | `◉` | `(*)` |
| radioOff | `◯` | `( )` |
| checkboxOn | `☒` | `[×]` |
| checkboxOff | `☐` | `[ ]` |
| checkboxCircleOn | `ⓧ` | `(×)` |
| checkboxCircleOff | `Ⓘ` | `( )` |
| questionMarkPrefix | `?⃝ ` | `？` |
| bullet | `●` | |
| dot | `․` | |
| ellipsis | `…` | |
| pointer | `❯` | `>` |
| pointerSmall | `›` | `›` |
| triangleUp | `▲` | |
| triangleUpSmall | `▴` | |
| triangleUpOutline | `△` | `∆` |
| triangleDown | `▼` | |
| triangleDownSmall | `▾` | |
| triangleLeft | `◀` | `◄` |
| triangleLeftSmall | `◂` | |
| triangleRight | `▶` | `►` |
| triangleRightSmall | `▸` | |
| lozenge | `◆` | `♦` |
| lozengeOutline | `◇` | `◊` |
| home | `⌂` | |
| hamburger | `☰` | `≡` |
| smiley | `㋡` | `☺` |
| mustache | `෴` | `┌─┐` |
| heart | `♥` | |
| star | `★` | `✶` |
| play | `▶` | `►` |
| musicNote | `♪` | |
| musicNoteBeamed | `♫` | |
| nodejs | `⬢` | `♦` |
| arrowUp | `↑` | |
| arrowDown | `↓` | |
| arrowLeft | `←` | |
| arrowRight | `→` | |
| arrowLeftRight | `↔` | |
| arrowUpDown | `↕` | |
| almostEqual | `≈` | |
| notEqual | `≠` | |
| lessOrEqual | `≤` | |
| greaterOrEqual | `≥` | |
| identical | `≡` | |
| infinity | `∞` | |
| subscriptZero | `₀` | |
| subscriptOne | `₁` | |
| subscriptTwo | `₂` | |
| subscriptThree | `₃` | |
| subscriptFour | `₄` | |
| subscriptFive | `₅` | |
| subscriptSix | `₆` | |
| subscriptSeven | `₇` | |
| subscriptEight | `₈` | |
| subscriptNine | `₉` | |
| oneHalf | `½` | |
| oneThird | `⅓` | |
| oneQuarter | `¼` | |
| oneFifth | `⅕` | |
| oneSixth | `⅙` | |
| oneSeventh | `⅐` | `1/7` |
| oneEighth | `⅛` | |
| oneNinth | `⅑` | `1/9` |
| oneTenth | `⅒` | `1/10` |
| twoThirds | `⅔` | |
| twoFifths | `⅖` | |
| threeQuarters | `¾` | |
| threeFifths | `⅗` | |
| threeEighths | `⅜` | |
| fourFifths | `⅘` | |
| fiveSixths | `⅚` | |
| fiveEighths | `⅝` | |
| sevenEighths | `⅞` | |
| line | `─` | |
| lineBold | `━` | |
| lineDouble | `═` | |
| lineDashed0 | `┄` | |
| lineDashed1 | `┅` | |
| lineDashed2 | `┈` | |
| lineDashed3 | `┉` | |
| lineDashed4 | `╌` | |
| lineDashed5 | `╍` | |
| lineDashed6 | `╴` | |
| lineDashed7 | `╶` | |
| lineDashed8 | `╸` | |
| lineDashed9 | `╺` | |
| lineDashed10 | `╼` | |
| lineDashed11 | `╾` | |
| lineDashed12 | `−` | |
| lineDashed13 | `–` | |
| lineDashed14 | `‐` | |
| lineDashed15 | `⁃` | |
| lineVertical | `│` | |
| lineVerticalBold | `┃` | |
| lineVerticalDouble | `║` | |
| lineVerticalDashed0 | `┆` | |
| lineVerticalDashed1 | `┇` | |
| lineVerticalDashed2 | `┊` | |
| lineVerticalDashed3 | `┋` | |
| lineVerticalDashed4 | `╎` | |
| lineVerticalDashed5 | `╏` | |
| lineVerticalDashed6 | `╵` | |
| lineVerticalDashed7 | `╷` | |
| lineVerticalDashed8 | `╹` | |
| lineVerticalDashed9 | `╻` | |
| lineVerticalDashed10 | `╽` | |
| lineVerticalDashed11 | `╿` | |
| lineDownLeft | `┐` | |
| lineDownLeftArc | `╮` | |
| lineDownBoldLeftBold | `┓` | |
| lineDownBoldLeft | `┒` | |
| lineDownLeftBold | `┑` | |
| lineDownDoubleLeftDouble | `╗` | |
| lineDownDoubleLeft | `╖` | |
| lineDownLeftDouble | `╕` | |
| lineDownRight | `┌` | |
| lineDownRightArc | `╭` | |
| lineDownBoldRightBold | `┏` | |
| lineDownBoldRight | `┎` | |
| lineDownRightBold | `┍` | |
| lineDownDoubleRightDouble | `╔` | |
| lineDownDoubleRight | `╓` | |
| lineDownRightDouble | `╒` | |
| lineUpLeft | `┘` | |
| lineUpLeftArc | `╯` | |
| lineUpBoldLeftBold | `┛` | |
| lineUpBoldLeft | `┚` | |
| lineUpLeftBold | `┙` | |
| lineUpDoubleLeftDouble | `╝` | |
| lineUpDoubleLeft | `╜` | |
| lineUpLeftDouble | `╛` | |
| lineUpRight | `└` | |
| lineUpRightArc | `╰` | |
| lineUpBoldRightBold | `┗` | |
| lineUpBoldRight | `┖` | |
| lineUpRightBold | `┕` | |
| lineUpDoubleRightDouble | `╚` | |
| lineUpDoubleRight | `╙` | |
| lineUpRightDouble | `╘` | |
| lineUpDownLeft | `┤` | |
| lineUpBoldDownBoldLeftBold | `┫` | |
| lineUpBoldDownBoldLeft | `┨` | |
| lineUpDownLeftBold | `┥` | |
| lineUpBoldDownLeftBold | `┩` | |
| lineUpDownBoldLeftBold | `┪` | |
| lineUpDownBoldLeft | `┧` | |
| lineUpBoldDownLeft | `┦` | |
| lineUpDoubleDownDoubleLeftDouble | `╣` | |
| lineUpDoubleDownDoubleLeft | `╢` | |
| lineUpDownLeftDouble | `╡` | |
| lineUpDownRight | `├` | |
| lineUpBoldDownBoldRightBold | `┣` | |
| lineUpBoldDownBoldRight | `┠` | |
| lineUpDownRightBold | `┝` | |
| lineUpBoldDownRightBold | `┡` | |
| lineUpDownBoldRightBold | `┢` | |
| lineUpDownBoldRight | `┟` | |
| lineUpBoldDownRight | `┞` | |
| lineUpDoubleDownDoubleRightDouble | `╠` | |
| lineUpDoubleDownDoubleRight | `╟` | |
| lineUpDownRightDouble | `╞` | |
| lineDownLeftRight | `┬` | |
| lineDownBoldLeftBoldRightBold | `┳` | |
| lineDownLeftBoldRightBold | `┯` | |
| lineDownBoldLeftRight | `┰` | |
| lineDownBoldLeftBoldRight | `┱` | |
| lineDownBoldLeftRightBold | `┲` | |
| lineDownLeftRightBold | `┮` | |
| lineDownLeftBoldRight | `┭` | |
| lineDownDoubleLeftDoubleRightDouble | `╦` | |
| lineDownDoubleLeftRight | `╥` | |
| lineDownLeftDoubleRightDouble | `╤` | |
| lineUpLeftRight | `┴` | |
| lineUpBoldLeftBoldRightBold | `┻` | |
| lineUpLeftBoldRightBold | `┷` | |
| lineUpBoldLeftRight | `┸` | |
| lineUpBoldLeftBoldRight | `┹` | |
| lineUpBoldLeftRightBold | `┺` | |
| lineUpLeftRightBold | `┶` | |
| lineUpLeftBoldRight | `┵` | |
| lineUpDoubleLeftDoubleRightDouble | `╩` | |
| lineUpDoubleLeftRight | `╨` | |
| lineUpLeftDoubleRightDouble | `╧` | |
| lineUpDownLeftRight | `┼` | |
| lineUpBoldDownBoldLeftBoldRightBold | `╋` | |
| lineUpDownBoldLeftBoldRightBold | `╈` | |
| lineUpBoldDownLeftBoldRightBold | `╇` | |
| lineUpBoldDownBoldLeftRightBold | `╊` | |
| lineUpBoldDownBoldLeftBoldRight | `╉` | |
| lineUpBoldDownLeftRight | `╀` | |
| lineUpDownBoldLeftRight | `╁` | |
| lineUpDownLeftBoldRight | `┽` | |
| lineUpDownLeftRightBold | `┾` | |
| lineUpBoldDownBoldLeftRight | `╂` | |
| lineUpDownLeftBoldRightBold | `┿` | |
| lineUpBoldDownLeftBoldRight | `╃` | |
| lineUpBoldDownLeftRightBold | `╄` | |
| lineUpDownBoldLeftBoldRight | `╅` | |
| lineUpDownBoldLeftRightBold | `╆` | |
| lineUpDoubleDownDoubleLeftDoubleRightDouble | `╬` | |
| lineUpDoubleDownDoubleLeftRight | `╫` | |
| lineUpDownLeftDoubleRightDouble | `╪` | |
| lineCross | `╳` | |
| lineBackslash | `╲` | |
| lineSlash | `╱` | |
## Other characters
If you cannot find the character you're looking for in the table above, please look at this full list of [cross-platform terminal characters](https://github.com/ehmicky/cross-platform-terminal-characters).
## Unsupported terminals
The following terminals are not officially supported:
- xterm
- Linux Terminal (kernel)
- cmder
They can display most but not all of the symbols listed above.
## Related
- [log-symbols](https://github.com/sindresorhus/log-symbols) - Colored symbols for various log levels