Search result

Last updated on
31 May 2023

Properties:

  1. Type (type string). Common for all elements and defines the type of element.
  2. Settings (settings array). 1a. Field (field string). Required. The index field name that contains rendered search result to display 1b. No results message (no_results), optional. Text to display when there are no results. 1c. Loading message (loading), optional. Text to display while the results are loading.
  3. Weight (weight integer). The order of the element inside region.

Example object representation:

{
  "id": "84297c51-5482-4b88-9730-26b1868c00cd",
  "type": "search_result",
  "weight": "-6",
  "settings": {
    "field": "rendered_result",
    "no_results": "No results found.",
    "loading": "Loading..."
  }
}

Help improve this page

Page status: No known problems

You can: