Skip to main content

Custom attributes

Search Configuration(s)​

Define which search configurations are used to get search results. Pass their Static ID which you can find at the top of the search configuration details page. You can configure one or multiple ones seperated by new lines.

Examples

One:

customers

Two:

customers
leads

Mode​

  • Item Mode: Displays only a search box.
  • Spotlight Mode: Displays a button. When clicked, a pop-up appears showing the search input and results.
  • Responsive Mode: For small screens and touch devices, spotlight mode is enabled below a configurable breakpoint. Beyond that, item mode is used. (Spotlight mode is more user-friendly for small and touch devices)

Read more about the differences on the customization page.

Responsive Breakpoint​

Width in pixels, which will be used as the responsive breakpoint. Below it, the spotlight mode is used; otherwise, the item mode.

Result template mode​

  • Default: Use the default template that fits to any theme. You can adjust which positions will be displayed in the results.
  • Custom: Use your own HTML template. You can use APEX template syntax. More information is in the documentation.
  • Search configuration: Use the template defined in the results search configuration. Will fall back to the default template when none is defined.

Template Options​

Only available when the Result template mode is set to Default.

Customize which of the placeholders from the search configuration should be displayed. The title is always displayed.

Options:

  • Icon
  • Subtitle
  • Description
  • Custom01
  • Custom02
  • Custom03
  • Last last_modified
  • Badge
  • Score

Custom Template​

Only available when the Result template mode is set to Custom.

Use your own HTML template to use for the search results. You can use APEX template syntax. Find examples and more info about it in the documentation: https://www.united-codes.com/products/plug-ins-pro/docs/searchbox-pro/customization#custom-template

Add search keyboard shortcut​

If enabled, the search can be triggered by the key combination Ctrl + K or Cmd + K on macOS. This is a common key combination for searches on websites.

Show keyboard shortcut combination​

If enabled, a visual guidance will be added to show that users can use the key combination to trigger a search.

Hide Label​

If enabled, the APEX item label will not be displayed. You can still set a placeholder value.

Max Results​

Limit the maximum number of results displayed in the search results.

No extra header height​

Adding an item to the header may increase its overall height due to added spacing. Enable this setting to prevent extra spacing and maintain the original header height.

Redirect to search results page​

If set to Yes, the user will be redirected to the search results page when pressing enter inside the search input item.

You can define the search results page by choosing a page number from the list of available pages. Also set the item name of both the destination page and the search input item. We recommend also setting clear cache to the destination page.