• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# string-width [![Build Status](https://travis-ci.org/sindresorhus/string-width.svg?branch=master)](https://travis-ci.org/sindresorhus/string-width)
2
3> Get the visual width of a string - the number of columns required to display it
4
5Some Unicode characters are [fullwidth](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) and use double the normal width. [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code) are stripped and doesn't affect the width.
6
7Useful to be able to measure the actual width of command-line output.
8
9
10## Install
11
12```
13$ npm install string-width
14```
15
16
17## Usage
18
19```js
20const stringWidth = require('string-width');
21
22stringWidth('古');
23//=> 2
24
25stringWidth('\u001b[1m古\u001b[22m');
26//=> 2
27
28stringWidth('a');
29//=> 1
30
31stringWidth('\u001B]8;;https://github.com\u0007Click\u001B]8;;\u0007');
32// => 5
33```
34
35
36## Related
37
38- [string-width-cli](https://github.com/sindresorhus/string-width-cli) - CLI for this module
39- [string-length](https://github.com/sindresorhus/string-length) - Get the real length of a string
40- [widest-line](https://github.com/sindresorhus/widest-line) - Get the visual width of the widest line in a string
41
42
43## License
44
45MIT © [Sindre Sorhus](https://sindresorhus.com)
46