Loading...

RECOMMENDATION: If you are using a version of The Portal Connector higher than 4.0, we strongly recommend utilizing the MVC based widgets and components to create your site. This documentation is for legacy purposes only and will soon be deprecated.

Product Filters

API
Widget Type:
Page Widgets
TPC Version:
  • 6.2
product-filters

Having the Product Filters widget on a page allows frontend users to apply client-side filtering on the Product List.  

Graphical user interface, text, application Description automatically generated


To configure the widget, drag and drop the Product Filters widget into your page body and click the edit. This should open the widget designer and show the Basic tab view.

Configuration

Basic  

In the Basic tab, backend users can specific which Product List they want to allow frontend users to filter, should there be more than one Product List on the page (e.g., a Product List with featured items across the top and another Product List of all the rest of the items). In addition, backend users can apply a prearranged filter on the Product List based on Product Family or Subject. Should they not do this, then all Products will display in the frontend until a frontend user selects a specific filter on the page.

Graphical user interface, text, application, email Description automatically generated

Widget Properties

Basic Properties

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

API

get_type()

Returns the type of widget it is. Can be used in conjunction with findAll() e.g., tpc.findAll()[0].get_type().

Returns

String

show()

Shows the widget on the form.

Returns

None

get_model()

Returns the configuration information of the widget.

Returns

Object

hide()

Hides the widget from the form.

Returns

None

get_container()

Returns the div container of the widget.

Returns

jQuery Object

get_productFiltersClearContainer()

Returns container for Clear All button.

Returns

jQuery Object

toggle()

Toggles the visibility of the widget.

Returns

None

get_productFamilyFilters()

Returns details about Product family filters.

Returns

Object

get_productTypeFilters()

Returns details about Product type filters.

Returns

Object

Full API With Examples

How to's

Related examples of Product Filters Configuration