Sha256: dad552a9190df17198ad7d49f5c3201fd6575935174bbc4b58383018e2bb1f98

Contents?: true

Size: 1.13 KB

Versions: 129

Compression:

Stored size: 1.13 KB

Contents

# string-width [![Build Status](https://travis-ci.org/sindresorhus/string-width.svg?branch=master)](https://travis-ci.org/sindresorhus/string-width)

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

Some Unicode characters are [fullwidth](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) and use double the normal width. [ANSI escape codes](http://en.wikipedia.org/wiki/ANSI_escape_code) are stripped and doesn't affect the width.

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


## Install

```
$ npm install --save string-width
```


## Usage

```js
const stringWidth = require('string-width');

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

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

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


## Related

- [string-width-cli](https://github.com/sindresorhus/string-width-cli) - CLI for this module
- [string-length](https://github.com/sindresorhus/string-length) - Get the real length of a string
- [widest-line](https://github.com/sindresorhus/widest-line) - Get the visual width of the widest line in a string


## License

MIT © [Sindre Sorhus](https://sindresorhus.com)

Version data entries

129 entries across 90 versions & 18 rubygems

Version Path
optimacms-0.1.61 spec/dummy/node_modules/string-width/readme.md
disco_app-0.18.0 test/dummy/node_modules/string-width/readme.md
disco_app-0.18.0 test/dummy/node_modules/fsevents/node_modules/string-width/readme.md
disco_app-0.18.2 test/dummy/node_modules/string-width/readme.md
disco_app-0.16.1 test/dummy/node_modules/gauge/node_modules/string-width/readme.md
disco_app-0.15.2 test/dummy/node_modules/gauge/node_modules/string-width/readme.md
disco_app-0.18.4 test/dummy/node_modules/gauge/node_modules/string-width/readme.md
disco_app-0.18.1 test/dummy/node_modules/gauge/node_modules/string-width/readme.md
disco_app-0.12.7.pre.puma.pre.3 test/dummy/node_modules/gauge/node_modules/string-width/readme.md
disco_app-0.14.0 test/dummy/node_modules/gauge/node_modules/string-width/readme.md
disco_app-0.13.6.pre.puma.pre.3 test/dummy/node_modules/gauge/node_modules/string-width/readme.md
tang-0.2.1 spec/tang_app/node_modules/gauge/node_modules/string-width/readme.md
groonga-client-model-6.0.0 test/apps/rails6.1.3/node_modules/gauge/node_modules/string-width/readme.md
groonga-client-model-6.0.0 test/apps/rails6.0.3.5/node_modules/gauge/node_modules/string-width/readme.md
ruby2js-4.0.4 lib/tasks/testrails/node_modules/gauge/node_modules/string-width/readme.md
ruby2js-4.0.3 lib/tasks/testrails/node_modules/gauge/node_modules/string-width/readme.md
tang-0.2.0 spec/tang_app/node_modules/gauge/node_modules/string-width/readme.md
tang-0.1.0 spec/tang_app/node_modules/gauge/node_modules/string-width/readme.md
tang-0.0.9 spec/tang_app/node_modules/gauge/node_modules/string-width/readme.md
enju_library-0.3.8 spec/dummy/node_modules/fsevents/node_modules/string-width/readme.md