1.1.1 • Published 6 months ago

@knadh/highlighted-input v1.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

highlighted-input.js

highlighted-input.js is a super tiny, zero dependency Javascript lib that highlights specific keywords and tags in an <input> field. It is ideal for search inputs to highlight field selectors as the user types. It is ~450 bytes minified+gzipped.

View demo

demo

Usage

Node

npm install @knadh/highlighted-input
import { highlightedInput } from @knadh/highlighted-input;

// Initialize the highlighter with the input element and keyword map
const input = document.getElementById("input");

// .highlighted-h1 and .highlighted-h2 highlight classes.
const h1 = "highlighted-h1";
const h2 = "highlighted-h2";

// Map of keywords to highlight and the corresponding classnames.
// Copy styles from style.css and add it to the webpage. 
const keywordMap = {
    "lang:": h1, 
    "repo:": h1, 
    "user:": h1, 
    "AND": h2,
    "OR": h2,
    "NOT": h2,
};

highlightedInput(input, keywordMap);

Copy the CSS, customize it as required, and add it to the webpage.

Check the demo source for a full example.

ES6 module

Check the demo source to use the lib in <script> directly in an HTML page.

Licensed under the MIT License.

1.1.1

6 months ago

1.1.0

8 months ago

1.0.0

8 months ago