@altano/textfit 0.0.1

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Samuel Reed <samuel.trace.reed@gmail.com> (http://strml.net/)
+Copyright (c) 2022 Alan Norbauer <altano@gmail.com> (https://alan.norbauer.com/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,22 @@
+# `textFit` - Hassle-Free Text Fitting
+
+A fork of [STRML/textFit](https://github.com/STRML/textFit) (@7a1eed6db54a97798556eed3c57b2ce1f87dbab4). Has the following changes:
+
+- Convert to ESM module
+- Remove .min.js file
+- Convert to TypeScript (with small code changes to accommodate)
+- Make inputs stricter
+- Adds the following settings to [the defaults](https://github.com/STRML/textFit#default-settings):
+  ```js
+  settings = {
+    ...
+    /**
+     * Sets the final size to the max multiple of this. Useful when a font
+     * requires the font size to be a multiple of a number for optimal rendering.
+     */
+    sizeMultipleOf: 1,
+  };
+  ```
+- Remove the following settings (to simplify the code):
+  - `alignHoriz`
+  - `alignVert`

package/dist/textFit.d.ts

@@ -0,0 +1,46 @@
+/**
+ * textFit v2.3.1
+ * Previously known as jQuery.textFit
+ * 11/2014 by STRML (strml.github.com)
+ * MIT License
+ *
+ * To use: textFit(document.getElementById('target-div'), options);
+ *
+ * Will make the *text* content inside a container scale to fit the container
+ * The container is required to have a set width and height
+ * Uses binary search to fit text with minimal layout calls.
+ * Version 2.0 does not use jQuery.
+ */
+interface Options {
+    /**
+     * if true, textFit will not set white-space: no-wrap
+     */
+    multiLine?: boolean;
+    /**
+     * disable to turn off automatic multi-line sensing
+     */
+    detectMultiLine?: boolean;
+    minFontSize?: number;
+    maxFontSize?: number;
+    /**
+     * if true, textFit will re-process already-fit nodes. Set to 'false' for
+     * better performance
+     */
+    reProcess?: boolean;
+    /**
+     * if true, textFit will fit text to element width, regardless of text height
+     */
+    widthOnly?: boolean;
+    /**
+     * if true, textFit will use flexbox for vertical alignment
+     */
+    alignVertWithFlexbox?: boolean;
+    /**
+     * Sets the final size to the max multiple of this. Useful when a font
+     * requires the font size to be a multiple of a number for optimal rendering.
+     */
+    sizeMultipleOf?: number;
+}
+declare function textFit(elements: HTMLElement | HTMLElement[], options?: Options): void;
+
+export { Options, textFit };

package/dist/textFit.js

@@ -0,0 +1,101 @@
+// src/textFit.ts
+var defaultSettings = {
+  multiLine: false,
+  detectMultiLine: true,
+  minFontSize: 6,
+  maxFontSize: 80,
+  reProcess: true,
+  widthOnly: false,
+  alignVertWithFlexbox: false,
+  sizeMultipleOf: 1
+};
+function textFit(elements, options = {}) {
+  const settings = Object.assign({}, defaultSettings, options);
+  const els = Array.isArray(elements) ? elements : [elements];
+  for (var i = 0; i < els.length; i++) {
+    processItem(els[i], settings);
+  }
+}
+function processItem(el, settings) {
+  if (!isElement(el) || !settings.reProcess && el.getAttribute("textFitted")) {
+    return;
+  }
+  if (!settings.reProcess) {
+    el.setAttribute("textFitted", "1");
+  }
+  let innerSpan, originalHeight, originalHTML, originalWidth;
+  let low, mid, high;
+  originalHTML = el.innerHTML;
+  originalWidth = innerWidth(el);
+  originalHeight = innerHeight(el);
+  if (!originalWidth || !settings.widthOnly && !originalHeight) {
+    if (!settings.widthOnly)
+      throw new Error("Set a static height and width on the target element " + el.outerHTML + " before using textFit!");
+    else
+      throw new Error("Set a static width on the target element " + el.outerHTML + " before using textFit!");
+  }
+  if (originalHTML.indexOf("textFitted") === -1) {
+    innerSpan = document.createElement("span");
+    innerSpan.className = "textFitted";
+    innerSpan.style["display"] = "inline-block";
+    innerSpan.innerHTML = originalHTML;
+    el.innerHTML = "";
+    el.appendChild(innerSpan);
+  } else {
+    const innerSpanNode = el.querySelector("span.textFitted");
+    if (innerSpanNode == null) {
+      throw new Error("Could not find `span.textFitted`");
+    } else if (!(innerSpanNode instanceof HTMLElement)) {
+      throw new Error("Element matching `span.textFitted` not a span");
+    }
+    innerSpan = innerSpanNode;
+    if (hasClass(innerSpan, "textFitAlignVert")) {
+      innerSpan.className = innerSpan.className.replace("textFitAlignVert", "");
+      innerSpan.style["height"] = "";
+      el.className.replace("textFitAlignVertFlex", "");
+    }
+  }
+  var multiLine = settings.multiLine;
+  if (settings.detectMultiLine && !multiLine && innerSpan.getBoundingClientRect().height >= parseInt(window.getComputedStyle(innerSpan).fontSize, 10) * 2) {
+    multiLine = true;
+  }
+  if (!multiLine) {
+    el.style.whiteSpace = "nowrap";
+  }
+  low = settings.minFontSize;
+  high = settings.maxFontSize;
+  var size = low;
+  while (low <= high) {
+    mid = high + low >> 1;
+    innerSpan.style.fontSize = mid + "px";
+    var innerSpanBoundingClientRect = innerSpan.getBoundingClientRect();
+    if (innerSpanBoundingClientRect.width <= originalWidth && (settings.widthOnly || innerSpanBoundingClientRect.height <= originalHeight)) {
+      size = mid;
+      low = mid + 1;
+    } else {
+      high = mid - 1;
+    }
+  }
+  if (settings.sizeMultipleOf > 1) {
+    size = size % settings.sizeMultipleOf;
+  }
+  if (innerSpan.style.fontSize != size + "px")
+    innerSpan.style.fontSize = size + "px";
+}
+function innerHeight(el) {
+  var style = window.getComputedStyle(el, null);
+  return el.getBoundingClientRect().height - parseInt(style.getPropertyValue("padding-top"), 10) - parseInt(style.getPropertyValue("padding-bottom"), 10);
+}
+function innerWidth(el) {
+  var style = window.getComputedStyle(el, null);
+  return el.getBoundingClientRect().width - parseInt(style.getPropertyValue("padding-left"), 10) - parseInt(style.getPropertyValue("padding-right"), 10);
+}
+function isElement(o) {
+  return typeof HTMLElement === "object" ? o instanceof HTMLElement : o && typeof o === "object" && o !== null && o.nodeType === 1 && typeof o.nodeName === "string";
+}
+function hasClass(element, cls) {
+  return (" " + element.className + " ").indexOf(" " + cls + " ") > -1;
+}
+export {
+  textFit
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@altano/textfit",
+  "version": "0.0.1",
+  "description": "A fast, jQuery-free text sizing component that quickly fits single and multi-line text to the width (and optionally height) of its container.",
+  "directories": {
+    "example": "examples"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": "./dist/textFit.js",
+  "types": "./dist/textFit.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsup src/textFit.ts --format esm --dts",
+    "dev": "tsup src/textFit.ts --watch --format esm --dts",
+    "format": "prettier --write src",
+    "build-example": "sh examples/mk-examples.sh",
+    "prepublish": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/altano/npm-packages",
+    "directory": "packages/textFit"
+  },
+  "keywords": [
+    "textfit",
+    "fit",
+    "text"
+  ],
+  "author": "Samuel Reed <samuel.trace.reed@gmail.com> (http://strml.net/)",
+  "contributors": [
+    "Alan Norbauer <altano@gmail.com> (https://alan.norbauer.com/)"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@altano/tsconfig": "*"
+  }
+}