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:18 -07:00
parent 8eebb13b6b
commit 5711e32be3
1 changed files with 3 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -2,15 +2,7 @@
A JavaScript and CSS library for augmenting raw HTML inputs with modern search features A JavaScript and CSS library for augmenting raw HTML inputs with modern search features
###### Requirements ### Basic Usage
* jQuery
###### Features
* Support for locally rendered options and options returned via a GET request
###### Basic Usage
Include both the `SearchableInput.js` and `SearchableInput.css` files in your page's source and wrap any text input like the following: Include both the `SearchableInput.js` and `SearchableInput.css` files in your page's source and wrap any text input like the following:
@ -25,7 +17,7 @@ Include both the `SearchableInput.js` and `SearchableInput.css` files in your pa
</div> </div>
</div> </div>
###### Shared Item Source ### 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: 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:
@ -42,7 +34,7 @@ Then, in the `div.items` container beneath the input, set its `data-source` attr
<div class="items" data-source="#items-source"></div> <div class="items" data-source="#items-source"></div>
</div> </div>
###### Items from GET (application/json) ### Items from GET Request
Alternatively, you can set the `data-source-api` to access a GET endpoint that responds with `application/json`: Alternatively, you can set the `data-source-api` to access a GET endpoint that responds with `application/json`: