autoComplete.js icon indicating copy to clipboard operation
autoComplete.js copied to clipboard

Seeming inconsistency in the documentation for resultItem.highlight

Open rhaver opened this issue 3 years ago • 1 comments

In the docs under "Usage" (this file) there are two examples given of the configuration of resultItem.highlight that both have the snippet:

resultItem: {
    highlight: {
        render: true
    }
}

But under "Configuration" (this file) for resultItem.highlight it is stated that its value can only be a boolean or a string, not an object. Isn't this inconsistent?

rhaver avatar Apr 28 '22 13:04 rhaver

Hello @rhaver,

Good catch! I have just updated the Usage file as it was outdated.

Here is the correct configuration.

highlight (optional)

Type: Boolean | String of class values Defaults: false Example:

resultItem: {
    highlight: true,
}

Cheers! :)

TarekRaafat avatar Apr 29 '22 07:04 TarekRaafat