npm - input2tags - Versions diffs - 3.0.1 - Mend

input2tags 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/LICENSE +22 -0
package/README.md +204 -0
package/dist/input2tags.esm.min.js +1 -0
package/dist/input2tags.min.css +1 -0
package/dist/input2tags.min.js +1 -0
package/package.json +54 -0

package/LICENSE ADDED Viewed

@@ -0,0 +1,22 @@
+MIT License
+Copyright (c) 2024 Filipe Laborde-Basto
+Copyright (c) 2022 Raihan Kabir
+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 ADDED Viewed

@@ -0,0 +1,204 @@
+# input-tags
+## Version 2.01
+**Check the CodePen.io [basic example](https://codepen.io/mindflowgo/pen/PwYNQVe); [autocomplete example](https://codepen.io/mindflowgo/pen/MYgyVgg).**
+*Project objective: simple but powerful vanilla ES6 javascript (code: 350 lines) input tag generator for any input fields; with auto-completion lists.*
+Based off the inspiration work of [github.com/rk4bir/simple-tags-input](https://github.com/rk4bir/simple-tags-input); using his idea and CSS but then rewritten for ES6 and more features. Can record special keys (Meta, Alt, Tab, MouseLeft, VolumeUp, etc) as key presses.
+This project is mobile-friendly: but you may want to prevent scrolling of screen depending on your needs.
+## Demo
+[Demos & Instructions](https://mindflowgo.github.io/input-tags/)
+Video illustrations:
+![demonstration](./docs/media/autocomplete.gif)
+![special-keys](./docs/media/special-keys.gif)
+## Options
+*Only required tags are inputId*
+- **allowDelete**: allow the [x] deleting of tags (default true)
+- **allowDuplicates**: allow duplicate tags (default false)
+- **allowSpaces**: allow spaces in tags (default false)
+- **allowCustomKeys**: enables special character handling (default false)
+- **autocomplete**: array of auto-complete options
+- **initialTags**: array of initial tags to display
+- **targetEl**: target list element (if UL) or parent for the created list element
+- **onAdd**: a function called before adding the tag text (returns text or modified version)
+- **onDelete**: a function called before deleting a tag (returns true if allowed, false otherwise)
+- **onInput**: a function called after new user input received
+- **onChange**: a function called after change to tags (new tag added, re-arranged, deleted tag)
+## Methods
+*With a valid InputTags() instance you have these methods:*
+- **getTags()**: get the list of tags created
+- **setTags([])**: set the list of tags
+- **addTag(tag)**: add a new tag to input tags instance
+- **deleteTag(index)**: remove a tag, the index of it's placement
+- **showAutocomplete(query)**: showes autoComplete with matches for the query
+- **hideAutocomplete()**
+- **destroy()**: remove the instance
+## Usage
+There are 3 steps to using it
+1. Include the CSS & JS files (importing it into a script type=module)
+2. Have an empty list (UL) and an input box (INPUT)
+3. Run the function: const inputTags = new InputTags({ inputId: "tagsInput", listId: "tagsList" });
+That's it!
+### BASIC Example
+> Check the [CodePen.io example](https://codepen.io/mindflowgo/pen/PwYNQVe).
+#### Step 1 - Include Files (change path to match where they are)
+```html
+    <head>
+        <link rel="stylesheet" href="https://unpkg.com/input-tags@latest/style.css">
+    </head>
+    <script type="module">
+    import InputTags from "https://unpkg.com/input-tags@latest"
+    </script>
+```
+#### Step 2 - Insert needed HTML into your code
+```html
+<div>
+    <ul id="tagsList"></ul>
+    <input type="text" id="tagsInput" spellcheck="false" placeholder="Enter a tag" />
+</div>
+```
+#### Step 3 - Run Javascript (to initialize INPUT field)
+```javascript
+    const inputTags = new InputTags({ inputId: "tagsInput", listId: "tagsList" });
+```
+**Quick example html**
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <!-- Bootstrap 5 not used by Input Tags -->
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
+    <!-- Only CSS used by InputTags -->
+    <link rel="stylesheet" href="https://unpkg.com/input-tags@latest/style.css">
+</head>
+<body>
+    <div class="container mt-5">
+        <h1 class="text-center mb-4">Tags Input</h1>
+        <div class="mb-3">
+            <p class="mb-2">Tag List:</p>
+            <!-- specify the ul LIST element to show the tags -->
+            <ul id="myTagList"><li><strong>List:</strong></li></ul>
+            <!-- include the input box to input the tags -->
+             <p><i>Type something and press Enter</i></p>
+            <input type="text" id="tagsInput" class="form-control mt-2" spellcheck="false" placeholder="Enter a tag" />
+        </div>
+        <div class="mb-3">
+            <p class="mb-2">List results: <strong><span id="tagsData"></span></strong></p>
+            <div class="mt-5 d-grid gap-2 d-md-flex justify-content-md-start">
+                <button class="btn btn-secondary ms-md-2" onClick="btnAddTag('hello')">Add Tag 'hello'</button>
+            </div>
+        </div>
+    </div>
+     <!--Simple tags input implementation-->
+     <script type="module">
+        import InputTags from "https://unpkg.com/input-tags@latest"
+        const inputEl = document.getElementById('tagsInput');
+        const inputTags = new InputTags(inputEl, {
+            autocomplete: ['apple', 'banana', 'cherry'],
+            // initialTags: ['one','two','three'], // pre-populate (1)
+            targetEl: document.getElementById('myTagList'), // pre-populate (2)
+            onChange: (tags) => document.getElementById('tagsData').innerHTML = tags?.join(',') || ''
+        });
+        // show initial tags by adding something
+        setTimeout( ()=>inputTags.addTag('Auto-Add'), 100)
+        // export module functions for DOM
+        window.btnAddTag = (tag) => inputTags.addTag(tag);
+     </script>
+</body>
+</html>
+```
+### AutoComplete Example
+> Check the [CodePen.io example](https://codepen.io/mindflowgo/pen/MYgyVgg).
+#### Step 1 - Include Files (change path to match where they are)
+```html
+    <head>
+        <link rel="stylesheet" href="https://unpkg.com/input-tags@latest/style.css">
+    </head>
+    <script type="module">
+    import InputTags from "https://unpkg.com/input-tags@latest"
+    </script>
+```
+#### Step 2 - Insert needed HTML into your code
+Really just having an input box to enter tags is all that is needed. The package can use
+an existing list (UL) otherwise it will create one and pre-pend above the INPUT box.
+```html
+<div>
+    <input type="text" id="tagsInput" spellcheck="false" placeholder="Enter a tag" />
+    <button onClick="btnAddTag('hello')">Add Tag 'hello'</button>
+</div>
+```
+#### Step 3 - Run Javascript (to initialize INPUT field)
+```javascript
+    const inputEl = document.getElementById('tagsInput');
+    const inputTags = new InputTags(inputEl, {
+        autocomplete: ['apple', 'banana', 'cherry'],
+        initialTags: ['one','two','three'], // pre-populate (1)
+        // targetEl: document.getElementById('myTagList'), // pre-populate (2)
+        // onChange: (tags) => document.getElementById('tagsData').innerHTML = tags?.join(',') || ''
+    });
+    // export module functions for DOM access if needed
+    window.inputTags = inputTags;
+```
+### Advanced Ideas
+You can use the 4 hooks to limit characters allow in inputs, prevent certain tags from being created, or others from being deleted (with these hooks: onInput, onAdd, onDelete)
+```javascript
+    const inputEl = document.getElementById('tagsInput');
+    const inputTags = new InputTags(inputEl, {
+        targetEl: document.getElementById('myList'),
+        autocomplete: ['apple', 'banana', 'cherry', 'pear', 'pineapple'],
+        // allowCustomKeys: true,
+        // onInput: (value,e) => customKeyHandling(value,e),
+        onInput,
+        onAdd,
+        onDelete,
+        onChange: (tags) => document.getElementById('tagsOutput').value = tags?.join(',') || '',
+        });
+```
+- *AutoComplete*: Triggering display of autocomplete: see example/advanced.html "Show AutoComplete" button.
+```html
+    <button onClick="showList('apple')">Show AutoComplete List</button>
+```
+```javascript
+    window.showList = (search) => inputTags.showAutocomplete(search);
+```
+####
+If you modify the javascript in src/inputtags.js, you can build it with `npm run build` for distribution.
+Before forking and spreading another version, please contact the author with a PR if you have improvements
+you would like. I'd be happy to integrate improvements.

package/dist/input2tags.esm.min.js ADDED Viewed

@@ -0,0 +1 @@

+ class Input2Tags{constructor(t,e={}){this.input=t,this.opts={allowDelete:!0,allowDuplicates:!1,allowSpaces:!1,allowCustomKeys:!1,autocomplete:[],initialTags:[],targetEl:null,onAdd:null,onDelete:null,onInput:null,onChange:null,...e},this.tags=[],this.abortController=new AbortController,this.dragAbortController=null,this.dragTarget=null,this.#t()}#t(){const t=this.opts.targetEl;t&&"UL"===t.tagName?(this.list=t,Array.from(this.list.children).forEach(t=>{(t.dataset.tag||t.querySelector("span"))&&t.remove()})):(this.list=document.createElement("ul"),this.list.className="tagsList",this.list.setAttribute("role","list"),t?t.appendChild(this.list):this.input.parentNode.insertBefore(this.list,this.input)),this.placeholder=document.createElement("li"),this.placeholder.className="tagsDragPlaceholder",this.autocomplete=document.createElement("div"),this.autocomplete.className="tagsAutocompleteList",this.autocomplete.style.display="none",this.input.insertAdjacentElement("afterend",this.autocomplete),this.opts.allowCustomKeys||this.input.addEventListener("input",this.#e.bind(this),{signal:this.abortController.signal}),this.input.addEventListener("keydown",this.#s.bind(this),{signal:this.abortController.signal}),this.list.addEventListener("pointerdown",this.#i.bind(this),{signal:this.abortController.signal}),this.#o()}#o(){const t=this.opts.initialTags;if(t&&t.length)return void t.forEach(t=>this.addTag(t.trim()));const e=this.list.querySelectorAll("li");e.forEach(t=>{const e=t.textContent.replace("×","").trim();e&&this.addTag(e,t)}),e&&this.opts.onChange&&this.opts.onChange()}#e(t){let e=t.target.value;this.opts.onInput&&(t.target.value=this.opts.onInput(e)),this.showAutocomplete(e.trim())}#s(t){let e=this.input.value.trim();if(this.opts.onInput&&this.opts.allowCustomKeys)return void this.opts.onInput(e,t);if("Backspace"===t.key&&!e&&this.tags.length)return t.preventDefault(),void this.deleteTag(this.tags.length-1);("Enter"===t.key||!this.opts.allowSpaces&&","===t.key||this.opts.allowSpaces&&" "===t.key&&e.includes(","))&&e&&(t.preventDefault(),this.addTag(e),this.input.value="",this.hideAutocomplete())}showAutocomplete(t){if(!this.opts.autocomplete.length||!t)return void this.hideAutocomplete();const e=this.opts.autocomplete.filter(e=>e.toLowerCase().includes(t.toLowerCase())&&!this.tags.includes(e)).slice(0,8);if(!e.length)return void this.hideAutocomplete();const s=document.createElement("ul");e.forEach(t=>{const e=document.createElement("li");e.textContent=t,e.addEventListener("click",()=>{this.addTag(t),this.input.value="",this.hideAutocomplete()},{signal:this.abortController.signal}),s.appendChild(e)}),this.autocomplete.innerHTML="",this.autocomplete.appendChild(s),this.autocomplete.style.display="block"}hideAutocomplete(){this.autocomplete.style.display="none"}#i(t){const e=t.target.closest("li");e&&e.dataset.tag&&"SPAN"!==t.target.tagName&&(t.preventDefault(),this.dragData={el:e,startIndex:[...this.list.children].indexOf(e)},e.classList.add("tagsDragThis"),e.before(this.placeholder),this.dragAbortController?.abort(),this.dragAbortController=new AbortController,document.addEventListener("pointermove",this.#a.bind(this),{signal:this.dragAbortController.signal}),document.addEventListener("pointerup",this.#l.bind(this),{signal:this.dragAbortController.signal,once:!0}),document.addEventListener("touchend",this.#l.bind(this),{signal:this.dragAbortController.signal,once:!0}))}#a(t){if(!this.dragData)return;const e=document.elementFromPoint(t.clientX,t.clientY)?.closest("li");if(!e||e===this.dragData.el||e===this.placeholder||!e.dataset.tag)return;this.#n();const s=e.getBoundingClientRect(),i=t.clientX<s.left+s.width/2;this.dragTarget=e,e.classList.add("tagsDragOver"),this.list.insertBefore(this.placeholder,i?e:e.nextSibling)}#l(t){if(this.dragData){const{el:t}=this.dragData;this.list.insertBefore(t,this.placeholder)}this.#n(),this.placeholder.remove();const e=this.tags.join("|");this.tags=[];for(const t of this.list.querySelectorAll("li[data-tag]"))this.tags.push(t.dataset.tag),t.classList.remove("tagsDragThis");this.opts.onChange&&e!==this.tags.join("|")&&this.opts.onChange(this.tags),this.dragAbortController?.abort(),this.dragAbortController=null,this.dragData=null,this.input.focus()}#n(){this.dragTarget&&(this.dragTarget.classList.remove("tagsDragOver"),this.dragTarget=null)}#r(t){if(!this.opts.allowDelete)return;const e=document.createElement("span");e.classList.add("tagDelete"),e.innerHTML="×",e.style.cursor="pointer",e.addEventListener("click",e=>{e.stopPropagation(),this.#h(t)},{signal:this.abortController.signal}),t.appendChild(e)}#h(t){const e=t.dataset.tag;if(!(!this.opts.onDelete||this.opts.onDelete(e)))return;t.remove();const s=this.tags.indexOf(e);s>-1&&(this.tags.splice(s,1),this.opts.onChange&&this.opts.onChange(this.tags))}#d(){this.list.querySelectorAll("li").forEach(t=>{t.classList.remove("tagsDragThis","tagsDragOver"),t.dataset.tag&&(t.style.cursor="grab")}),this.placeholder.parentNode&&this.placeholder.remove(),this.dragAbortController?.abort(),this.dragAbortController=null,this.dragData=null,this.dragTarget=null}deleteTag(t){const e=this.list.querySelectorAll("li[data-tag]")[t];e&&this.#h(e)}addTag(t,e){if(!t||!this.opts.allowDuplicates&&this.tags.includes(t))return;if(this.opts.onAdd&&!e&&(t=this.opts.onAdd(t)),!t)return;const s=e||document.createElement("li");s.textContent=t,s.dataset.tag=t,s.setAttribute("role","listitem"),s.setAttribute("tabindex","0"),s.style.cursor="grab",e&&s.querySelector("span")?.remove(),this.#r(s),e||this.list.appendChild(s),this.tags.push(t),this.opts.onChange&&this.opts.onChange(this.tags)}getTags(){return[...this.tags]}setTags(t){this.tags=[],this.list.querySelectorAll("li[data-tag]").forEach(t=>t.remove()),t.forEach(t=>this.addTag(t))}resetDragState(){this.#d()}destroy(){this.#d(),this.abortController.abort(),this.list?.remove(),this.autocomplete?.remove()}}export default Input2Tags;

package/dist/input2tags.min.css ADDED Viewed

@@ -0,0 +1 @@

+ .tagsList{border:none;display:flex;flex-wrap:wrap;padding-left:0}.tagsList LI{background:#d4d7ff;border:1px solid #e3e1e1;border-radius:5px;color:#333;list-style:none;margin-right:2px;padding:5px 28px 5px 10px;position:relative}.tagsList .tagDelete{background:#dfdfdf;border-radius:2px;color:grey;cursor:pointer!important;font-size:18px;height:100%;justify-content:center;padding:3px 0 0 6px;position:absolute;right:0;top:0;width:24px}.tagsAutocompleteList span{position:relative}.tagsAutocompleteList ul{background:#fff;border:1px solid #d3d3d3;border-radius:5px;display:block;margin:5px 0 0;max-height:300px;overflow-y:auto;padding:0;position:absolute;z-index:99}.tagsAutocompleteList li{border-bottom:1px dotted #eee;cursor:pointer;list-style:none;padding:5px}.tagsAutocompleteList li:hover{background:#eee;font-weight:600}.tagsDragThis{filter:grayscale(80%);opacity:.5}.tagsDragThis:after{content:"↑"}.tagsDragPlaceholder{border:2px dashed #999!important;margin:0 1px;opacity:.7;padding:0}.tagsDragPlaceholder:before{color:green;content:"↓";font-size:16px}

package/dist/input2tags.min.js ADDED Viewed

@@ -0,0 +1 @@

package/package.json ADDED Viewed

@@ -0,0 +1,54 @@
+{
+  "name": "input2tags",
+  "version": "3.0.1",
+  "description": "Simple, but powerful vanilla javascript input2tags creator, with autocomplete.",
+  "keywords": [
+    "input",
+    "tags",
+    "es6",
+    "autocomplete",
+    "input-tags",
+    "input2tags",
+    "labels"
+  ],
+  "author": "Filipe Laborde <fil@rezox.com>",
+  "license": "MIT",
+  "main": "dist/input2tags.min.js",
+  "style": "dist/input2tags.min.css",
+  "module": "dist/input2tags.esm.min.js",
+  "exports": {
+    ".": {
+      "import": "./dist/input2tags.esm.min.js",
+      "require": "./dist/input2tags.min.js",
+      "default": "./dist/input2tags.min.js"
+    }
+  },
+  "files": [
+    "dist/input2tags.esm.min.js",
+    "dist/input2tags.min.js",
+    "dist/input2tags.min.css",
+    "LICENSE",
+    "README.md"
+  ],
+  "type": "module",
+  "scripts": {
+    "build:js:esm": "terser src/input2tags.js -c -m -o dist/input2tags.esm.min.js",
+    "build:js:classic": "terser src/input2tags.js -c -m -o dist/input2tags.min.js && node package.mjs dist/input2tags.min.js",
+    "build:css": "postcss src/input2tags.css -u cssnano --no-map -o dist/input2tags.min.css",
+    "build": "npm run build:js:esm && npm run build:js:classic && npm run build:css"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mindflowgo/input2tags.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mindflowgo/input2tags/issues"
+  },
+  "homepage": "https://github.com/mindflowgo/input2tags#readme",
+  "devDependencies": {
+    "cssnano": "^7.1.2",
+    "postcss": "^8.5.6",
+    "postcss-cli": "^11.0.1",
+    "terser": "^5.44.1"
+  }
+}