x

Search component config properties

Use this form to update Search Component properties and see on real time how you can customize it.
Be aware that clicking on APPLY button, will override initial configuration properties.

Before going further, please review SUI documentation How to Enable Search UI Component for Your Application


            
fusionApp

Fusion application name.

If this property is not provided, the application SPLKExt will be selected.


OAUTH Redirect URL

The Redirect Endpoint Back to SUI

If this value is not provided, then OAUTH2 access token retrieval is disabled


suiLanguage

Language used to display static text like labels or titles. Default values is en.

Available options: English, Deutsch, French, Japanese, Korean, Simplified Chinese, Traditional Chinese

searchLanguage

Language used to search results and suggestions.

Available options: English: en, Deutsch: de, Francais: fr, 日本語: ja, 한국어: ko, 简体中文: zh_cn and 繁體中文: zh_tw

areas

Datasources where search is performed. When this property is not provided (no area selected) by default any search will be performed against all areas.

Available areas: [ "main", "wiki", "docs", "blogs", "dev", "docs_observability", "community", "lantern", "support_kb_articles", "confluence", "conf" ]














resultClickTarget

Sets anchor target for each result. Default value is _blank.

Available options: _self or _blank

facets

Facets or categories where result are grouped. If this property is not defined, search component will show all facets available.

Available facets: source_name_s, docProduct_s, docProduct_s




enableSearchLanguage

Language used to filter results on each request.


trackUrlState

Enable or disable track URL state.


showResultURLTooltip

Show or hide results url tooltips.


enableQualtrics

Enabled/Disable Qualtrics Survey


enablePaginationControls

Show or hide pagination controls.


env

Target search api environment. This property must be defined.

Available envs: dev, qa, stg, prod

sortOptions

Sort results can be done in descendant (desc) or ascendent (asc) order. If this property is not defined, by default search component will use 3 available options.

Available options listed in JSON examples.



                


                


                
customTheme

String template with all css styles.

See full css reference here: defaultTheme.js



areasTabFilter

Predefined tabs used to filter by areas.

This will override areas property.



translationOverride

Override the existing translations with your own.

This will override languageTranslations property.



layoutTemplate

Modify application component layout.

Available options: supportResultsOnly and docsResultLayout

searchTerm

Search Term to be used.



settings
x

Search Bar component config properties

Use this form to update Search Bar Component properties and see on real time how you can customize it.
Be aware that clicking on APPLY button, will override initial configuration properties.

Before going further, please review Search Bar documentation How to Enable Search Bar Component UI for Your Application


            
searchBarRedirectUrl

Redirect URL


suiLanguage

Language used to display static text like labels or titles. Default values is en.

Available options: es and en

env

Target search api environment. This property must be defined.

Available envs: dev, qa, stg, prod

showSearchButton

Show or hide button


customTheme

String template with all css styles.

See full css reference here: defaultTheme.js



settings
SEARCH BAR
Search

Search bar

Examples of how to embed search bar component into a page. Config updates apply only to first search bar

  1. Center of a page.
  2. Hover within header.
  3. Click within header.
  4. Mobile: Placed inside drawer. Resize window to less than 992 px