Improve this doc View source

pfFilterResults
directive in module patternfly.filters

Description

Component for the filter results

Usage

as element:
<pf-filter-results
       config="{object}">
</pf-filter-results>

Parameters

ParamTypeDetails
configobject

configuration settings for the filter results:

  • .fields - (Array) List of filterable fields containing:
    • .id - (String) Optional unique Id for the filter field, useful for comparisons
    • .title - (String) The title to display for the filter field
    • .placeholder - (String) Text to display when no filter value has been entered
    • .filterType - (String) The filter input field type (any html input type, or 'select' for a select box)
    • .filterValues - (Array) List of valid select values used when filterType is 'select'
  • .appliedFilters - (Array) List of the currently applied filters
  • .resultsCount - (int) The number of results returned after the current applied filters have been applied
  • .selectedCount - (int) The number selected items, The 'n' in the label: 'n' of 'm' selected
  • .totalCount - (int) The total number of items before any filters have been applied. The 'm' in the label: 'n' of 'm' selected
  • .showTotalCountResults - (Boolean) Optional, flag to show the total count in the filter results (ie. x of y Results)
  • .itemsLabel - (String) Optional label to use for the items (default: Result)
  • .itemsLabelPlural - (String) Optional label to use for the items when plural (default: Results)
  • .onFilterChange - ( function(array of filters) ) Function to call when the applied filters list changes