API Reference / API Parameters / highlightPreTag

Nov. 25, 2021

highlightPreTag

Type: string

Engine default: "<em>"

Parameter syntax

'highlightPreTag' => 'opening_tag'

highlightPreTag: 'opening_tag'

highlightPreTag: 'opening_tag'

'highlightPreTag': 'opening_tag'

highlightPreTag: "opening_tag"

highlightPreTag: String = "opening_tag"

IndexSettings settings = new IndexSettings()
settings.HighlightPreTag = "opening_tag";

.setHighlightPreTag("opening_tag")

opt.HighlightPreTag("opening_tag")

highlightPreTag = Some("opening_tag")

Can be used in these methods:
search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, setSettings, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

The HTML string to insert before the highlighted parts in all highlight and snippet results.

Usage notes

highlightPreTag needs to be used along with highlightPostTag
If you specify an empty string, the engine will use the default <em> tag instead
To turn off highlighting, remove the searchable attribute with the attributesToHighlight parameter

Examples

Set default highlight pre tag

Copy

1
2
3
$index->setSettings([
  'highlightPreTag' => '<em>'
]);

1
2
3
4
5
6
7
8
let settings = Settings()
  .set(\.highlightPreTag, to: "<em>")

index.setSettings(settings) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Override default highlight pre tag for the current search

Copy

1
2
3
$results = $index->search('query', [
  'highlightPreTag' => '<strong>'
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.highlightPreTag, to: "<strong>")

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Did you find this page helpful?