Merge pull request #1 from julienw/1137097-fix-overflow-issue

Bug 1137097 - Report when the font fit algorithm couldn't fit the availa...
fxos-components · Mar 20, 2015 · 9d00191 · 9d00191
2 parents 46a3162 + 08114e2
commit 9d00191
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/font-fit.js b/font-fit.js
@@ -51,7 +51,7 @@ var BUFFER = 3;
  *   - {Number} `max` Max font-size (px) (optional)
  *
  * @param  {Object} config
- * @return {Object} {fontSize,textWidth}
+ * @return {Object} {fontSize,overflowing,textWidth}
  */
 module.exports = function(config) {
   debug('font fit', config);
@@ -70,7 +70,8 @@ module.exports = function(config) {
 
   return {
     textWidth: textWidth,
-    fontSize: fontSize
+    fontSize: fontSize,
+    overflowing: textWidth > space
   };
 };
 

diff --git a/test/test.js b/test/test.js
@@ -68,12 +68,14 @@ suite('FontFit', function() {
       this.config.text = createStringOfWidth(1000, this.config.font);
       var result = fontFit(this.config);
       assert.equal(result.fontSize, 16);
+      assert.isTrue(result.overflowing);
     });
 
     test('It doesn\'t go any higher than the max fontSize', function() {
       this.config.text = createStringOfWidth(10, this.config.font);
       var result = fontFit(this.config);
       assert.equal(result.fontSize, 24);
+      assert.isFalse(result.overflowing);
     });
 
     test('It ignores whitespace (just like HTML does)', function() {
@@ -95,7 +97,8 @@ suite('FontFit', function() {
 
     test('It uses a 3px buffer', function() {
       this.config.text = createStringOfWidth(100, this.config.font);
-      assert.ok(fontFit(this.config).textWidth <= 97, 'text width is at least 3px < overall space');
+      var result = fontFit(this.config);
+      assert.ok(result.textWidth <= 97, 'text width is at least 3px < overall space');
     });
   });