Component description
The search component adds a search bar to your dashboard allowing you to look up keywords within a specific data set (e.g., API cards).
Example
Minimal JSON
{
"type": "search",
"searchFormKey": "",
"targetDataComponentId": ""
}{
"componentId": "market.centerArea.search",
"type": "search",
"title": "title.template.object.market",
"placeholder": "template.object.market.placeholder",
"searchFormKey": "form_market",
"targetDataComponentId": "market.centerArea.api-card.target"
}Nested properties
| Property | Description | Values | Mandatory |
|---|---|---|---|
type | search | string | Yes |
searchFormKey | Key of the search form with configured facets and pre-set filters. | string | Yes |
targetDataComponentId | ID of the target component (e.g., an API card) which will receive search or filter data. | string | Yes |
componentId | Unique ID of a component. If left empty, a random string will be generated. Primarily used in patch packages to define the component's position within the layout (template). | string | No |
title | Translation key of the title. Define the key in translations to specify how the text is displayed in the UI. Unlike the name property, if you use a specific string of text for the title, this text will appear with the package key. For example, Comment Section will be displayed as package_key_comment section. | string | No |
placeholder | Placeholder text in the search box. | string | No |