text-slicer 0.0.1-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ux-ui.pro
+
+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,81 @@
+<br>
+<p align="center"><strong>text-slicer</strong></p>
+
+<div align="center">
+
+[![npm](https://img.shields.io/npm/v/text-slicer.svg?colorB=brightgreen)](https://www.npmjs.com/package/text-slicer)
+[![GitHub package version](https://img.shields.io/github/package-json/v/ux-ui-pro/text-slicer.svg)](https://github.com/ux-ui-pro/text-slicer)
+[![NPM Downloads](https://img.shields.io/npm/dm/text-slicer.svg?style=flat)](https://www.npmjs.org/package/text-slicer)
+
+</div>
+
+<p align="center">TextSlicer is designed to split text within an HTML element into separate words and/or characters, wrapping each word and/or character in separate span elements.</p>
+<p align="center"><sup>1kB gzipped</sup></p>
+<p align="center"><a href="https://codepen.io/ux-ui/pen/vYMoGoG">Demo</a></p>
+<br>
+
+&#10148; **Install**
+
+```console
+yarn add text-slicer
+```
+<br>
+
+&#10148; **Import**
+
+```javascript
+import TextSlicer from 'text-slicer';
+```
+<br>
+
+&#10148; **Usage**
+
+```javascript
+const textSlicer = new TextSlicer();
+
+textSlicer.init();
+```
+<br>
+Initialization with specified parameters
+<br>
+
+```javascript
+document.addEventListener('DOMContentLoaded', () => {
+  const textSlicer = new TextSlicer({
+    container: '.text-slicer',
+    mode: 'both',
+    cssVariables: true,
+  });
+
+  textSlicer.init();
+});
+```
+<br>
+How to apply the TextSlicer class to all elements on a page
+<br>
+
+```javascript
+document.addEventListener('DOMContentLoaded', () => {
+  document.querySelectorAll('.text-slicer').forEach((element) => {
+    const textSlicer = new TextSlicer({
+      container: element,
+    });
+
+    textSlicer.init();
+  });
+});
+```
+<br>
+
+&#10148; **Parameters**
+
+|     Option     |          Type           |    Default     | Description                                                                                                      |
+|:--------------:|:-----------------------:|:--------------:|:-----------------------------------------------------------------------------------------------------------------|
+|  `container`   | `HTMLElement \| string` | `.text-slicer` | The element or selector of the element containing the text to be split.                                          |
+|     `mode`     |        `string`         |     `both`     | Text split mode: 'words' to split into words, 'chars' to split into characters, 'both' to split into both types. |
+| `cssVariables` |        `boolean`        |    `false`     | A logical value indicating whether to add CSS variables for word and character indexes.                          |
+<br>
+
+&#10148; **License**
+
+text-slicer is released under MIT license

package/code_of_conduct.md

@@ -0,0 +1,37 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, ethnicity, level of experience, nationality, personal appearance, race, or religion.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+
+Examples of unacceptable behavior by participants include:
+
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

package/dist/index.js

@@ -0,0 +1,98 @@
+
+function $parcel$defineInteropFlag(a) {
+  Object.defineProperty(a, '__esModule', {value: true, configurable: true});
+}
+
+function $parcel$export(e, n, v, s) {
+  Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
+}
+
+$parcel$defineInteropFlag(module.exports);
+
+$parcel$export(module.exports, "default", function () { return $70cf2c47938f006f$export$2e2bcd8739ae039; });
+class $70cf2c47938f006f$var$TextSlicer {
+    #textElement;
+    #originalText;
+    #splitMode;
+    #cssVariables;
+    #charIndexCounter;
+    /**
+   * @param {Object} options - Configuration options for the TextSlicer.
+   * @param {HTMLElement|string} [options.container] - The container element or a selector for the text to split.
+   * @param {string} [options.mode='both'] - The split mode, can be 'words', 'chars', or 'both'.
+   * @param {boolean} [options.cssVariables=false] - Whether to use CSS variables for indices.
+   */ constructor(options = {}){
+        this.#textElement = options.container instanceof HTMLElement ? options.container : document.querySelector(options.container || ".text-splitter");
+        if (!this.#textElement) return;
+        this.#originalText = this.#textElement.textContent.trim();
+        this.#splitMode = options.mode || "both";
+        this.#cssVariables = options.cssVariables || false;
+        this.#charIndexCounter = 1;
+    }
+    split() {
+        if (!this.#textElement) return;
+        this.#clear();
+        this.#charIndexCounter = 1;
+        const fragment = document.createDocumentFragment();
+        if (this.#splitMode === "words" || this.#splitMode === "both") this.#splitWords(fragment);
+        else if (this.#splitMode === "chars") this.#splitChars(fragment);
+        this.#textElement.appendChild(fragment);
+    }
+    #splitWords(fragment) {
+        const words = this.#originalText.split(" ");
+        words.forEach((word, wordIndex)=>{
+            if (this.#splitMode === "both") {
+                const wordSpan = this.#createWordSpan(wordIndex + 1);
+                word.split("").forEach((char)=>{
+                    const charSpan = this.#createCharSpan(char);
+                    wordSpan.append(charSpan);
+                });
+                fragment.append(wordSpan);
+            } else {
+                const wordSpan = this.#createWordSpan(wordIndex + 1, word);
+                fragment.append(wordSpan);
+            }
+            if (wordIndex < words.length - 1) fragment.append($70cf2c47938f006f$var$TextSlicer.#createSpaceSpan());
+        });
+    }
+    #splitChars(fragment) {
+        this.#originalText.split("").forEach((char)=>{
+            const charSpan = this.#createCharSpan(char);
+            fragment.append(charSpan);
+        });
+    }
+    #createWordSpan(index, textContent = "") {
+        const wordSpan = document.createElement("span");
+        wordSpan.classList.add("word");
+        wordSpan.textContent = textContent;
+        if (this.#cssVariables) wordSpan.style.setProperty("--word-index", index);
+        return wordSpan;
+    }
+    #createCharSpan(char) {
+        const charSpan = document.createElement("span");
+        charSpan.textContent = char;
+        if (char === " ") charSpan.classList.add("whitespace");
+        else {
+            charSpan.classList.add("char");
+            if (this.#cssVariables) charSpan.style.setProperty("--char-index", this.#charIndexCounter);
+            this.#charIndexCounter += 1;
+        }
+        return charSpan;
+    }
+    static #createSpaceSpan() {
+        const spaceSpan = document.createElement("span");
+        spaceSpan.classList.add("whitespace");
+        spaceSpan.textContent = " ";
+        return spaceSpan;
+    }
+    #clear() {
+        this.#textElement.innerHTML = "";
+    }
+    init() {
+        this.split();
+    }
+}
+var $70cf2c47938f006f$export$2e2bcd8739ae039 = $70cf2c47938f006f$var$TextSlicer;
+
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;;;;;;;AAAA,MAAM;IACJ,CAAC,WAAW,CAAC;IAEb,CAAC,YAAY,CAAC;IAEd,CAAC,SAAS,CAAC;IAEX,CAAC,YAAY,CAAC;IAEd,CAAC,gBAAgB,CAAC;IAElB;;;;;GAKC,GAED,YAAY,UAAU,CAAC,CAAC,CAAE;QACxB,IAAI,CAAC,CAAC,WAAW,GAAG,QAAQ,SAAS,YAAY,cAC7C,QAAQ,SAAS,GACjB,SAAS,aAAa,CAAC,QAAQ,SAAS,IAAI;QAEhD,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EACpB;QAGF,IAAI,CAAC,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI;QACvD,IAAI,CAAC,CAAC,SAAS,GAAG,QAAQ,IAAI,IAAI;QAClC,IAAI,CAAC,CAAC,YAAY,GAAG,QAAQ,YAAY,IAAI;QAC7C,IAAI,CAAC,CAAC,gBAAgB,GAAG;IAC3B;IAEA,QAAQ;QACN,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE;QAExB,IAAI,CAAC,CAAC,KAAK;QACX,IAAI,CAAC,CAAC,gBAAgB,GAAG;QAEzB,MAAM,WAAW,SAAS,sBAAsB;QAEhD,IAAI,IAAI,CAAC,CAAC,SAAS,KAAK,WAAW,IAAI,CAAC,CAAC,SAAS,KAAK,QACrD,IAAI,CAAC,CAAC,UAAU,CAAC;aACZ,IAAI,IAAI,CAAC,CAAC,SAAS,KAAK,SAC7B,IAAI,CAAC,CAAC,UAAU,CAAC;QAGnB,IAAI,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC;IAChC;IAEA,CAAC,UAAU,CAAC,QAAQ;QAClB,MAAM,QAAQ,IAAI,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC;QAEvC,MAAM,OAAO,CAAC,CAAC,MAAM;YACnB,IAAI,IAAI,CAAC,CAAC,SAAS,KAAK,QAAQ;gBAC9B,MAAM,WAAW,IAAI,CAAC,CAAC,cAAc,CAAC,YAAY;gBAElD,KAAK,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC;oBACtB,MAAM,WAAW,IAAI,CAAC,CAAC,cAAc,CAAC;oBAEtC,SAAS,MAAM,CAAC;gBAClB;gBAEA,SAAS,MAAM,CAAC;YAClB,OAAO;gBACL,MAAM,WAAW,IAAI,CAAC,CAAC,cAAc,CAAC,YAAY,GAAG;gBAErD,SAAS,MAAM,CAAC;YAClB;YAEA,IAAI,YAAY,MAAM,MAAM,GAAG,GAC7B,SAAS,MAAM,CAAC,iCAAW,CAAC,eAAe;QAE/C;IACF;IAEA,CAAC,UAAU,CAAC,QAAQ;QAClB,IAAI,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC;YACpC,MAAM,WAAW,IAAI,CAAC,CAAC,cAAc,CAAC;YAEtC,SAAS,MAAM,CAAC;QAClB;IACF;IAEA,CAAC,cAAc,CAAC,KAAK,EAAE,cAAc,EAAE;QACrC,MAAM,WAAW,SAAS,aAAa,CAAC;QAExC,SAAS,SAAS,CAAC,GAAG,CAAC;QACvB,SAAS,WAAW,GAAG;QAEvB,IAAI,IAAI,CAAC,CAAC,YAAY,EACpB,SAAS,KAAK,CAAC,WAAW,CAAC,gBAAgB;QAG7C,OAAO;IACT;IAEA,CAAC,cAAc,CAAC,IAAI;QAClB,MAAM,WAAW,SAAS,aAAa,CAAC;QAExC,SAAS,WAAW,GAAG;QAEvB,IAAI,SAAS,KACX,SAAS,SAAS,CAAC,GAAG,CAAC;aAClB;YACL,SAAS,SAAS,CAAC,GAAG,CAAC;YAEvB,IAAI,IAAI,CAAC,CAAC,YAAY,EACpB,SAAS,KAAK,CAAC,WAAW,CAAC,gBAAgB,IAAI,CAAC,CAAC,gBAAgB;YAGnE,IAAI,CAAC,CAAC,gBAAgB,IAAI;QAC5B;QAEA,OAAO;IACT;IAEA,OAAO,CAAC,eAAe;QACrB,MAAM,YAAY,SAAS,aAAa,CAAC;QAEzC,UAAU,SAAS,CAAC,GAAG,CAAC;QACxB,UAAU,WAAW,GAAG;QAExB,OAAO;IACT;IAEA,CAAC,KAAK;QACJ,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,GAAG;IAChC;IAEA,OAAO;QACL,IAAI,CAAC,KAAK;IACZ;AACF;IAEA,2CAAe","sources":["src/TextSlicer.js"],"sourcesContent":["class TextSlicer {\n  #textElement;\n\n  #originalText;\n\n  #splitMode;\n\n  #cssVariables;\n\n  #charIndexCounter;\n\n  /**\n   * @param {Object} options - Configuration options for the TextSlicer.\n   * @param {HTMLElement|string} [options.container] - The container element or a selector for the text to split.\n   * @param {string} [options.mode='both'] - The split mode, can be 'words', 'chars', or 'both'.\n   * @param {boolean} [options.cssVariables=false] - Whether to use CSS variables for indices.\n   */\n\n  constructor(options = {}) {\n    this.#textElement = options.container instanceof HTMLElement\n      ? options.container\n      : document.querySelector(options.container || '.text-splitter');\n\n    if (!this.#textElement) {\n      return;\n    }\n\n    this.#originalText = this.#textElement.textContent.trim();\n    this.#splitMode = options.mode || 'both';\n    this.#cssVariables = options.cssVariables || false;\n    this.#charIndexCounter = 1;\n  }\n\n  split() {\n    if (!this.#textElement) return;\n\n    this.#clear();\n    this.#charIndexCounter = 1;\n\n    const fragment = document.createDocumentFragment();\n\n    if (this.#splitMode === 'words' || this.#splitMode === 'both') {\n      this.#splitWords(fragment);\n    } else if (this.#splitMode === 'chars') {\n      this.#splitChars(fragment);\n    }\n\n    this.#textElement.appendChild(fragment);\n  }\n\n  #splitWords(fragment) {\n    const words = this.#originalText.split(' ');\n\n    words.forEach((word, wordIndex) => {\n      if (this.#splitMode === 'both') {\n        const wordSpan = this.#createWordSpan(wordIndex + 1);\n\n        word.split('').forEach((char) => {\n          const charSpan = this.#createCharSpan(char);\n\n          wordSpan.append(charSpan);\n        });\n\n        fragment.append(wordSpan);\n      } else {\n        const wordSpan = this.#createWordSpan(wordIndex + 1, word);\n\n        fragment.append(wordSpan);\n      }\n\n      if (wordIndex < words.length - 1) {\n        fragment.append(TextSlicer.#createSpaceSpan());\n      }\n    });\n  }\n\n  #splitChars(fragment) {\n    this.#originalText.split('').forEach((char) => {\n      const charSpan = this.#createCharSpan(char);\n\n      fragment.append(charSpan);\n    });\n  }\n\n  #createWordSpan(index, textContent = '') {\n    const wordSpan = document.createElement('span');\n\n    wordSpan.classList.add('word');\n    wordSpan.textContent = textContent;\n\n    if (this.#cssVariables) {\n      wordSpan.style.setProperty('--word-index', index);\n    }\n\n    return wordSpan;\n  }\n\n  #createCharSpan(char) {\n    const charSpan = document.createElement('span');\n\n    charSpan.textContent = char;\n\n    if (char === ' ') {\n      charSpan.classList.add('whitespace');\n    } else {\n      charSpan.classList.add('char');\n\n      if (this.#cssVariables) {\n        charSpan.style.setProperty('--char-index', this.#charIndexCounter);\n      }\n\n      this.#charIndexCounter += 1;\n    }\n\n    return charSpan;\n  }\n\n  static #createSpaceSpan() {\n    const spaceSpan = document.createElement('span');\n\n    spaceSpan.classList.add('whitespace');\n    spaceSpan.textContent = ' ';\n\n    return spaceSpan;\n  }\n\n  #clear() {\n    this.#textElement.innerHTML = '';\n  }\n\n  init() {\n    this.split();\n  }\n}\n\nexport default TextSlicer;\n"],"names":[],"version":3,"file":"index.js.map"}

package/dist/index.module.js

@@ -0,0 +1,87 @@
+class $fe8af0fdf983f603$var$TextSlicer {
+    #textElement;
+    #originalText;
+    #splitMode;
+    #cssVariables;
+    #charIndexCounter;
+    /**
+   * @param {Object} options - Configuration options for the TextSlicer.
+   * @param {HTMLElement|string} [options.container] - The container element or a selector for the text to split.
+   * @param {string} [options.mode='both'] - The split mode, can be 'words', 'chars', or 'both'.
+   * @param {boolean} [options.cssVariables=false] - Whether to use CSS variables for indices.
+   */ constructor(options = {}){
+        this.#textElement = options.container instanceof HTMLElement ? options.container : document.querySelector(options.container || ".text-splitter");
+        if (!this.#textElement) return;
+        this.#originalText = this.#textElement.textContent.trim();
+        this.#splitMode = options.mode || "both";
+        this.#cssVariables = options.cssVariables || false;
+        this.#charIndexCounter = 1;
+    }
+    split() {
+        if (!this.#textElement) return;
+        this.#clear();
+        this.#charIndexCounter = 1;
+        const fragment = document.createDocumentFragment();
+        if (this.#splitMode === "words" || this.#splitMode === "both") this.#splitWords(fragment);
+        else if (this.#splitMode === "chars") this.#splitChars(fragment);
+        this.#textElement.appendChild(fragment);
+    }
+    #splitWords(fragment) {
+        const words = this.#originalText.split(" ");
+        words.forEach((word, wordIndex)=>{
+            if (this.#splitMode === "both") {
+                const wordSpan = this.#createWordSpan(wordIndex + 1);
+                word.split("").forEach((char)=>{
+                    const charSpan = this.#createCharSpan(char);
+                    wordSpan.append(charSpan);
+                });
+                fragment.append(wordSpan);
+            } else {
+                const wordSpan = this.#createWordSpan(wordIndex + 1, word);
+                fragment.append(wordSpan);
+            }
+            if (wordIndex < words.length - 1) fragment.append($fe8af0fdf983f603$var$TextSlicer.#createSpaceSpan());
+        });
+    }
+    #splitChars(fragment) {
+        this.#originalText.split("").forEach((char)=>{
+            const charSpan = this.#createCharSpan(char);
+            fragment.append(charSpan);
+        });
+    }
+    #createWordSpan(index, textContent = "") {
+        const wordSpan = document.createElement("span");
+        wordSpan.classList.add("word");
+        wordSpan.textContent = textContent;
+        if (this.#cssVariables) wordSpan.style.setProperty("--word-index", index);
+        return wordSpan;
+    }
+    #createCharSpan(char) {
+        const charSpan = document.createElement("span");
+        charSpan.textContent = char;
+        if (char === " ") charSpan.classList.add("whitespace");
+        else {
+            charSpan.classList.add("char");
+            if (this.#cssVariables) charSpan.style.setProperty("--char-index", this.#charIndexCounter);
+            this.#charIndexCounter += 1;
+        }
+        return charSpan;
+    }
+    static #createSpaceSpan() {
+        const spaceSpan = document.createElement("span");
+        spaceSpan.classList.add("whitespace");
+        spaceSpan.textContent = " ";
+        return spaceSpan;
+    }
+    #clear() {
+        this.#textElement.innerHTML = "";
+    }
+    init() {
+        this.split();
+    }
+}
+var $fe8af0fdf983f603$export$2e2bcd8739ae039 = $fe8af0fdf983f603$var$TextSlicer;
+
+
+export {$fe8af0fdf983f603$export$2e2bcd8739ae039 as default};
+//# sourceMappingURL=index.module.js.map

package/dist/index.module.js.map

@@ -0,0 +1 @@
+{"mappings":"AAAA,MAAM;IACJ,CAAC,WAAW,CAAC;IAEb,CAAC,YAAY,CAAC;IAEd,CAAC,SAAS,CAAC;IAEX,CAAC,YAAY,CAAC;IAEd,CAAC,gBAAgB,CAAC;IAElB;;;;;GAKC,GAED,YAAY,UAAU,CAAC,CAAC,CAAE;QACxB,IAAI,CAAC,CAAC,WAAW,GAAG,QAAQ,SAAS,YAAY,cAC7C,QAAQ,SAAS,GACjB,SAAS,aAAa,CAAC,QAAQ,SAAS,IAAI;QAEhD,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EACpB;QAGF,IAAI,CAAC,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI;QACvD,IAAI,CAAC,CAAC,SAAS,GAAG,QAAQ,IAAI,IAAI;QAClC,IAAI,CAAC,CAAC,YAAY,GAAG,QAAQ,YAAY,IAAI;QAC7C,IAAI,CAAC,CAAC,gBAAgB,GAAG;IAC3B;IAEA,QAAQ;QACN,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE;QAExB,IAAI,CAAC,CAAC,KAAK;QACX,IAAI,CAAC,CAAC,gBAAgB,GAAG;QAEzB,MAAM,WAAW,SAAS,sBAAsB;QAEhD,IAAI,IAAI,CAAC,CAAC,SAAS,KAAK,WAAW,IAAI,CAAC,CAAC,SAAS,KAAK,QACrD,IAAI,CAAC,CAAC,UAAU,CAAC;aACZ,IAAI,IAAI,CAAC,CAAC,SAAS,KAAK,SAC7B,IAAI,CAAC,CAAC,UAAU,CAAC;QAGnB,IAAI,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC;IAChC;IAEA,CAAC,UAAU,CAAC,QAAQ;QAClB,MAAM,QAAQ,IAAI,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC;QAEvC,MAAM,OAAO,CAAC,CAAC,MAAM;YACnB,IAAI,IAAI,CAAC,CAAC,SAAS,KAAK,QAAQ;gBAC9B,MAAM,WAAW,IAAI,CAAC,CAAC,cAAc,CAAC,YAAY;gBAElD,KAAK,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC;oBACtB,MAAM,WAAW,IAAI,CAAC,CAAC,cAAc,CAAC;oBAEtC,SAAS,MAAM,CAAC;gBAClB;gBAEA,SAAS,MAAM,CAAC;YAClB,OAAO;gBACL,MAAM,WAAW,IAAI,CAAC,CAAC,cAAc,CAAC,YAAY,GAAG;gBAErD,SAAS,MAAM,CAAC;YAClB;YAEA,IAAI,YAAY,MAAM,MAAM,GAAG,GAC7B,SAAS,MAAM,CAAC,iCAAW,CAAC,eAAe;QAE/C;IACF;IAEA,CAAC,UAAU,CAAC,QAAQ;QAClB,IAAI,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC;YACpC,MAAM,WAAW,IAAI,CAAC,CAAC,cAAc,CAAC;YAEtC,SAAS,MAAM,CAAC;QAClB;IACF;IAEA,CAAC,cAAc,CAAC,KAAK,EAAE,cAAc,EAAE;QACrC,MAAM,WAAW,SAAS,aAAa,CAAC;QAExC,SAAS,SAAS,CAAC,GAAG,CAAC;QACvB,SAAS,WAAW,GAAG;QAEvB,IAAI,IAAI,CAAC,CAAC,YAAY,EACpB,SAAS,KAAK,CAAC,WAAW,CAAC,gBAAgB;QAG7C,OAAO;IACT;IAEA,CAAC,cAAc,CAAC,IAAI;QAClB,MAAM,WAAW,SAAS,aAAa,CAAC;QAExC,SAAS,WAAW,GAAG;QAEvB,IAAI,SAAS,KACX,SAAS,SAAS,CAAC,GAAG,CAAC;aAClB;YACL,SAAS,SAAS,CAAC,GAAG,CAAC;YAEvB,IAAI,IAAI,CAAC,CAAC,YAAY,EACpB,SAAS,KAAK,CAAC,WAAW,CAAC,gBAAgB,IAAI,CAAC,CAAC,gBAAgB;YAGnE,IAAI,CAAC,CAAC,gBAAgB,IAAI;QAC5B;QAEA,OAAO;IACT;IAEA,OAAO,CAAC,eAAe;QACrB,MAAM,YAAY,SAAS,aAAa,CAAC;QAEzC,UAAU,SAAS,CAAC,GAAG,CAAC;QACxB,UAAU,WAAW,GAAG;QAExB,OAAO;IACT;IAEA,CAAC,KAAK;QACJ,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,GAAG;IAChC;IAEA,OAAO;QACL,IAAI,CAAC,KAAK;IACZ;AACF;IAEA,2CAAe","sources":["src/TextSlicer.js"],"sourcesContent":["class TextSlicer {\n  #textElement;\n\n  #originalText;\n\n  #splitMode;\n\n  #cssVariables;\n\n  #charIndexCounter;\n\n  /**\n   * @param {Object} options - Configuration options for the TextSlicer.\n   * @param {HTMLElement|string} [options.container] - The container element or a selector for the text to split.\n   * @param {string} [options.mode='both'] - The split mode, can be 'words', 'chars', or 'both'.\n   * @param {boolean} [options.cssVariables=false] - Whether to use CSS variables for indices.\n   */\n\n  constructor(options = {}) {\n    this.#textElement = options.container instanceof HTMLElement\n      ? options.container\n      : document.querySelector(options.container || '.text-splitter');\n\n    if (!this.#textElement) {\n      return;\n    }\n\n    this.#originalText = this.#textElement.textContent.trim();\n    this.#splitMode = options.mode || 'both';\n    this.#cssVariables = options.cssVariables || false;\n    this.#charIndexCounter = 1;\n  }\n\n  split() {\n    if (!this.#textElement) return;\n\n    this.#clear();\n    this.#charIndexCounter = 1;\n\n    const fragment = document.createDocumentFragment();\n\n    if (this.#splitMode === 'words' || this.#splitMode === 'both') {\n      this.#splitWords(fragment);\n    } else if (this.#splitMode === 'chars') {\n      this.#splitChars(fragment);\n    }\n\n    this.#textElement.appendChild(fragment);\n  }\n\n  #splitWords(fragment) {\n    const words = this.#originalText.split(' ');\n\n    words.forEach((word, wordIndex) => {\n      if (this.#splitMode === 'both') {\n        const wordSpan = this.#createWordSpan(wordIndex + 1);\n\n        word.split('').forEach((char) => {\n          const charSpan = this.#createCharSpan(char);\n\n          wordSpan.append(charSpan);\n        });\n\n        fragment.append(wordSpan);\n      } else {\n        const wordSpan = this.#createWordSpan(wordIndex + 1, word);\n\n        fragment.append(wordSpan);\n      }\n\n      if (wordIndex < words.length - 1) {\n        fragment.append(TextSlicer.#createSpaceSpan());\n      }\n    });\n  }\n\n  #splitChars(fragment) {\n    this.#originalText.split('').forEach((char) => {\n      const charSpan = this.#createCharSpan(char);\n\n      fragment.append(charSpan);\n    });\n  }\n\n  #createWordSpan(index, textContent = '') {\n    const wordSpan = document.createElement('span');\n\n    wordSpan.classList.add('word');\n    wordSpan.textContent = textContent;\n\n    if (this.#cssVariables) {\n      wordSpan.style.setProperty('--word-index', index);\n    }\n\n    return wordSpan;\n  }\n\n  #createCharSpan(char) {\n    const charSpan = document.createElement('span');\n\n    charSpan.textContent = char;\n\n    if (char === ' ') {\n      charSpan.classList.add('whitespace');\n    } else {\n      charSpan.classList.add('char');\n\n      if (this.#cssVariables) {\n        charSpan.style.setProperty('--char-index', this.#charIndexCounter);\n      }\n\n      this.#charIndexCounter += 1;\n    }\n\n    return charSpan;\n  }\n\n  static #createSpaceSpan() {\n    const spaceSpan = document.createElement('span');\n\n    spaceSpan.classList.add('whitespace');\n    spaceSpan.textContent = ' ';\n\n    return spaceSpan;\n  }\n\n  #clear() {\n    this.#textElement.innerHTML = '';\n  }\n\n  init() {\n    this.split();\n  }\n}\n\nexport default TextSlicer;\n"],"names":[],"version":3,"file":"index.module.js.map"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "text-slicer",
+  "version": "0.0.1-alpha.1",
+  "description": "TextSlicer is designed to split text within an HTML element into separate words and/or characters, wrapping each word and/or character in separate span elements.",
+  "author": "ux-ui.pro",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ux-ui-pro/text-slicer.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ux-ui-pro/text-slicer/issues"
+  },
+  "homepage": "https://github.com/ux-ui-pro/text-slicer",
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "dist/index.module.js",
+  "targets": {
+    "main": {
+      "source": "src/TextSlicer.js"
+    },
+    "module": {
+      "source": "src/TextSlicer.js"
+    }
+  },
+  "browserslist": "> 0.5%, last 2 versions, not dead",
+  "scripts": {
+    "clean": "rm -rf dist .parcel-cache",
+    "build": "yarn clean && parcel build",
+    "lint:js": "eslint --ext .js",
+    "lintfix": "yarn lint:js --fix"
+  },
+  "devDependencies": {
+    "eslint": "^7.32.0 || ^8.57.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "parcel": "^2.12.0"
+  },
+  "keywords": [
+    "text",
+    "splitter",
+    "splitting",
+    "DOM",
+    "manipulation",
+    "animation",
+    "JavaScript",
+    "effects",
+    "fragment",
+    "words",
+    "characters",
+    "HTML",
+    "processing",
+    "CSS",
+    "variables",
+    "web",
+    "development",
+    "transformation",
+    "customization",
+    "frontend",
+    "element",
+    "library",
+    "content",
+    "custom",
+    "effects",
+    "textslicer",
+    "textmanipulation",
+    "js",
+    "webdev",
+    "textprocessing"
+  ]
+}

package/src/TextSlicer.js

@@ -0,0 +1,136 @@
+class TextSlicer {
+  #textElement;
+
+  #originalText;
+
+  #splitMode;
+
+  #cssVariables;
+
+  #charIndexCounter;
+
+  /**
+   * @param {Object} options - Configuration options for the TextSlicer.
+   * @param {HTMLElement|string} [options.container] - The container element or a selector for the text to split.
+   * @param {string} [options.mode='both'] - The split mode, can be 'words', 'chars', or 'both'.
+   * @param {boolean} [options.cssVariables=false] - Whether to use CSS variables for indices.
+   */
+
+  constructor(options = {}) {
+    this.#textElement = options.container instanceof HTMLElement
+      ? options.container
+      : document.querySelector(options.container || '.text-splitter');
+
+    if (!this.#textElement) {
+      return;
+    }
+
+    this.#originalText = this.#textElement.textContent.trim();
+    this.#splitMode = options.mode || 'both';
+    this.#cssVariables = options.cssVariables || false;
+    this.#charIndexCounter = 1;
+  }
+
+  split() {
+    if (!this.#textElement) return;
+
+    this.#clear();
+    this.#charIndexCounter = 1;
+
+    const fragment = document.createDocumentFragment();
+
+    if (this.#splitMode === 'words' || this.#splitMode === 'both') {
+      this.#splitWords(fragment);
+    } else if (this.#splitMode === 'chars') {
+      this.#splitChars(fragment);
+    }
+
+    this.#textElement.appendChild(fragment);
+  }
+
+  #splitWords(fragment) {
+    const words = this.#originalText.split(' ');
+
+    words.forEach((word, wordIndex) => {
+      if (this.#splitMode === 'both') {
+        const wordSpan = this.#createWordSpan(wordIndex + 1);
+
+        word.split('').forEach((char) => {
+          const charSpan = this.#createCharSpan(char);
+
+          wordSpan.append(charSpan);
+        });
+
+        fragment.append(wordSpan);
+      } else {
+        const wordSpan = this.#createWordSpan(wordIndex + 1, word);
+
+        fragment.append(wordSpan);
+      }
+
+      if (wordIndex < words.length - 1) {
+        fragment.append(TextSlicer.#createSpaceSpan());
+      }
+    });
+  }
+
+  #splitChars(fragment) {
+    this.#originalText.split('').forEach((char) => {
+      const charSpan = this.#createCharSpan(char);
+
+      fragment.append(charSpan);
+    });
+  }
+
+  #createWordSpan(index, textContent = '') {
+    const wordSpan = document.createElement('span');
+
+    wordSpan.classList.add('word');
+    wordSpan.textContent = textContent;
+
+    if (this.#cssVariables) {
+      wordSpan.style.setProperty('--word-index', index);
+    }
+
+    return wordSpan;
+  }
+
+  #createCharSpan(char) {
+    const charSpan = document.createElement('span');
+
+    charSpan.textContent = char;
+
+    if (char === ' ') {
+      charSpan.classList.add('whitespace');
+    } else {
+      charSpan.classList.add('char');
+
+      if (this.#cssVariables) {
+        charSpan.style.setProperty('--char-index', this.#charIndexCounter);
+      }
+
+      this.#charIndexCounter += 1;
+    }
+
+    return charSpan;
+  }
+
+  static #createSpaceSpan() {
+    const spaceSpan = document.createElement('span');
+
+    spaceSpan.classList.add('whitespace');
+    spaceSpan.textContent = ' ';
+
+    return spaceSpan;
+  }
+
+  #clear() {
+    this.#textElement.innerHTML = '';
+  }
+
+  init() {
+    this.split();
+  }
+}
+
+export default TextSlicer;