intermix-search
v1.0.4
Published
Intermix Search API Extension
Downloads
2
Maintainers
Readme
Intermix Search API
This API extension provides a central search functionality and returns search items formated in tailwindCSS
Documentation
The following functions are brought to the Pilet API.
createIntermixSearchApi
Setup and Bootstrapping
The provided library only brings API extensions for pilets to a Piral instance.
For the setup of the library itself you'll need to import createLinkApi
from the piral-navlink
package.
import { createIntermixSearchApi } from "piral-navlink";
The integration looks like:
const instance = createInstance({
// important part
extendApi: [createIntermixSearchApi()]
// ...
});
getSearchResults
Get Search Results based on the query string
getSearchResults(query: string): ComponentType[];
Usage
piral.getSearchResults(<query string>);
License
MIT