Documentation

Filtering Collections on a Page

To improve the experience for Users viewing Collections on your Site, you can add Page Fragments to filter content in those Collections. For example, you can add a Fragment that can be used to search for and filter displayed Collections content using keywords.

There are two Page Fragments you can add to your pages to help Users filter content in displayed Collections: the Collection Filter Fragment and the Applied Filters Fragment.

Using the Collection Filter Fragment

The Collection Filter Fragment is used to filter the content displayed in a chosen Collection on the page. Users can either search for keywords or select categories to filter the Collection associated with the filter Fragment.

Follow these steps to add and configure a Collection Filter Fragment to a page (that is already displaying a Collection in a Collection Display Fragment):

  1. While editing the page, add a Collection Filter Fragment anywhere on the page.

  2. In the Fragment’s General configuration, select the desired Collection. The Collection must be displayed in Collection Display Fragments on the page for it to have an effect.

    Configure the Fragment to use a Collection that is already displayed in a Collection Display Fragment.

    The Filter drop-down menu appears when you have selected a compatible Collection.

  3. Use the Filter menu to choose a type of filter for the Fragment, Keywords or Category.

    Note

    If any modules have been deployed adding custom Collection filters (by implementing the FragmentCollectionFilter and InfoFilter interfaces), then you can also choose these filters from the list.

    If you choose the Keywords filter type, then Users can search for any keyword to filter the Collection by. If you choose the Category filter type, then the Source input field appears to configure the selection of categories Users can choose from.

  4. If you chose the Category filter type, then click on the Source input field, and use the popup dialog to choose the source of categories for Users to choose from.

    Select the vocabulary or category that contains the desired category selection.

  5. Click Select This Level when you have selected the vocabulary or parent category containing the desired categories to choose from.

  6. Publish the page.

The Collection Filter Fragment’s behavior changes depending on whether you configured the Keywords or Category filter type.

If you chose the Keywords type, then the Collection Filter Fragment appears as a search bar. Users can enter keywords to filter Collections displayed on the page to content containing those keywords.

The Keywords filter type presents a search bar to Users to enter keywords to filter by.

If you chose the Category type, then the Fragment appears as a menu listing all of the categories that can be chosen. Users can select any number of these categories and apply them to filter Collections to content with those categories.

The Category filter type presents a list of categories for Users to enable and apply as a filter.

Using the Applied Filters Fragment

The Applied Filters Fragment is used to see a list of filters applied with the Collection Filter Fragment.

Follow these steps to add an Applied Filters Fragment to a page (that already has a configured Collection Filter Fragment):

  1. While editing the page, add an Applied Filter Fragment anywhere on the page.

  2. In the Applied Filter Fragment’s General configuration, select the desired Collection. The same Collection must be both displayed on the page and configured with a Collection Filter Fragment.

  3. Publish the page.

Now, when the User filters content with the Collection Filter Fragment, the Applied Filters Fragment shows a list of the filters currently applying to the configured Collection. Users can also click the X button on each filter listed to remove the filter.

The Applied Filters Fragment shows all filters currently applied to the configured Collection.

Additional Information