search-usage
When to use
- Site search page — dedicated search page with large input, filters, and full results.
- Section search — scoped search within a specific content area (blog, docs, products).
- Knowledge base — help center or documentation search with category filters.
- Resource finder — search through downloadable resources or tools.
Key decisions
- Scope: search-scope-all for site-wide, search-scope-section to limit to current area.
- Autocomplete: Enable for better UX on sites with large content volumes.
- Filters: Enable for categorized content. Disable for simple search needs.
- Results style: search-results-list for text-heavy results, search-results-grid for visual content.
search-options
All authoring options
Content
searchPlaceholder: placeholder text
searchLabel: accessible label
searchNoResults: richtext no-results message
Behavior
classes_searchScope: search-scope-all | search-scope-section | search-scope-custom
classes_searchAutoComplete: boolean
classes_searchFilters: boolean
classes_searchResultsStyle: search-results-list | search-results-grid
Appearance
classes_searchStyle: search-style-default | search-style-large | search-style-minimal
Analytics
trackInview: boolean
trackInview_meta: text
trackClick: boolean
trackClick_meta: text