README
Hypher
Fork of hyphenation library to remove jQuery and delete unused code.
A small and fast JavaScript hyphenation engine. Can be used in Node.js and as a jQuery plugin.
Node.js
Hypher can be installed from NPM:
npm install hypher hyphenation.en-us
You can then use it in your program by creating an instance of Hypher and giving it a language object:
var Hypher = require('hypher'),
english = require('hyphenation.en-us'),
h = new Hypher(english);
// returns ['hy', 'phen', 'ation']
h.hyphenate('hyphenation');
See examples/node/ for a full example on how to use Hypher. The hyphenate method does not support hyphenated compound words. These should be split into individual words before being passed to the hyphenation engine and reassembled afterwards by the caller. You can also use the hyphenateText method to hyphenate a string of text. The hyphenateText method does support compound words and returns a string with inserted soft hyphens (\u00AD.)
// returns 'Hy|phen|ation is use|ful when cen|ter jus|ti|fy|ing a text.' where `|` is a soft hyphen
h.hyphenateText('Hyphenation is useful when center justifying a text.');
The hyphenateText method takes an optional second parameter minLength which is the minimum length a word should have to be considered for hyphenation (defaults to 4.) Note that an instance of the Hypher class should only be created once for each language object.
The language object should contain:
{
// The minimum number of unhyphenated characters at the left of each word. (required)
leftmin: <number>,
// The minimum number of unhyphenated characters at the right of each word. (required)
rightmin: <number>,
// A comma separated list of hyphenation exceptions. Custom hyphenations
// can be specified using '\u2027' (hyphenation point) as hyphenation
// character. List items are case-insensitive. (Optional)
exceptions: <string>,
// A patterns object (required)
patterns: {}
}
Language patterns can be found in the patterns repository.
License
Hypher is licensed under the three clause BSD license (see BSD.txt.)
See also
Contributors
- Laurens Meurs - improvements to the exception list