npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fontpath-wordwrap

v1.0.1

Published

simple word-wrapping tools for fontpath

Downloads

86

Readme

A basic greedy word-wrapper based on LibGDX bitmap font rendering. Uses fontpath-glyph-iterator to lay out the glyphs and determine their visible widths.

usage

var WordWrap = require('fontpath-wordwrap');
var GlyphIterator = require('fontpath-glyph-iterator');

//setup a glyph iterator for your font
var iterator = new GlyphIterator(MyFont, fontSize);

//create a new word wrapper...
var wrap = new WordWrap();

//Lay out some text to a given width
wrap.text = myLongString;
wrap.layout( iterator, wrapWidth );

//this is an array of WordWrap.Line objects, 
//with start/end indices into myLongString
console.log( wrap.lines );

members

wrap.text

The string to process.

wrap.lines

An array of WordWrap.Line objects, which holds { start, end, width }. width is the computed width of the line.

wrap.empty()

Clears the current list of lines.

wrap.layout( glyphIterator, wrapWidth, start, end )

Lays out the currently set text instance variable, using the specified glyph iterator, an option wrap width (default to infinity), and optional start (inclusive) and end (exclusive) indices into the string. Start defaults to zero, end defaults to the string length.

This will add new Line objects onto the stack; so you may want to empty() the lines before laying out the text.

wrap.clearLayout( glyphIterator )

Clears the lines array to zero. Then, if the current text is not empty, a single Line will be added for the entire string (i.e. no word-wrapping or line breaking).

wrap.mode

Wordwrap mode, a string. Default normal. One of:

  • WordWrap.Mode.NORMAL or "normal" - wraps to a specified width, breaks on newlines, and collapses whitespace
  • WordWrap.Mode.PRE or "pre" - preserves whitespace, breaks on newlines
  • WordWrap.Mode.NOWRAP or "nowrap" - breaks on newlines and collapses whitespace, otherwise doesn't break

wrap.getMaxLineWidth()

A convenience method to return the maximum width of all current lines. Useful for text alignment.

example

See fontpath-canvas for a more complete implementation of this word-wrapper.

The following screenshot shows a single string which has been layed out with two different modes: 'normal' (first paragraph), and 'pre' (second paragraph). The gray border shows the wrap width being used. This text was rendered with paths in 2D Canvas.

Output

Here is the same string, with a smaller wrapWidth. Notice the pre block is clipped when wrapWidth is provided.

Out2

Roadmap

Eventually I hope to add basic styling support. For now, this only wraps text that all contain the same styling. Adding styles will likely lead to API breakage.