Align the text in a string.
Follow this project's author, Jon Schlinkert, for updates on this project and others.
Install with npm:
$ npm install --save align-textvar align = require('align-text');
align(text, function_or_integer);Params
textcan be a string or array. If a string is passed, a string will be returned. If an array is passed, an array will be returned.function|integer: if an integer, the text will be indented by that amount. If a transform function is passed, it must return an object with anintegerproperty or an integer representing the amount of leading indentation to use asalignloops over each line.
Example
align(text, 4);Would align:
abc
abc
abc
To:
abc
abc
abc
The callback is used to determine the indentation of each line and gets the following params:
lenthe length of the "current" linelongestthe length of the longest linelinethe current line (string) being alignedlinesthe array of all lines
The callback may return:
- an integer that represents the number of spaces to use for padding,
- or an object with the following properties:
indent: {Number} the amount of indentation to use. Default is0when an object is returned.character: {String} the character to use for indentation. Default is''(empty string) when an object is returned.prefix: {String} leading characters to use at the beginning of each line.''(empty string) when an object is returned.
Integer example:
// calculate half the difference between the length
// of the current line and the longest line
function centerAlign(len, longest, line, lines) {
return Math.floor((longest - len) / 2);
}Object example:
function centerAlign(len, longest, line, lines) {
return {
character: '\t',
indent: Math.floor((longest - len) / 2),
prefix: '~ ',
}
}Align text values in an array:
align([1, 2, 3, 100]);
//=> [' 1', ' 2', ' 3', '100']
Visit the example to see how this works.
Using the centerAlign function from above:
align(text, centerAlign);Would align this text:
Lorem ipsum dolor sit amet
consectetur adipiscin
elit, sed do eiusmod tempor incididun
ut labore et dolor
magna aliqua. Ut enim ad mini
veniam, quisResulting in this:
Lorem ipsum dolor sit amet,
consectetur adipiscing
elit, sed do eiusmod tempor incididunt
ut labore et dolore
magna aliqua. Ut enim ad minim
veniam, quis
Customize
If you wanted to add more padding on the left, just pass the number in the callback.
For example, to add 4 spaces before every line:
function centerAlign(len, longest, line, lines) {
return 4 + Math.floor((longest - len) / 2);
}Would result in:
Lorem ipsum dolor sit amet,
consectetur adipiscing
elit, sed do eiusmod tempor incididunt
ut labore et dolore
magna aliqua. Ut enim ad minim
veniam, quis
align(text, function (len, max, line, lines) {
return {prefix: ' - '};
});Would return:
- Lorem ipsum dolor sit amet,
- consectetur adipiscing
- elit, sed do eiusmod tempor incididunt
- ut labore et dolore
- magna aliqua. Ut enim ad minim
- veniam, quis
align(text, function (len, max, line, lines) {
return {
indent: Math.floor((max - len) / 2),
character: '~',
};
});Would return
~~~~~Lorem ipsum dolor sit amet,
~~~~~~~~consectetur adipiscing
elit, sed do eiusmod tempor incididunt
~~~~~~~~~ut labore et dolore
~~~~magna aliqua. Ut enim ad minim
~~~~~~~~~~~~~veniam, quis
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
| Commits | Contributor |
|---|---|
| 14 | jonschlinkert |
| 2 | shinnn |
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verbRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm testJon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on September 13, 2017.
