You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Michael Winter 555e2c196e initial commit 5 years ago
..
index.js initial commit 5 years ago
license initial commit 5 years ago
package.json initial commit 5 years ago
readme.md initial commit 5 years ago

readme.md

figures Build Status: Linux Build status: Windows

Unicode symbols with Windows CMD fallbacks

and more...

Windows CMD only supports a limited character set.

Install

$ npm install --save figures

Usage

See the source for supported symbols.

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

License

MIT © Sindre Sorhus