lix-website/themes/lix/assets/bootstrap/node_modules/widest-line/readme.md

35 lines
914 B
Markdown
Raw Normal View History

2024-04-27 03:39:10 +00:00
# widest-line [![Build Status](https://travis-ci.org/sindresorhus/widest-line.svg?branch=master)](https://travis-ci.org/sindresorhus/widest-line)
> Get the visual width of the widest line in 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 know the maximum width a string will take up in the terminal.
## Install
```
$ npm install widest-line
```
## Usage
```js
const widestLine = require('widest-line');
widestLine('古\n\u001B[1m@\u001B[22m');
//=> 2
```
## Related
- [string-width](https://github.com/sindresorhus/string-width) - Get the visual width of a string
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)