voxmedia/text-balancer

Name: text-balancer

Owner: Vox Media

Description: Eliminate typographic widows and other type crimes with this javascript module

Forked from: NYTimes/text-balancer

Created: 2017-06-15 01:32:53.0

Updated: 2018-03-19 13:25:01.0

Pushed: 2017-09-15 12:40:32.0

Homepage:

Size: 16

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

text-balancer

Text-balancer is a javascript module that seeks to eliminate typographic widows from text. It does this by setting the max-width of the dom node to the threshold that it would spill onto another line.

Setup instructions

Install it into your project via npm

npm install text-balancer --save

https://www.npmjs.com/package/text-balancer

We use bramstein's Font Face Observer to check when our fonts have loaded: https://github.com/bramstein/fontfaceobserver

We run our text-balancer once our fonts load.

How to run it

rt textBalancer from 'text-balancer';

un it when you want to with any set of selectors
Balancer.balanceText('.headline, .interactive-leadin, #horse-god');

R: Just run it and it will look for anything with the balance-text class
Balancer.balanceText();

Tests

No tests right now, but we're working on them! It's being used on nytimes.com and has been debugged and tested extensively on that.