textFit - Hassle-Free Text Fitting
A fast, dependency-free text sizing component that quickly fits single and multi-line text to the width and/or height of its container.
- Fast, using binary search to quickly fit text to its container in
log ntime, making it far faster than most solutions.
- Most fits are
<1ms. See the implementation details.
- Most fits are
- Supports both horizontal and vertical centering, including vertical centering with Flexbox for maximum accuracy.
- Supports any font face, padding, and multiline text.
textFit supports IE9+, Firefox, Chrome, Opera, and most mobile browsers. If you find an incompatibility,
please file an issue.
If you require IE <= 8 support, please use the jQuery version. Functionality is identical between v1.0 and v2.0, the only change was the removal of the jQuery dependency.
- Fix #20 - properly iterate over
alignVertWithFlexbox. This does better vertical alignment and fixes #14.
- Throw errors instead of just printing to console when missing height/width.
options.suppressErrors. Wrap in
try/catchinstead if you really need this.
- Slight refactor.
- Added automatic build on prepublish.
- Fixed a bug with
- Added full UMD shim and published to npm.
- Reworked alignVert.
trueby default. Set to
falseif you want to fire-and-forget on potentially processed nodes. This was originally false by default because it was being used in an infinite scrolling list.
- Removed jQuery dependency.
Fit me, I am some text
// textFit accepts arrays;// or single DOM elements;// Use jQuery selectors if you like.
The text will scale until it reaches the horizontal or vertical bounds of the box. Explicit width and height styles are required in order to fit the text.
If your text has multiple lines, textFit() will automatically detect that and disable white-space: no-wrap! No changes are necessary.
This textHas multiple linesFit me!
If, for some reason, the automatic detection is not working out for you, use the following to explicitly turn on multiLine fitting:
This textHas multiple linesAnd wants to be centered horizontally and verticallyFit me!
Minimum and Maximum Sizes
Sometimes you want to make sure that your text remains sanely sizes if it is very short or very long. textFit has you covered:
textFit determines reasonable minimum and maximum bounds for your text. The defaults are listed below.
To ensure accurate results with various font-faces, line-heights, and letter-spacings, textFit resizes the text until it fits the box as accurately as possible. Unlike many similar plugins, textFit uses binary search to find the correct fit, which speeds the process significantly. textFit is fast enough to use in production websites.
textFit() is a synchronous function. Because of this, resizes should be invisible as the render thread does not
have a chance to do a layout until completion. Normal processing times should be < 1ms and should not significantly
From the source, for reference:
settings =alignVert: false // if true, textFit will align vertically using css tablesalignHoriz: false // if true, textFit will set text-align: centermultiLine: false // if true, textFit will not set white-space: no-wrapdetectMultiLine: true // disable to turn off automatic multi-line sensingminFontSize: 6maxFontSize: 80reProcess: true // if true, textFit will re-process already-fit nodes. Set to 'false' for better performancewidthOnly: false // if true, textFit will fit text to element width, regardless of text heightalignVertWithFlexbox: false // if true, textFit will use flexbox for vertical alignment;