Add autosuggest filter to modify list container #2902
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the Change
Add support for 2 'filter' functions modifying Autosuggest suggestions:
epAutosuggestListItemsHTMLFilter
Filters the HTML that's added to the list when the suggestions are updated.epAutosuggestElementFilter
Filters the container element before it's added to the DOM.Documentation with examples is included for both, and documentation with an example is also included for the existing
epAutosuggestItemHTMLFilter
function (closes #2776).Closes #2811
How to test the Change
Implement the examples from the documentation updates and confirm that they work as expected.
Changelog Entry
Added - Autosuggest: filter the HTML of all results by defining a
window.epAutosuggestListItemsHTMLFilter()
function in JavaScript.Added - Autosuggest: filter the container element by defining a
window.epAutosuggestElementFilter()
function in JavaScript.Added - Documentation for Autosuggest JavaScript filters.
Credits
Props @JakePT
Checklist: