API Documentation
DruxtViewsFilter
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
object
.filter : The Exposed Filter objects.
Kind: static property of props
.langcode
The resource langcode.
Kind: static property of props
Example
<DruxtViewsFilter langcode="en" />
.v-model
The module component model value.
Used to bypass the Drupal JSON:API fetch, setting the module data directly.
Kind: static property of props
Example
<DruxtViewsFilter v-model="{ foo: bar }" />
.wrapper
The wrapper component configuration.
Used to set the wrapper component, class, style and propsData.
Kind: static property of props
Example
<DruxtViewsFilter
:wrapper="{
component: 'MyWrapper',
class: 'wrapper',
propsData: { foo: 'bar' }
}"
/>
.druxt
DruxtModule settings
Kind: static property of DruxtViewsFilter
.template
Druxt development template tool configuration.
Kind: static property of druxt
ComponentOptions
.componentOptions(context) ⇒ Provides the available component naming options for the DruxtWrapper.
Kind: static method of druxt
Param | Type | Description |
---|---|---|
context | object | The module component ViewModel. |
PropsData
.propsData(context) ⇒ Provides propsData for the DruxtWrapper.
Kind: static method of druxt
Param | Type | Description |
---|---|---|
context | object | The module component ViewModel. |
Array.<array>
ComponentOptions : Provides the available component naming options for the Druxt Wrapper.
Kind: global typedef
Example
[
'DruxtViewsFilter[FilterId][Langcode]',
'DruxtViewsFilter[FilterId]',
'DruxtViewsFilter[PluginId][FilterId][Langcode]',
'DruxtViewsFilter[PluginId][FilterId]',
'DruxtViewsFilter[PluginId][Langcode]',
'DruxtViewsFilter[PluginId]',
'DruxtViewsFilter[Default][Langcode]'
'DruxtViewsFilter[Default]'
]
Example
[
'DruxtViewsFilterTaxonomyIndexTidTypeTargetIdEn',
'DruxtViewsFilterTaxonomyIndexTidTypeTargetId',
'DruxtViewsFilterTypeTargetIdEn',
'DruxtViewsFilterTypeTargetId',
'DruxtViewsFilterTaxonomyIndexTidEn',
'DruxtViewsFilterTaxonomyIndexTid',
'DruxtViewsFilterDefaultEn',
'DruxtViewsFilterDefault',
]
object
PropsData : Provides propsData for the DruxtWrapper.
Kind: global typedef
Param | Type | Description |
---|---|---|
filter | object | The Exposed Filter objects. |
value | * | The DruxtViewFilter model value. |
Example
{
filter: {
admin_label: '',
error_message: true,
expose: {},
exposed: true,
field: 'type_target_id',
...
},
value: undefined,
}