Description of the Change

Applies a epAutosuggestItemHTMLFilter() function to autosuggest items to allow filtering the HTML of autosuggest results.

Alternate Designs

In this implementation the filter callback only receives the option object as the second argument, and the option index as the third argument. These can be used to reconstruct the original HTML, or a variation of it, if desired. This means that a custom filter would need to implement any required escaping, as well as highlighting.

An alternative approach could be to also pass the pre-processed escaped text and highlighted results text as arguments to the callback.

The appropriate approach would depend on how much hand holding we want to do.

Benefits

Developers can provide their own HTML for autosuggest result items.

Possible Drawbacks

The potential for autosuggest results to break if future changes are made to the HTML of results that are not reflected in the HTML that may have been applied by a filter.

Verification Process

• Check out this branch.
• Run npm run build.
• In a theme or plugin, define a window.epAutosuggestItemHTMLFilter() JavaScript function that returns some HTML.
• Start typing in a search field. The autosuggest results should use the HTML returned by our epAutosuggestItemHTMLFilter() function.

Checklist:

• I have read the CONTRIBUTING document.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my change.
• All new and existing tests passed.

Applicable Issues

#2143
#2128

Changelog Entry

Added the ability to filter the HTML of autosuggest results by defining a window.epAutosuggestItemHTMLFilter() function in JavaScript.