lib/amd/src/truncate.js

   1 // This file is part of Moodle - http://moodle.org/
   2 //
   3 // Moodle is free software: you can redistribute it and/or modify
   4 // it under the terms of the GNU General Public License as published by
   5 // the Free Software Foundation, either version 3 of the License, or
   6 // (at your option) any later version.
   7 //
   8 // Moodle is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 // GNU General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  15
  16 /**
  17  * Module for text truncation.
  18  *
  19  * Implementation provided by Pathable (thanks!).
  20  * See: https://github.com/pathable/truncate
  21  *
  22  * @module     core/truncate
  23  * @package    core
  24  * @class      truncate
  25  * @copyright  2017 Pathable
  26  *             2017 Mathias Bynens
  27  *             2017 Ryan Wyllie <ryan@moodle.com>
  28  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  29  */
  30 define(['jquery'], function($) {
  31
  32   // Matches trailing non-space characters.
  33   var chop = /(\s*\S+|\s)$/;
  34
  35   // Matches the first word in the string.
  36   var start = /^(\S*)/;
  37
  38   // Matches any space characters.
  39   var space = /\s/;
  40
  41   // Special thanks to Mathias Bynens for the multi-byte char
  42   // implementation. Much love.
  43   // see: https://github.com/mathiasbynens/String.prototype.at/blob/master/at.js
  44   var charLengthAt = function(text, position) {
  45     if (this == null) {
  46       throw TypeError();
  47     }
  48     var string = String(text);
  49     var size = string.length;
  50     // `ToInteger`
  51     var index = position ? Number(position) : 0;
  52     if (index != index) { // better `isNaN`
  53       index = 0;
  54     }
  55     // Account for out-of-bounds indices
  56     // The odd lower bound is because the ToInteger operation is
  57     // going to round `n` to `0` for `-1 < n <= 0`.
  58     if (index <= -1 || index >= size) {
  59       return '';
  60     }
  61     // Second half of `ToInteger`
  62     index = index | 0;
  63     // Get the first code unit and code unit value
  64     var cuFirst = string.charCodeAt(index);
  65     var cuSecond;
  66     var nextIndex = index + 1;
  67     var len = 1;
  68     if ( // Check if it’s the start of a surrogate pair.
  69       cuFirst >= 0xD800 && cuFirst <= 0xDBFF && // high surrogate
  70       size > nextIndex // there is a next code unit
  71     ) {
  72       cuSecond = string.charCodeAt(nextIndex);
  73       if (cuSecond >= 0xDC00 && cuSecond <= 0xDFFF) { // low surrogate
  74         len = 2;
  75       }
  76     }
  77     return len;
  78   };
  79
  80   var lengthMultiByte = function(text) {
  81     var count = 0;
  82
  83     for (var i = 0; i < text.length; i += charLengthAt(text, i)) {
  84       count++;
  85     }
  86
  87     return count;
  88   };
  89
  90   var getSliceLength = function(text, amount) {
  91     if (!text.length) {
  92       return 0;
  93     }
  94
  95     var length = 0;
  96     var count = 0;
  97
  98     do {
  99       length += charLengthAt(text, length);
 100       count++;
 101     } while (length < text.length && count < amount);
 102
 103     return length;
 104   };
 105
 106   // Return a truncated html string.  Delegates to $.fn.truncate.
 107   $.truncate = function(html, options) {
 108     return $('<div></div>').append(html).truncate(options).html();
 109   };
 110
 111   // Truncate the contents of an element in place.
 112   $.fn.truncate = function(options) {
 113     if ($.isNumeric(options)) options = {length: options};
 114     var o = $.extend({}, $.truncate.defaults, options);
 115
 116     return this.each(function() {
 117       var self = $(this);
 118
 119       if (o.noBreaks) self.find('br').replaceWith(' ');
 120
 121       var ellipsisLength = o.ellipsis.length;
 122       var text = self.text();
 123       var textLength = lengthMultiByte(text);
 124       var excess = textLength - o.length + ellipsisLength;
 125
 126       if (textLength < o.length) return;
 127       if (o.stripTags) self.text(text);
 128
 129       // Chop off any partial words if appropriate.
 130       if (o.words && excess > 0) {
 131         var sliced = text.slice(0, getSliceLength(text, o.length - ellipsisLength) + 1);
 132         var replaced = sliced.replace(chop, '');
 133         var truncated = lengthMultiByte(replaced);
 134         var oneWord = sliced.match(space) ? false : true;
 135
 136         if (o.keepFirstWord && truncated === 0) {
 137           excess = textLength - lengthMultiByte(start.exec(text)[0]) - ellipsisLength;
 138         } else if (oneWord && truncated === 0) {
 139           excess = textLength - o.length + ellipsisLength;
 140         } else {
 141           excess = textLength - truncated - 1;
 142         }
 143       }
 144
 145       // The requested length is larger than the text. No need for ellipsis.
 146       if (excess > textLength) {
 147         excess = textLength - o.length;
 148       }
 149
 150       if (excess < 0 || !excess && !o.truncated) return;
 151
 152       // Iterate over each child node in reverse, removing excess text.
 153       $.each(self.contents().get().reverse(), function(i, el) {
 154         var $el = $(el);
 155         var text = $el.text();
 156         var length = lengthMultiByte(text);
 157
 158         // If the text is longer than the excess, remove the node and continue.
 159         if (length <= excess) {
 160           o.truncated = true;
 161           excess -= length;
 162           $el.remove();
 163           return;
 164         }
 165
 166         // Remove the excess text and append the ellipsis.
 167         if (el.nodeType === 3) {
 168           var splitAmount = length - excess;
 169           splitAmount = splitAmount >= 0 ? getSliceLength(text, splitAmount) : 0;
 170           $(el.splitText(splitAmount)).replaceWith(o.ellipsis);
 171           return false;
 172         }
 173
 174         // Recursively truncate child nodes.
 175         $el.truncate($.extend(o, {length: length - excess + ellipsisLength}));
 176         return false;
 177       });
 178     });
 179   };
 180
 181   $.truncate.defaults = {
 182
 183     // Strip all html elements, leaving only plain text.
 184     stripTags: false,
 185
 186     // Only truncate at word boundaries.
 187     words: false,
 188
 189     // When 'words' is active, keeps the first word in the string
 190     // even if it's longer than a target length.
 191     keepFirstWord: false,
 192
 193     // Replace instances of <br> with a single space.
 194     noBreaks: false,
 195
 196     // The maximum length of the truncated html.
 197     length: Infinity,
 198
 199     // The character to use as the ellipsis.  The word joiner (U+2060) can be
 200     // used to prevent a hanging ellipsis, but displays incorrectly in Chrome
 201     // on Windows 7.
 202     // http://code.google.com/p/chromium/issues/detail?id=68323
 203     //ellipsis: '\u2026' // '\u2060\u2026'
 204     ellipsis: '\u2026' // '\u2060\u2026'
 205
 206   };
 207
 208     return {
 209         truncate: $.truncate,
 210     };
 211 });