jonschlinkert/justified

Wrap, align and justify the words in a string.

justified

Wraps words to a specified length and justifies the text in each line.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save justified

Usage

var justify = require('justified');

justify('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 nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.');

Results 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
nostrud exercitation ullamco laboris nisi ut aliquip ex
ea  commodo consequat.  Duis    aute  irure    dolor in
reprehenderit in voluptate  velit esse cillum dolore eu
fugiat    nulla  pariatur.    Excepteur  sint  occaecat
cupidatat  non proident,    sunt in culpa   qui officia
deserunt mollit anim id est laborum.

Options

See word-wrap for additional options beyond the following.

options.width

Type: number

Default: 55

Set the maximum width for the justified text.

options.indent

Type: number

Default: 0

Add the specified number of spaces (left padding) before each line in the given string.

options.random

Type: function

Default: a pseudo-random function is used to provide the appearance of randomization. The purpose of this is to ensure that whitespace doesn't appear to be somewhat "aligned" in columns on the left or right side of the text (which is distracting to readers), whilst also making the result technically predictable so that you're not getting a different result every time you call the "justified" function.

options.justifyLastLine

Type: boolean|function

Default: false

The last line in the string is not justified by default.

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running 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 test

Building docs

(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 && verb

Related projects

You might also be interested in these projects:

• pad-left: Left pad a string with zeros or a specified string. Fastest implementation. | homepage
• pad-right: Right pad a string with zeros or a specified string. Fastest implementation. | homepage
• repeat-string: Repeat the given string n times. Fastest implementation for repeating a string. | homepage

Contributors

Commits	Contributor
19	jonschlinkert
2	parro-it

Author

Jon Schlinkert

• linkedin/in/jonschlinkert
• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on February 12, 2018.