Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

intermix-search

1.0.4 • Public • Published

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

Install

npm i intermix-search

DownloadsWeekly Downloads

1

Version

1.0.4

License

MIT

Unpacked Size

23 kB

Total Files

25

Last publish

Collaborators

  • avatar