Improve this doc View source

pfFilterFields
directive in module patternfly.filters

Description

Directive for the filter bar's filter entry components

Usage

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

Parameters

ParamTypeDetails
configobject

configuration settings for the filters:

  • .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
    • .filterMultiselect - (Boolean) In complex-select, allow selection of multiple categories and values. Optional, default is false
    • .filterType - (String) The filter input field type (any html input type, or 'select' for a single select box or 'complex-select' for a category select box)
    • .filterValues - (Array) List of valid select values used when filterType is 'select' or 'complex-select' (in where these values serve as case insensitve keys for .filterCategories objects)
    • .filterCategories - (Array of (Objects)) For 'complex-select' only, array of objects whoes keys (case insensitive) match the .filterValues, these objects include each of the filter fields above (sans .placeholder)
    • .filterCategoriesPlaceholder - (String) Text to display in complex-select category value select when no filter value has been entered, Optional
    • .filterDelimiter - (String) Delimiter separating 'complex-select' category and value. Optional, default is a space, ' '
  • .appliedFilters - (Array) List of the currently applied filters