Have ideas to improve npm?Join in the discussion! »

    figures
    TypeScript icon, indicating that this package has built-in type declarations

    3.2.0 • Public • Published

    figures Build Status

    Unicode symbols with Windows CMD fallbacks

    and more...

    Windows CMD only supports a limited character set.

    Install

    $ npm install figures
    

    Usage

    See the source for supported symbols.

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


    Get professional support for this package with a Tidelift subscription
    Tidelift helps make open source sustainable for maintainers while giving companies
    assurances about security, maintenance, and licensing for their dependencies.

    Install

    npm i figures

    DownloadsWeekly Downloads

    25,678,501

    Version

    3.2.0

    License

    MIT

    Unpacked Size

    12.1 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar