Home > @findkit/ui > FindkitUIEvents
FindkitUIEvents interface
FindkitUI event definitions
Signature:
export interface FindkitUIEvents<G extends FindkitUIGenerics = FindkitUIGenerics, O extends FindkitUIOptions<G> = FindkitUIOptions<G>>
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| "bind-input" | BindInputEvent | When an input is bound to the UI with .bindInput() | |
| "custom-router-data" | CustomRouterDataEvent<G> | ||
| "debounced-search" | DebouncedSearchEvent | Emitted when search results have not been updated for a while. Useful for analytics | |
| "fetch-done" | FetchDoneEvent | When a search request finishes | |
| "hit-click" | HitClickEvent | ||
| "loading-done" | LoadingDoneEvent | Emitted when the UI finishes loading something. Always called after the loading event. |
|
| "request-open" | RequestOpenEvent | When modal opening is requested. The implementation loading can happen before the modal is actually opened. This can be used to show a loading indicator. | |
| "unbind-input" | UnbindInputEvent | When an input is unbound from the UI with the returned unbound from .bindInput() or the FindkitUI instance is disposed with .dispose() | |
| close | {} | When the modal is closed | |
| dispose | {} | When the UI discarded with .dispose() | |
| fetch | FetchEvent<G, O> | Search request starts | |
| groups | GroupsChangeEvent<G> | Emitted when groups change | |
| init | InitEvent | When the FinkitUI is initialized with the options. The options property can be mutated. | |
| lang | LanguageChangeEvent | Emitted when the UI language changes | |
| loaded | LoadedEvent | When the implementation was loaded and initialized | |
| loading | LoadingEvent | Emitted when the UI starts loading something. Implementation code or a search request. | |
| open | OpenEvent | When the modal is opened | |
| params | ParamsChangeEvent<G> | Emitted when the search params change | |
| status | StatusChangeEvent | Emitted when the internal UI status changes. |