This is a plugin that only has a peer dependency to
piral-search brings to the table is a set of Pilet API extensions that can be used with
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.
The following functions are brought to the Pilet API.
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.
Removes a search provider from the app shell. This requires a named search provider.
For authors of pilets
You can use the
registerSearchProvider function from the Pilet API to add a new search provider in the app shell.
Note: When the first argument is a string we call it a named search provider.
You can use the
unregisterSearchProvider function from the Pilet API to remove a previously added search provider from the app shell.
Note: You'll need to have added a named search provider in order to be able to remove it.
Setup and Bootstrapping
For Piral instance developers
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
The integration looks like:
Via the options the initially displayed
results can be defined. The current
query can also be set.
const instance =;
Piral is released using the MIT license. For more information see the license file.