This is the reblocks-typeahead Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:34:58 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
reblocks-typeaheadA Reblocks widget implementing typeahead search.
Alexander Artemenko <svetlyak.40wt@gmail.com>
(GIT https://github.com/40ants/reblocks-typeahead)
Unlicense
<a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-40README-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
# reblocks-typeahead - A Reblocks widget implementing typeahead search.
<a id="reblocks-typeahead-asdf-system-details"></a>
## REBLOCKS-TYPEAHEAD ASDF System Details
* Description: A Reblocks widget implementing typeahead search.
* Licence: Unlicense
* Author: Alexander Artemenko <svetlyak.40wt@gmail.com>
* 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]
<a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-3A-40INSTALLATION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## Installation
You can install this library from Quicklisp, but you want to receive updates quickly, then install it from Ultralisp.org:
“‘
(ql-dist:install-dist "http://dist.ultralisp.org/"
:prompt nil)
(ql:quickload :reblocks-typeahead)
“‘
<a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-3A-40USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## Usage
To use this library, you need to inherit your widget from [‘reblocks-typeahead:typeahead-widget‘][9e7b]
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]
to learn how these methods can be implemented.
<a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-3A-40API-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## API
<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](22af) ‘reblocks-typeahead‘
<a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-TYPEAHEAD-3FClasses-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
#### Classes
<a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-3A-40REBLOCKS-TYPEAHEAD-24TYPEAHEAD-RESULTS-3FCLASS-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
##### TYPEAHEAD-RESULTS
<a id="x-28REBLOCKS-TYPEAHEAD-3ATYPEAHEAD-RESULTS-20CLASS-29"></a>
###### [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](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](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](c283) ‘reblocks-typeahead:typeahead-widget‘ (ui-widget)
Base class for custom typeahead widgets.
Define you own widget class based on the [‘typeahead-widget‘][9e7b]
and also define methods for following generic-functions.
Mandatory:
* [‘execute-query‘][c957]
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](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](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](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](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](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](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.
To make simple widgets out of strings, you can use
[‘reblocks/widgets/string-widget:make-string-widget‘][07eb] function.
<a id="x-28REBLOCKS-TYPEAHEAD-3AHIDE-RESULTS-20GENERIC-FUNCTION-29"></a>
##### [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](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](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](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](b866) ‘reblocks-typeahead:update-results‘ widget query
Calls [‘execute-query‘][c957] generic-function and updates the dropdown widget.
<a id="x-28REBLOCKS-TYPEAHEAD-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-TYPEAHEAD-3FFunctions-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
#### Functions
<a id="x-28REBLOCKS-TYPEAHEAD-3AFOCUS-IN-20FUNCTION-29"></a>
##### [function](450d) ‘reblocks-typeahead:focus-in‘ widget
[784a]: https://40ants.com/reblocks-typeahead/
[c957]: https://40ants.com/reblocks-typeahead/#x-28REBLOCKS-TYPEAHEAD-3AEXECUTE-QUERY-20GENERIC-FUNCTION-29
[7fcf]: https://40ants.com/reblocks-typeahead/#x-28REBLOCKS-TYPEAHEAD-3AHIDE-RESULTS-20GENERIC-FUNCTION-29
[d21f]: https://40ants.com/reblocks-typeahead/#x-28REBLOCKS-TYPEAHEAD-3AON-EMPTY-SELECTION-20GENERIC-FUNCTION-29
[0a41]: https://40ants.com/reblocks-typeahead/#x-28REBLOCKS-TYPEAHEAD-3AON-SELECT-20GENERIC-FUNCTION-29
[12c7]: https://40ants.com/reblocks-typeahead/#x-28REBLOCKS-TYPEAHEAD-3APROCESS-TYPEAHEAD-CHOICE-20GENERIC-FUNCTION-29
[9e7b]: https://40ants.com/reblocks-typeahead/#x-28REBLOCKS-TYPEAHEAD-3ATYPEAHEAD-WIDGET-20CLASS-29
[607c]: https://40ants.com/reblocks-typeahead/#x-28REBLOCKS-TYPEAHEAD-3AUPDATE-RESULTS-20GENERIC-FUNCTION-29
[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
[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
[184b]: https://quickdocs.org/reblocks
[28e0]: https://quickdocs.org/reblocks-lass
[c07c]: https://quickdocs.org/reblocks-parenscript
[4376]: https://quickdocs.org/reblocks-ui
* * *
###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]
0.2.0
40ants-asdf-system (system).
reblocks-typeahead/core (system).
reblocks-typeahead/coreAlexander Artemenko <svetlyak.40wt@gmail.com>
(GIT https://github.com/40ants/reblocks-typeahead)
Unlicense
reblocks/widget (system).
reblocks-ui (system).
reblocks-ui/form (system).
reblocks/html (system).
reblocks-typeahead/css (system).
reblocks-typeahead/js (system).
reblocks-typeahead/cssAlexander Artemenko <svetlyak.40wt@gmail.com>
(GIT https://github.com/40ants/reblocks-typeahead)
Unlicense
reblocks-lass (system).
reblocks-typeahead/jsAlexander Artemenko <svetlyak.40wt@gmail.com>
(GIT https://github.com/40ants/reblocks-typeahead)
Unlicense
reblocks-parenscript (system).
parenscript (system).
Files are sorted by type and then listed depth-first from the systems components trees.
reblocks-typeahead/reblocks-typeahead.asdreblocks-typeahead/core/file-type.lispreblocks-typeahead/css/file-type.lispreblocks-typeahead/js/file-type.lispreblocks-typeahead/reblocks-typeahead.asdreblocks-typeahead (system).
reblocks-typeahead/core/file-type.lispreblocks-typeahead/core (system).
execute-query (generic function).
focus-in (function).
get-css-classes (method).
get-dependencies (method).
hide-results (generic function).
input-value (reader method).
(setf input-value) (writer method).
on-empty-selection (generic function).
on-select (generic function).
placeholder (reader method).
(setf placeholder) (writer method).
process-typeahead-choice (generic function).
render (method).
render (method).
results-items (reader method).
(setf results-items) (writer method).
typeahead-results (reader method).
typeahead-results (class).
typeahead-widget (class).
update-results (generic function).
reblocks-typeahead/css/file-type.lispreblocks-typeahead/css (system).
make-css (function).
reblocks-typeahead/js/file-type.lispreblocks-typeahead/js (system).
make-js (function).
Packages are listed by definition order.
reblocks-typeaheadreblocks-typeahead/core
common-lisp.
execute-query (generic function).
focus-in (function).
hide-results (generic function).
input-value (generic reader).
(setf input-value) (generic writer).
on-empty-selection (generic function).
on-select (generic function).
placeholder (generic reader).
(setf placeholder) (generic writer).
process-typeahead-choice (generic function).
results-items (generic reader).
(setf results-items) (generic writer).
typeahead-results (generic reader).
typeahead-results (class).
typeahead-widget (class).
update-results (generic function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
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.
To make simple widgets out of strings, you can use
REBLOCKS/WIDGETS/STRING-WIDGET:MAKE-STRING-WIDGET function.
typeahead-widget) query) ¶Hides dropdown widget. Call this method from a custom ON-SELECT or ON-EMPTY-SELECTION methods.
typeahead-widget)) ¶typeahead-widget)) ¶automatically generated reader method
typeahead-widget)) ¶automatically generated writer method
Called when user entered some query but didn’t selected any item, just pressed Enter.
typeahead-widget) query) ¶Called when user selected an item in the typeahead results.
typeahead-widget) item) ¶typeahead-widget)) ¶automatically generated reader method
typeahead-widget)) ¶automatically generated writer method
Calls either ON-SELECT or ON-EMPTY-SELECTION depending on if user has choosen an item from the dropdown.
typeahead-widget) query selected-item-idx) ¶typeahead-results)) ¶automatically generated reader method
typeahead-results)) ¶automatically generated writer method
typeahead-widget)) ¶automatically generated reader method
Calls EXECUTE-QUERY generic-function and updates the dropdown widget.
typeahead-widget) query) ¶typeahead-widget)) ¶reblocks/widget.
typeahead-widget)) ¶reblocks/dependencies.
typeahead-widget)) ¶reblocks/widget.
typeahead-results)) ¶reblocks/widget.
ui-widget.
Base class for custom typeahead widgets.
Define you own widget class based on the TYPEAHEAD-WIDGET and also define methods for following generic-functions.
Mandatory:
- EXECUTE-QUERY
Optional:
- ON-SELECT
- ON-EMPTY-SELECTION
- PROCESS-TYPEAHEAD-CHOICE
- UPDATE-RESULTS
- HIDE-RESULTS
ui-widget.
(make-instance (quote reblocks-typeahead:typeahead-results))
This slot is read-only.
:placeholder
:value
| Jump to: | (
E F G H I M O P R T U |
|---|
| Jump to: | (
E F G H I M O P R T U |
|---|
| Jump to: | I P R S V |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| I | |||
items: | Public classes | ||
| | |||
| P | |||
placeholder: | Public classes | ||
| | |||
| R | |||
results: | Public classes | ||
| | |||
| S | |||
Slot, items: | Public classes | ||
Slot, placeholder: | Public classes | ||
Slot, results: | Public classes | ||
Slot, value: | Public classes | ||
| | |||
| V | |||
value: | Public classes | ||
| | |||
| Jump to: | I P R S V |
|---|
| Jump to: | C F P R S T |
|---|
| Jump to: | C F P R S T |
|---|