Skip to content
foliojsPublic

About

A JS implementation of the Unicode Line Breaking Algorithm (UAX #14)

Resources

Stars

229 stars

Watchers

7 watching

Forks

Latest commit

 

History

76 Commits

Folders and files

Repository files navigation

linebreak

An implementation of the Unicode Line Breaking Algorithm (UAX #14)

Line breaking, also known as word wrapping, is the process of breaking a section of text into lines such that it will fit in the available width of a page, window or other display area. The Unicode Line Breaking Algorithm performs part of this process. Given an input text, it produces a set of positions called "break opportunities" that are appropriate points to begin a new line. The selection of actual line break positions from the set of break opportunities is not covered by the Unicode Line Breaking Algorithm, but is in the domain of higher level software with knowledge of the available width and the display size of the text.

This is a JavaScript implementation of the Unicode Line Breaking Algorithm for Node.js and browsers. Currently supports Unicode version 18.0. It is used by PDFKit for line wrapping text in PDF documents, but since the algorithm knows nothing about the actual visual appearance or layout of text, it could be used for other things as well.

Installation

You can install via npm

npm install linebreak

Example

import { LineBreaker } from 'linebreak';

var lorem = 'lorem ipsum...';
var breaker = new LineBreaker(lorem);
var last = 0;
var bk;

while (bk = breaker.nextBreak()) {
  // get the string between the last break and this one
  var word = lorem.slice(last, bk.position);
  console.log(word);

  // you can also check bk.required to see if this was a required break...
  if (bk.required) {
    console.log('\n\n');
  }

  last = bk.position;
}

Get the supported Unicode version:

import { UNICODE_VERSION } from 'linebreak';

console.log(UNICODE_VERSION); // '18.0.0'

Development Notes

In order to use the library, you shouldn't need to know this, but if you're interested in contributing or fixing bugs, these things might be of interest.

  • The src/classes-trie-data.js file is generated by node src/generate_data.js from LineBreak.txt, EastAsianWidth.txt, emoji-data.txt and DerivedGeneralCategory.txt in the Unicode database. The version is set in src/unicode-version.js. Class constants in src/classes.js and the algorithm must be updated manually when a Unicode release introduces new classes or rules.

  • You can run the tests using npm test. They are written using mocha, and generated from LineBreakTest.txt from the Unicode database, which is included in the repository for performance reasons while running them. All 19,346 conformance tests run without skips. To update the LineBreakTest.txt file, use the script node test/update_test_file.js, which downloads and updates the tests for the new Unicode version.

License

MIT

About

A JS implementation of the Unicode Line Breaking Algorithm (UAX #14)

Resources

Stars

229 stars

Watchers

7 watching

Forks

Releases

Packages

Used by

Contributors

Languages