query-text v0.1.0-alpha.0

\

Reusable Web Component based on LitElement. It provides search functionality within multi-keyed dictionary of strings.

It extracts keys from the dictionary and uses them as prefixes for autocompletion purposes. When key: "ENTER" is pressed, it emits an event (through custom event bubble) with the actual value of query string.

The main goal is to provide fuzzy search with autocompletion when user types into search bar.

This webcomponent follows the open-wc recommendation.

Installation

npm i query-text

Usage

<script type="module">
	import 'query-text/query-text.js';
</script>

<query-text></query-text>

Implementation

• Takes a dictionary in input {prefix, dictionary}:

{
	'prefix1': [
		'string1',
	    ...
        'string(n)',
	],
	'prefix(n)': [
        'string1',
	    ...
        'string(n)',
    ],
    ...
}

• Returns an event "searchedQuery" with the searched query text

let event = new CustomEvent('search-query-event', {
	detail: {
		searchedQuery: textInput,
	},
	bubbles: true,
	composed: true,
});

Linting with ESLint, Prettier, and Types

To scan the project for linting errors, run

npm run lint

You can lint with ESLint and Prettier individually as well

npm run lint:eslint

npm run lint:prettier

To automatically fix many linting errors, run

npm run format

You can format using ESLint and Prettier individually as well

npm run format:eslint

npm run format:prettier

Testing with Web Test Runner

To run the suite of Web Test Runner tests, run

npm run test

To run the tests in watch mode (for <abbr title="test driven development">TDD</abbr>, for example), run

npm run test:watch

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

npm run storybook:build

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

Local Demo with web-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html