piral-search

Piral Search ·

This is a plugin that only has a peer dependency to piral-core. What piral-search brings to the table is a set of Pilet API extensions that can be used with piral or piral-core to bring enhanced search capabilities to pilets via your Piral instance.

By default, these API extensions are not integrated in piral, so you'd need to add them to your Piral instance.

Documentation

The following functions are brought to the Pilet API.

registerSearchProvider

Adds a search provider to be used in the app shell. The search provider will always be invoked when the global search is triggered.

If the first argument is a string a named search provider is registered. A named search provider can also be removed.

unregisterSearchProvider

Removes a search provider from the app shell. This requires a named search provider.

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 createSearchApi from the piral-search package.

import { createSearchApi } from 'piral-search';

The integration looks like:

const instance = createInstance({
  // important part
  extendApi: [createSearchApi()],
  // ...
});

Via the options the initially displayed results can be defined. The current query can also be set.

For example:

const instance = createInstance({
  // important part
  extendApi: [createSearchApi({
    query: '!help',
    results: [
      <div>
        Help was found!
      </div>,
    ],
  })],
  // ...
});

License

Piral is released using the MIT license. For more information see the license file.