Research
Security News
Malicious npm Package Typosquats react-login-page to Deploy Keylogger
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
piral-search
Advanced tools
Changelog
1.5.1 (March 11, 2024)
piral-cli
to "16.0.0"target
-specific navigation in piral-blazor
kras
to latest v0.16
release--type
flag to piral publish
commandReadme
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.
In many cases the frontend should provide an extensive search functionality. If this search can or should also work in context-sensitive ways (e.g., depending on which microfrontends are loaded different search options are used or available) then this plugin might be useful. It allows pilets to register search providers which can handle search queries.
We also have a video for this plugin:
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.
::: summary: For pilet authors
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.
Example use:
import { PiletApi } from '<name-of-piral-instance>';
import { MyTile } from './MyTile';
export function setup(piral: PiletApi) {
piral.registerSearchProvider(MyTile);
}
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.
Example use:
import { PiletApi } from '<name-of-piral-instance>';
import { MyTile } from './MyTile';
export function setup(piral: PiletApi) {
// register with a name
piral.registerSearchProvider('first', MyTile);
// and unregister; maybe some time later?
piral.unregisterSearchProvider('first');
}
:::
::: summary: 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 piral-search
package.
import { createSearchApi } from 'piral-search';
The integration looks like:
const instance = createInstance({
// important part
plugins: [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
plugins: [createSearchApi({
query: '!help',
results: [
<div>
Help was found!
</div>,
],
})],
// ...
});
:::
Piral is released using the MIT license. For more information see the license file.
FAQs
Unknown package
We found that piral-search demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.