API Documentation

DruxtViewsFilter

views

Modules

DruxtViewsFilter

Used by the DruxtView component to render individual Druxt Wrapper themeable filter components.

Typedefs

ComponentOptions : Array.<array>

Provides the available component naming options for the Druxt Wrapper.

PropsData : object

Provides propsData for the DruxtWrapper.

DruxtViewsFilter

Used by the DruxtView component to render individual Druxt Wrapper themeable filter components.


.props

Kind: static property of DruxtViewsFilter


.filter : object

The Exposed Filter objects.

Kind: static property of props


.druxt

DruxtModule settings

Kind: static property of DruxtViewsFilter


.componentOptions(context) ⇒ ComponentOptions

Provides the available component naming options for the DruxtWrapper.

Kind: static method of druxt

ParamTypeDescription
contextobjectThe module component ViewModel.

.propsData(context) ⇒ PropsData

Provides propsData for the DruxtWrapper.

Kind: static method of druxt

ParamTypeDescription
contextobjectThe module component ViewModel.

ComponentOptions : Array.<array>

Provides the available component naming options for the Druxt Wrapper.

Kind: global typedef
Example

[
  'DruxtViewsFilter[FilterId]',
  'DruxtViewsFilter[PluginId][FilterId]',
  'DruxtViewsFilter[Default]'
]

Example

[
  'DruxtViewsFilterTaxonomyIndexTidTypeTargetId',
  'DruxtViewsFilterTypeTargetId',
  'DruxtViewsFilterTaxonomyIndexTid',
  'DruxtViewsFilterDefault',
]

PropsData : object

Provides propsData for the DruxtWrapper.

Kind: global typedef

ParamTypeDescription
filterobjectThe Exposed Filter objects.
value*The DruxtViewFilter model value.

Example

{
  filter: {
    admin_label: '',
    error_message: true,
    expose: {},
    exposed: true,
    field: 'type_target_id',
    ...
  },
  value: undefined,
}