Spell Check | Yext Hitchhikers Platform
Background
The SpellCheck
component helps correct a user’s spelling.
It is usually displayed above the results. It works on both universal search and vertical search and
is generally added directly above the VerticalResults
or DirectAnswer
.
Configuration
The component is named SpellCheck
. There are no additional required properties.
<div class="spell-check-container></div>
ANSWERS.addComponent("SpellCheck", {
container: ".spell-check-container",
// suggestionHelpText: "Are you sure you didn't mean: ",
});
Example
Spell Check API
Property | Type | Default | Description |
---|---|---|---|
suggestionHelpText
|
string
|
Did you mean
|
Did you mean text to displays before the query |
<% elem.innerText %>