be-searching

Make a DOM element searchable.

![Playwright Tests](https://github.com/bahrus/be-searching/actions/workflows/CI.yml)
![NPM version](http://badge.fury.io/js/be-searching)
![How big is this package in your project?](https://bundlephobia.com/result?p=be-searching)

Example 1 -- minimal

html



    Supercalifragilisticexpialidocious





generates:

html



    Supercalifragilisticexpialidocious





Example 2 -- custom class, tag

html



    Supercalifragilisticexpialidocious





generates:

html



    Supercalifragilisticexpialidocious





JSON-in-html?



Editing JSON-in-html can be rather error prone.  A VS Code extension is available to help with that, and is compatible with web versions of VSCode.



Example 3 Tied to search input



Use be-searching in partnership with be-linked.

html

        be-linked='

            On input event of previous element sibling pass value property to $0+beSearching:forText.

        '

    >

    

        supercalifragilisticexpialidocious





generates:

html

        On input event of previous element sibling pass value property to $0-enh-by-be-searching : for text.

    '>

    

        supercalifragilisticexpialidocious





Other boolean options: 



caseSensitive

regex [TODO]

wholeWord [TODO]

beVigilant [TODO]

recursive [TODO]



beVigilant will add a mutation observer.



Running locally



Any web server that can serve static files will do but...



1.  Do a git clone or a git fork of repository https://github.com/bahrus/be-searching

2.  Install node.js

3.  Run "npm install" from location of folder created in step 1.

4.  Run npm run serve.  Open browser to http://localhost:3030/demo/



Using from ESM Module:

JavaScript

import 'be-searching/be-searching.js';





Using from CDN:

html