JavaScript Functions | Filters Add-on | Docs

The following JavaScript functions are available when using the Filters add-on:

The almfilters.start(target) function will initiate an Ajax Load More filter instance.

target: The unique filter ID (optional).

almfilters.start( 'categories' );

JavaScript

Note: start() is useful if filters have been loaded via Ajax or another client-side render method.

The almfilters.reset() function will clear and reset an entire Ajax Load More filter instance.

let clearBtn = document.getElementById('clear-filters');
clearBtn.addEventListener('click', function(e){
   almfilters.reset();
});

JavaScript

The resetFilter() function will clear and reset a specific filter group.

window.almFiltersChange = function(){
   var filter = document.querySelector('.alm-filter[data-key=search]');
   almfilters.resetFilter(filter);
}

JavaScript

Note: resetFilter() is useful when you want to clear a specific filter while performing another task.

The almfilters.getActiveFilters() function will parse the current URL querystring and return an object containing all the currently active filters.

const filters = almfilters.getActiveFilters();
if(filters){
   console.log(filters);
   // Do something with the object results.
}

JavaScript