string-width

Get the visual width of a string - the number of columns required to display it

Some Unicode characters are fullwidth and use double the normal width. ANSI escape codes are stripped and doesn't affect the width.

Useful to be able to measure the actual width of command-line output.

Install

npm install string-width

Usage

import stringWidth from 'string-width';

stringWidth('a');
//=> 1

stringWidth('古');
//=> 2

stringWidth('\u001B[1m古\u001B[22m');
//=> 2

API

stringWidth(string, options?)

string

Type: string

The string to be counted.

options

Type: object

ambiguousIsNarrow

Type: boolean
Default: true

Count ambiguous width characters as having narrow width (count of 1) instead of wide width (count of 2).

Ambiguous characters behave like wide or narrow characters depending on the context (language tag, script identification, associated font, source of data, or explicit markup; all can provide the context). If the context cannot be established reliably, they should be treated as narrow characters by default.

http://www.unicode.org/reports/tr11/

countAnsiEscapeCodes

Type: boolean
Default: false

Whether ANSI escape codes should be counted.

string-width-cli - CLI for this module
string-length - Get the real length of a string
widest-line - Get the visual width of the widest line in a string
get-east-asian-width - Determine the East Asian Width of a Unicode character

Current Tags

7.2.0 ... latest (6 months ago)
4.2.3 ... version4 (3 years ago)