@d3plus/text 3.0.3 → 3.0.4

package/README.md

@@ -30,7 +30,7 @@ Live examples can be found on [d3plus.org](https://d3plus.org/), which includes
 * [strip](#strip) - Removes all non ASCII characters from a string.
 * [textSplit](#textSplit) - Splits a given sentence into an array of words.
 * [textWrap](#textWrap) - Based on the defined styles and dimensions, breaks a string into an array of strings for each line of text.
-* [titleCase](#titleCase) - Capitalizes the first letter of each word in a phrase/sentence.
+* [titleCase](#titleCase) - Capitalizes the first letter of each word in a phrase/sentence, accounting for words in English that should be kept lowercase such as "and" or "of", as well as acronym that should be kept uppercase such as "CEO" or "TVs".
 * [trim](#trim) - Cross-browser implementation of [trim](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/Trim).
 * [trimLeft](#trimLeft) - Cross-browser implementation of [trimLeft](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/TrimLeft).
 * [trimRight](#trimRight) - Cross-browser implementation of [trimRight](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/TrimRight).
@@ -62,7 +62,7 @@ This is a global function
 ---
 
 <a name="textSplit"></a>
-#### d3plus.**textSplit**(sentence) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textSplit.js#L51)
+#### d3plus.**textSplit**(sentence) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textSplit.js#L3)
 
 Splits a given sentence into an array of words.
 
@@ -92,7 +92,7 @@ This is a global function
     * [.width([*value*])](#textWrap.width)
 
 
-<a name="textWrap.fontFamily" href="#textWrap.fontFamily">#</a> d3plus..**fontFamily**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L90)
+<a name="textWrap.fontFamily" href="#textWrap.fontFamily">#</a> d3plus..**fontFamily**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L92)
 
 If *value* is specified, sets the font family accessor to the specified function or string and returns this generator. If *value* is not specified, returns the current font family.
 
@@ -100,7 +100,7 @@ If *value* is specified, sets the font family accessor to the specified function
 This is a static method of [<code>textWrap</code>](#textWrap)
 
 
-<a name="textWrap.fontSize" href="#textWrap.fontSize">#</a> d3plus..**fontSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L99)
+<a name="textWrap.fontSize" href="#textWrap.fontSize">#</a> d3plus..**fontSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L101)
 
 If *value* is specified, sets the font size accessor to the specified function or number and returns this generator. If *value* is not specified, returns the current font size.
 
@@ -108,7 +108,7 @@ If *value* is specified, sets the font size accessor to the specified function o
 This is a static method of [<code>textWrap</code>](#textWrap)
 
 
-<a name="textWrap.fontWeight" href="#textWrap.fontWeight">#</a> d3plus..**fontWeight**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L108)
+<a name="textWrap.fontWeight" href="#textWrap.fontWeight">#</a> d3plus..**fontWeight**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L110)
 
 If *value* is specified, sets the font weight accessor to the specified function or number and returns this generator. If *value* is not specified, returns the current font weight.
 
@@ -116,7 +116,7 @@ If *value* is specified, sets the font weight accessor to the specified function
 This is a static method of [<code>textWrap</code>](#textWrap)
 
 
-<a name="textWrap.height" href="#textWrap.height">#</a> d3plus..**height**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L117)
+<a name="textWrap.height" href="#textWrap.height">#</a> d3plus..**height**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L119)
 
 If *value* is specified, sets height limit to the specified value and returns this generator. If *value* is not specified, returns the current value.
 
@@ -124,7 +124,7 @@ If *value* is specified, sets height limit to the specified value and returns th
 This is a static method of [<code>textWrap</code>](#textWrap)
 
 
-<a name="textWrap.lineHeight" href="#textWrap.lineHeight">#</a> d3plus..**lineHeight**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L126)
+<a name="textWrap.lineHeight" href="#textWrap.lineHeight">#</a> d3plus..**lineHeight**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L128)
 
 If *value* is specified, sets the line height accessor to the specified function or number and returns this generator. If *value* is not specified, returns the current line height accessor, which is 1.1 times the [font size](#textWrap.fontSize) by default.
 
@@ -132,7 +132,7 @@ If *value* is specified, sets the line height accessor to the specified function
 This is a static method of [<code>textWrap</code>](#textWrap)
 
 
-<a name="textWrap.maxLines" href="#textWrap.maxLines">#</a> d3plus..**maxLines**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L135)
+<a name="textWrap.maxLines" href="#textWrap.maxLines">#</a> d3plus..**maxLines**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L137)
 
 If *value* is specified, sets the maximum number of lines allowed when wrapping.
 
@@ -140,7 +140,7 @@ If *value* is specified, sets the maximum number of lines allowed when wrapping.
 This is a static method of [<code>textWrap</code>](#textWrap)
 
 
-<a name="textWrap.overflow" href="#textWrap.overflow">#</a> d3plus..**overflow**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L144)
+<a name="textWrap.overflow" href="#textWrap.overflow">#</a> d3plus..**overflow**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L146)
 
 If *value* is specified, sets the overflow to the specified boolean and returns this generator. If *value* is not specified, returns the current overflow value.
 
@@ -148,7 +148,7 @@ If *value* is specified, sets the overflow to the specified boolean and returns
 This is a static method of [<code>textWrap</code>](#textWrap)
 
 
-<a name="textWrap.split" href="#textWrap.split">#</a> d3plus..**split**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L153)
+<a name="textWrap.split" href="#textWrap.split">#</a> d3plus..**split**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L155)
 
 If *value* is specified, sets the word split function to the specified function and returns this generator. If *value* is not specified, returns the current word split function.
 
@@ -156,7 +156,7 @@ If *value* is specified, sets the word split function to the specified function
 This is a static method of [<code>textWrap</code>](#textWrap)
 
 
-<a name="textWrap.width" href="#textWrap.width">#</a> d3plus..**width**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L162)
+<a name="textWrap.width" href="#textWrap.width">#</a> d3plus..**width**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/textWrap.js#L164)
 
 If *value* is specified, sets width limit to the specified value and returns this generator. If *value* is not specified, returns the current value.
 
@@ -166,9 +166,9 @@ This is a static method of [<code>textWrap</code>](#textWrap)
 ---
 
 <a name="titleCase"></a>
-#### d3plus.**titleCase**(str) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/titleCase.js#L6)
+#### d3plus.**titleCase**(str) [<>](https://github.com/d3plus/d3plus/blob/main/packages/text/src/titleCase.js#L7)
 
-Capitalizes the first letter of each word in a phrase/sentence.
+Capitalizes the first letter of each word in a phrase/sentence, accounting for words in English that should be kept lowercase such as "and" or "of", as well as acronym that should be kept uppercase such as "CEO" or "TVs".
 
 
 This is a global function

package/es/src/textSplit.js

@@ -1,76 +1,15 @@
-import { default as stringify } from "./stringify.js";
-import { default as combiningMarks } from "./combiningMarks.js";
-import { merge } from "d3-array";
-var splitChars = [
-    "-",
-    ";",
-    ":",
-    "&",
-    "|",
-    "u0E2F",
-    "u0EAF",
-    "u0EC6",
-    "u0ECC",
-    "u104A",
-    "u104B",
-    "u104C",
-    "u104D",
-    "u104E",
-    "u104F",
-    "u2013",
-    "u2014",
-    "u2027",
-    "u3000",
-    "u3001",
-    "u3002",
-    "uFF0C",
-    "uFF5E" // wave dash
-];
-var prefixChars = [
-    "'",
-    "<",
-    "(",
-    "{",
-    "[",
-    "u00AB",
-    "u300A",
-    "u3008" // left angle bracket
-];
-var suffixChars = [
-    "'",
-    ">",
-    ")",
-    "}",
-    "]",
-    ".",
-    "!",
-    "?",
-    "/",
-    "u00BB",
-    "u300B",
-    "u3009" // right angle bracket
-].concat(splitChars);
-var burmeseRange = "\u1000-\u102A\u103F-\u1049\u1050-\u1055";
-var japaneseRange = "\u3040-\u309f\u30a0-\u30ff\uff00-\uff0b\uff0d-\uff5d\uff5f-\uff9f\u3400-\u4dbf";
-var chineseRange = "\u3400-\u9FBF";
-var laoRange = "\u0E81-\u0EAE\u0EB0-\u0EC4\u0EC8-\u0ECB\u0ECD-\u0EDD";
-var noSpaceRange = burmeseRange + chineseRange + japaneseRange + laoRange;
-var splitWords = new RegExp("(\\".concat(splitChars.join("|\\"), ")*[^\\s|\\").concat(splitChars.join("|\\"), "]*(\\").concat(splitChars.join("|\\"), ")*"), "g");
-var noSpaceLanguage = new RegExp("[".concat(noSpaceRange, "]"));
-var splitAllChars = new RegExp("(\\".concat(prefixChars.join("|\\"), ")*[").concat(noSpaceRange, "](\\").concat(suffixChars.join("|\\"), "|\\").concat(combiningMarks.join("|\\"), ")*|[a-z0-9]+"), "gi");
+import LineBreaker from "linebreak";
 /**
     @function textSplit
     @desc Splits a given sentence into an array of words.
     @param {String} sentence
 */ export default function(sentence) {
-    if (!noSpaceLanguage.test(sentence)) return stringify(sentence).match(splitWords).filter(function(w) {
-        return w.length;
-    });
-    return merge(stringify(sentence).match(splitWords).map(function(d) {
-        if (noSpaceLanguage.test(d)) return d.match(splitAllChars);
-        return [
-            d
-        ];
-    }));
+    var breaker = new LineBreaker(sentence);
+    var bk, last, words = [];
+    while(bk = breaker.nextBreak()){
+        var word = sentence.slice(last, bk.position);
+        words.push(word);
+        last = bk.position;
+    }
+    return words;
 }
-export { prefixChars, splitChars, splitWords, suffixChars };

package/es/src/textWrap.js

@@ -21,11 +21,11 @@ import { trimRight } from "./trim.js";
             "line-height": lineHeight
         };
         var line = 1, textProg = "", truncated = false, widthProg = 0;
-        var lineData = [], sizes = textWidth(words, style), space = textWidth(" ", style);
+        var lineData = [], sizes = textWidth(words, style);
         for(var i = 0; i < words.length; i++){
             var word = words[i];
             var wordWidth = sizes[words.indexOf(word)];
-            word += sentence.slice(textProg.length + word.length).match("^( |\n)*", "g")[0];
+            // newline if breaking character or not enough width
             if (textProg.slice(-1) === "\n" || widthProg + wordWidth > width) {
                 if (!i && !overflow) {
                     truncated = true;
@@ -43,7 +43,6 @@ import { trimRight } from "./trim.js";
             else lineData[line - 1] += word;
             textProg += word;
             widthProg += wordWidth;
-            widthProg += word.match(/[\s]*$/g)[0].length * space;
         }
         return {
             lines: lineData,

package/es/src/titleCase.js

@@ -1,4 +1,4 @@
-import { suffixChars, default as textSplit } from "./textSplit.js";
+import textSplit from "./textSplit.js";
 var lowercase = [
     "a",
     "an",
@@ -27,7 +27,7 @@ var lowercase = [
     "vs",
     "vs."
 ];
-var uppercase = [
+var acronyms = [
     "CEO",
     "CFO",
     "CNC",
@@ -41,35 +41,22 @@ var uppercase = [
     "TV",
     "UI"
 ];
+var uppercase = acronyms.reduce(function(arr, d) {
+    return arr.push("".concat(d, "s")), arr;
+}, acronyms.map(function(d) {
+    return d.toLowerCase();
+}));
 /**
     @function titleCase
-    @desc Capitalizes the first letter of each word in a phrase/sentence.
+    @desc Capitalizes the first letter of each word in a phrase/sentence, accounting for words in English that should be kept lowercase such as "and" or "of", as well as acronym that should be kept uppercase such as "CEO" or "TVs".
     @param {String} str The string to apply the title case logic.
 */ export default function(str) {
-    if (str === void 0) return "";
-    var smalls = lowercase.map(function(s) {
-        return s.toLowerCase();
-    });
-    var bigs = uppercase.slice();
-    bigs = bigs.concat(bigs.map(function(b) {
-        return "".concat(b, "s");
-    }));
-    var biglow = bigs.map(function(b) {
-        return b.toLowerCase();
-    });
-    var split = textSplit(str);
-    return split.map(function(s, i) {
-        if (s) {
-            var lower = s.toLowerCase();
-            var stripped = suffixChars.includes(lower.charAt(lower.length - 1)) ? lower.slice(0, -1) : lower;
-            var bigindex = biglow.indexOf(stripped);
-            if (bigindex >= 0) return bigs[bigindex];
-            else if (smalls.includes(stripped) && i !== 0 && i !== split.length - 1) return lower;
-            else return s.charAt(0).toUpperCase() + s.substr(1).toLowerCase();
-        } else return "";
-    }).reduce(function(ret, s, i) {
-        if (i && str.charAt(ret.length) === " ") ret += " ";
-        ret += s;
-        return ret;
+    if (str === undefined) return "";
+    return textSplit(str).reduce(function(str, word, i) {
+        var formattedWord = word;
+        var trimmedWord = word.toLowerCase().slice(0, -1);
+        var exempt = uppercase.includes(trimmedWord) || lowercase.includes(trimmedWord) && i !== 0 && word.toLowerCase() !== trimmedWord;
+        if (!exempt) formattedWord = word.charAt(0).toUpperCase() + word.slice(1);
+        return str + formattedWord;
     }, "");
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d3plus/text",
-  "version": "3.0.3",
+  "version": "3.0.4",
   "description": "A smart SVG text box with line wrapping and automatic font size scaling.",
   "license": "MIT",
   "type": "module",
@@ -34,9 +34,9 @@
     "test": "eslint index.js src/**/*.js && eslint --global=it test && mocha 'test/**/*-test.js'"
   },
   "dependencies": {
-    "@d3plus/dom": "3.0.3",
-    "d3-array": "^3.2.4",
+    "@d3plus/dom": "3.0.4",
     "d3-selection": "^3.0.0",
-    "d3-transition": "^3.0.1"
+    "d3-transition": "^3.0.1",
+    "linebreak": "^1.1.0"
   }
 }