https://github.com/fabiospampinato/ansi-pad
A couple tiny functions for padding a string that may contain ANSI escape sequences.
https://github.com/fabiospampinato/ansi-pad
ansi left pad padding right
Last synced: 11 months ago
JSON representation
A couple tiny functions for padding a string that may contain ANSI escape sequences.
- Host: GitHub
- URL: https://github.com/fabiospampinato/ansi-pad
- Owner: fabiospampinato
- License: mit
- Created: 2024-02-27T21:19:47.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-11T23:51:35.000Z (over 1 year ago)
- Last Synced: 2025-06-04T21:13:07.327Z (12 months ago)
- Topics: ansi, left, pad, padding, right
- Language: JavaScript
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# ANSI Pad
A couple tiny functions for padding a string that may contain ANSI escape sequences.
## Install
```sh
npm install ansi-pad
```
## Usage
```ts
import {padStart, padEnd} from 'ansi-pad';
// Let's pad a string in a width-aware way, handling ANSI escapes, emojis etc. specially
const FOO = `\u001b[31mFOO\u001b[39m`;
padStart ( FOO, 2, '๐จโ๐ฉโ๐งโ๐ฆ' ) // => `${FOO}`
padStart ( FOO, 5, '๐จโ๐ฉโ๐งโ๐ฆ' ) // => `๐จโ๐ฉโ๐งโ๐ฆ${FOO}`
padStart ( FOO, 7, '๐จโ๐ฉโ๐งโ๐ฆ' ) // => `๐จโ๐ฉโ๐งโ๐ฆ๐จโ๐ฉโ๐งโ๐ฆ${FOO}`
padEnd ( FOO, 2, '๐จโ๐ฉโ๐งโ๐ฆ' ) // => `${FOO}`
padEnd ( FOO, 5, '๐จโ๐ฉโ๐งโ๐ฆ' ) // => `${FOO}๐จโ๐ฉโ๐งโ๐ฆ`
padEnd ( FOO, 7, '๐จโ๐ฉโ๐งโ๐ฆ' ) // => `${FOO}๐จโ๐ฉโ๐งโ๐ฆ๐จโ๐ฉโ๐งโ๐ฆ`
```
## License
MIT ยฉ Fabio Spampinato