caharkness/SearchableInput
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
caharkness 2025-02-27 14:35:59 -07:00
parent 5711e32be3
commit b574eeedb5
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -2,6 +2,8 @@
A JavaScript and CSS library for augmenting raw HTML inputs with modern search features
---
### Basic Usage
Include both the `SearchableInput.js` and `SearchableInput.css` files in your page's source and wrap any text input like the following:
@ -17,6 +19,8 @@ Include both the `SearchableInput.js` and `SearchableInput.css` files in your pa
</div>
</div>
---
### Shared Item Source
If multiple inputs require the same source of data, put your `div.item` options in a hidden div somewhere in the document accessible by its `id` attribute:
@ -34,6 +38,8 @@ Then, in the `div.items` container beneath the input, set its `data-source` attr
<div class="items" data-source="#items-source"></div>
</div>
---
### Items from GET Request
Alternatively, you can set the `data-source-api` to access a GET endpoint that responds with `application/json`: