Ui componentsCommon settings
Search
Customize search-related settings for the Inkeep widgets.
The search configuration provides settings for all search-related components, including search behavior, appearance, and functionality. These settings allow you to customize how users interact with the search interface, how results are displayed, and how the search behavior works.
Basic Configuration
Core Settings
Configure basic search behavior and appearance:
Option | Type | Default | Description |
---|---|---|---|
placeholder | string | 'Search anything...' (desktop), 'Search' (mobile) | Text shown in empty search input |
defaultQuery | string | '' | Initial search query on load |
maxResults | number | 40 | Maximum number of results to show |
debounceTimeMs | number | 0 | Milliseconds to wait before searching |
shouldOpenLinksInNewTab | boolean | false | Open results in new tab |
searchQueryParamKey | string | null | URL parameter for search query; gets appended to the URL when a result is clicked |
view | "single-pane" | "dual-pane" | "single-pane" | Whether to render the search results in a single list or a two pane view with a list of results on the left and a preview of the content on the right |
Search Tabs
Configure result categorization and organization:
Option | Type | Required | Description |
---|---|---|---|
tabs | (string | SearchTab)[] | No | Tabs to display in results |
The tabs feature supports several configuration patterns:
Default tabs if none provided:
All
Publications
PDFs
GitHub
Forums
Discord
Slack
StackOverflow
The tabs are displayed in the order they are provided in the
tabs
array.
Event Handling
Configure search event callbacks:
Option | Type | Required | Description |
---|---|---|---|
onQueryChange | (query: string) => void | No | Called when search query changes |