-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
58f4001
commit 6b124cc
Showing
2 changed files
with
31 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,20 +6,12 @@ | |
|
|
||
| ## REBLOCKS-TYPEAHEAD ASDF System Details | ||
|
|
||
| * Version: 0.2.0 | ||
|
|
||
| * Description: A Reblocks widget implementing typeahead search. | ||
|
|
||
| * Licence: Unlicense | ||
|
|
||
| * Author: Alexander Artemenko <[email protected]> | ||
|
|
||
| * Homepage: [https://40ants.com/reblocks-typeahead/][784a] | ||
|
|
||
| * Bug tracker: [https://github.com/40ants/reblocks-typeahead/issues][8267] | ||
|
|
||
| * Source control: [GIT][91a7] | ||
|
|
||
| * Depends on: [parenscript][7921], [reblocks][184b], [reblocks-lass][28e0], [reblocks-parenscript][c07c], [reblocks-ui][4376] | ||
|
|
||
| [][f8ea] | ||
|
|
@@ -47,7 +39,6 @@ To use this library, you need to inherit your widget from [`reblocks-typeahead:t | |
| and to provide at least two methods: | ||
|
|
||
| * [`reblocks-typeahead:execute-query`][c957] which will respond with data for dropdown | ||
|
|
||
| * [`reblocks-typeahead:on-select`][0a41] which will be executed when user has choosen an item from dropdown menu. | ||
|
|
||
| See [this example application's code][3c58] | ||
|
|
@@ -57,21 +48,13 @@ to learn how these methods can be implemented. | |
|
|
||
| ## API | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-3A-40REBLOCKS-TYPEAHEAD-2FCSS-3FPACKAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a> | ||
|
|
||
| ### REBLOCKS-TYPEAHEAD/CSS | ||
|
|
||
| <a id="x-28-23A-28-2822-29-20BASE-CHAR-20-2E-20-22REBLOCKS-TYPEAHEAD-2FCSS-22-29-20PACKAGE-29"></a> | ||
|
|
||
| #### [package](9f39) `reblocks-typeahead/css` | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-3A-40REBLOCKS-TYPEAHEAD-3FPACKAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a> | ||
|
|
||
| ### REBLOCKS-TYPEAHEAD | ||
|
|
||
| <a id="x-28-23A-28-2818-29-20BASE-CHAR-20-2E-20-22REBLOCKS-TYPEAHEAD-22-29-20PACKAGE-29"></a> | ||
|
|
||
| #### [package](decc) `reblocks-typeahead` | ||
| #### [package](22af) `reblocks-typeahead` | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-TYPEAHEAD-3FClasses-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a> | ||
|
|
||
|
|
@@ -83,27 +66,27 @@ to learn how these methods can be implemented. | |
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3ATYPEAHEAD-RESULTS-20CLASS-29"></a> | ||
|
|
||
| ###### [class](950c) `reblocks-typeahead:typeahead-results` (ui-widget) | ||
| ###### [class](5477) `reblocks-typeahead:typeahead-results` (ui-widget) | ||
|
|
||
| **Readers** | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3ARESULTS-ITEMS-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20REBLOCKS-TYPEAHEAD-3ATYPEAHEAD-RESULTS-29-29"></a> | ||
|
|
||
| ###### [reader](e3f3) `reblocks-typeahead:results-items` (typeahead-results) (= nil) | ||
| ###### [reader](dfb4) `reblocks-typeahead:results-items` (typeahead-results) (= nil) | ||
|
|
||
| **Accessors** | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3ARESULTS-ITEMS-20-2840ANTS-DOC-2FLOCATIVES-3AACCESSOR-20REBLOCKS-TYPEAHEAD-3ATYPEAHEAD-RESULTS-29-29"></a> | ||
|
|
||
| ###### [accessor](e3f3) `reblocks-typeahead:results-items` (typeahead-results) (= nil) | ||
| ###### [accessor](dfb4) `reblocks-typeahead:results-items` (typeahead-results) (= nil) | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-3A-40REBLOCKS-TYPEAHEAD-24TYPEAHEAD-WIDGET-3FCLASS-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a> | ||
|
|
||
| ##### TYPEAHEAD-WIDGET | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3ATYPEAHEAD-WIDGET-20CLASS-29"></a> | ||
|
|
||
| ###### [class](b0d5) `reblocks-typeahead:typeahead-widget` (ui-widget) | ||
| ###### [class](c283) `reblocks-typeahead:typeahead-widget` (ui-widget) | ||
|
|
||
| Base class for custom typeahead widgets. | ||
|
|
||
|
|
@@ -117,46 +100,42 @@ Mandatory: | |
| Optional: | ||
|
|
||
| * [`on-select`][0a41] | ||
|
|
||
| * [`on-empty-selection`][d21f] | ||
|
|
||
| * [`process-typeahead-choice`][12c7] | ||
|
|
||
| * [`update-results`][607c] | ||
|
|
||
| * [`hide-results`][7fcf] | ||
|
|
||
| **Readers** | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3AINPUT-VALUE-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20REBLOCKS-TYPEAHEAD-3ATYPEAHEAD-WIDGET-29-29"></a> | ||
|
|
||
| ###### [reader](081c) `reblocks-typeahead:input-value` (typeahead-widget) (:value = nil) | ||
| ###### [reader](1729) `reblocks-typeahead:input-value` (typeahead-widget) (:value = nil) | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3APLACEHOLDER-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20REBLOCKS-TYPEAHEAD-3ATYPEAHEAD-WIDGET-29-29"></a> | ||
|
|
||
| ###### [reader](1841) `reblocks-typeahead:placeholder` (typeahead-widget) (:placeholder = nil) | ||
| ###### [reader](136f) `reblocks-typeahead:placeholder` (typeahead-widget) (:placeholder = nil) | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3ATYPEAHEAD-RESULTS-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20REBLOCKS-TYPEAHEAD-3ATYPEAHEAD-WIDGET-29-29"></a> | ||
|
|
||
| ###### [reader](d347) `reblocks-typeahead:typeahead-results` (typeahead-widget) (= (make-instance 'typeahead-results)) | ||
| ###### [reader](e485) `reblocks-typeahead:typeahead-results` (typeahead-widget) (= (make-instance 'typeahead-results)) | ||
|
|
||
| **Accessors** | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3AINPUT-VALUE-20-2840ANTS-DOC-2FLOCATIVES-3AACCESSOR-20REBLOCKS-TYPEAHEAD-3ATYPEAHEAD-WIDGET-29-29"></a> | ||
|
|
||
| ###### [accessor](081c) `reblocks-typeahead:input-value` (typeahead-widget) (:value = nil) | ||
| ###### [accessor](1729) `reblocks-typeahead:input-value` (typeahead-widget) (:value = nil) | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3APLACEHOLDER-20-2840ANTS-DOC-2FLOCATIVES-3AACCESSOR-20REBLOCKS-TYPEAHEAD-3ATYPEAHEAD-WIDGET-29-29"></a> | ||
|
|
||
| ###### [accessor](1841) `reblocks-typeahead:placeholder` (typeahead-widget) (:placeholder = nil) | ||
| ###### [accessor](136f) `reblocks-typeahead:placeholder` (typeahead-widget) (:placeholder = nil) | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-TYPEAHEAD-3FGenerics-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a> | ||
|
|
||
| #### Generics | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3AEXECUTE-QUERY-20GENERIC-FUNCTION-29"></a> | ||
|
|
||
| ##### [generic-function](e507) `reblocks-typeahead:execute-query` widget query | ||
| ##### [generic-function](7db0) `reblocks-typeahead:execute-query` widget query | ||
|
|
||
| A method for this generic-function should return a list of widgets to be shown in reponse to the given text query. | ||
| This method should return a list of widgets. | ||
|
|
@@ -165,31 +144,31 @@ To make simple widgets out of strings, you can use | |
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3AHIDE-RESULTS-20GENERIC-FUNCTION-29"></a> | ||
|
|
||
| ##### [generic-function](6b42) `reblocks-typeahead:hide-results` widget | ||
| ##### [generic-function](6e26) `reblocks-typeahead:hide-results` widget | ||
|
|
||
| Hides dropdown widget. Call this method from a custom [`on-select`][0a41] or [`on-empty-selection`][d21f] methods. | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3AON-EMPTY-SELECTION-20GENERIC-FUNCTION-29"></a> | ||
|
|
||
| ##### [generic-function](2451) `reblocks-typeahead:on-empty-selection` widget query | ||
| ##### [generic-function](bddc) `reblocks-typeahead:on-empty-selection` widget query | ||
|
|
||
| Called when user entered some query but didn't selected any item, just pressed Enter. | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3AON-SELECT-20GENERIC-FUNCTION-29"></a> | ||
|
|
||
| ##### [generic-function](5611) `reblocks-typeahead:on-select` widget item | ||
| ##### [generic-function](f1eb) `reblocks-typeahead:on-select` widget item | ||
|
|
||
| Called when user selected an item in the typeahead results. | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3APROCESS-TYPEAHEAD-CHOICE-20GENERIC-FUNCTION-29"></a> | ||
|
|
||
| ##### [generic-function](b8d1) `reblocks-typeahead:process-typeahead-choice` widget query selected-item-idx | ||
| ##### [generic-function](3fcc) `reblocks-typeahead:process-typeahead-choice` widget query selected-item-idx | ||
|
|
||
| Calls either [`on-select`][0a41] or [`on-empty-selection`][d21f] depending on if user has choosen an item from the dropdown. | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3AUPDATE-RESULTS-20GENERIC-FUNCTION-29"></a> | ||
|
|
||
| ##### [generic-function](d9ee) `reblocks-typeahead:update-results` widget query | ||
| ##### [generic-function](b866) `reblocks-typeahead:update-results` widget query | ||
|
|
||
| Calls [`execute-query`][c957] generic-function and updates the dropdown widget. | ||
|
|
||
|
|
@@ -199,15 +178,7 @@ Calls [`execute-query`][c957] generic-function and updates the dropdown widget. | |
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-3AFOCUS-IN-20FUNCTION-29"></a> | ||
|
|
||
| ##### [function](0531) `reblocks-typeahead:focus-in` widget | ||
|
|
||
| <a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-3A-40REBLOCKS-TYPEAHEAD-2FJS-3FPACKAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a> | ||
|
|
||
| ### REBLOCKS-TYPEAHEAD/JS | ||
|
|
||
| <a id="x-28-23A-28-2821-29-20BASE-CHAR-20-2E-20-22REBLOCKS-TYPEAHEAD-2FJS-22-29-20PACKAGE-29"></a> | ||
|
|
||
| #### [package](86ee) `reblocks-typeahead/js` | ||
| ##### [function](450d) `reblocks-typeahead:focus-in` widget | ||
|
|
||
|
|
||
| [784a]: https://40ants.com/reblocks-typeahead/ | ||
|
|
@@ -221,22 +192,20 @@ Calls [`execute-query`][c957] generic-function and updates the dropdown widget. | |
| [07eb]: https://40ants.com/reblocks/widgets/#x-28REBLOCKS-2FWIDGETS-2FSTRING-WIDGET-3AMAKE-STRING-WIDGET-20FUNCTION-29 | ||
| [91a7]: https://github.com/40ants/reblocks-typeahead | ||
| [f8ea]: https://github.com/40ants/reblocks-typeahead/actions | ||
| [decc]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L1 | ||
| [6b42]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L104 | ||
| [e507]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L115 | ||
| [0531]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L163 | ||
| [950c]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L29 | ||
| [e3f3]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L30 | ||
| [b0d5]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L34 | ||
| [d347]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L35 | ||
| [1841]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L37 | ||
| [081c]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L40 | ||
| [5611]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L61 | ||
| [2451]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L70 | ||
| [b8d1]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L78 | ||
| [d9ee]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/core.lisp#L93 | ||
| [9f39]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/css.lisp#L1 | ||
| [86ee]: https://github.com/40ants/reblocks-typeahead/blob/12c566e378dffdae816788d6fcc91add1c5e6e27/src/js.lisp#L1 | ||
| [22af]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L1 | ||
| [6e26]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L104 | ||
| [7db0]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L115 | ||
| [450d]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L163 | ||
| [5477]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L29 | ||
| [dfb4]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L30 | ||
| [c283]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L34 | ||
| [e485]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L35 | ||
| [136f]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L37 | ||
| [1729]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L40 | ||
| [f1eb]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L61 | ||
| [bddc]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L70 | ||
| [3fcc]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L78 | ||
| [b866]: https://github.com/40ants/reblocks-typeahead/blob/58f4001053f7961f6db6bfd23839419782a20246/src/core.lisp#L93 | ||
| [8267]: https://github.com/40ants/reblocks-typeahead/issues | ||
| [3c58]: https://github.com/40ants/reblocks-typeahead/tree/master/example | ||
| [7921]: https://quickdocs.org/parenscript | ||
|
|
||