Modules

DruxtViewsFilters

Used by the DruxtView component to render a collection of Druxt Wrapper themeable filters.

Typedefs

ComponentOptions : Array.<array>

Provides the available component naming options for the Druxt Wrapper.

PropsData : object

Provides propsData for the DruxtWrapper.

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

DruxtViewsFilters

Used by the DruxtView component to render a collection of Druxt Wrapper themeable filters.

• DruxtViewsFilters
  • .props
    • .filters : Array.<object>
    • .options : object
    • .type : string
    • .value : object
    • .langcode
    • .v-model
    • .wrapper
  • .druxt
    • .template
    • .componentOptions(context) ⇒ ComponentOptions
    • .propsData(context) ⇒ PropsData
    • .slots() ⇒ ScopedSlots

.props

Kind: static property of DruxtViewsFilters

• .props
  • .filters : Array.<object>
  • .options : object
  • .type : string
  • .value : object
  • .langcode
  • .v-model
  • .wrapper

.filters : Array.<object>

The Exposed Filter objects.

Kind: static property of props

.options : object

The Exposed form options.

Kind: static property of props

.type : string

The Exposed form type.

Kind: static property of props

.value : object

The DruxtViewFilters model value.

Kind: static property of props

.langcode

The resource langcode.

Kind: static property of props
Example

<DruxtViewsFilters 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

<DruxtViewsFilters 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

<DruxtViewsFilters
  :wrapper="{
    component: 'MyWrapper',
    class: 'wrapper',
    propsData: { foo: 'bar' }
  }"
/>

.druxt

DruxtModule settings

Kind: static property of DruxtViewsFilters

• .druxt
  • .template
  • .componentOptions(context) ⇒ ComponentOptions
  • .propsData(context) ⇒ PropsData
  • .slots() ⇒ ScopedSlots

.template

Druxt development template tool configuration.

Kind: static property of druxt

.componentOptions(context) ⇒ ComponentOptions

Provides the available component naming options for the DruxtWrapper.

Kind: static method of druxt

.propsData(context) ⇒ PropsData

Provides propsData for the DruxtWrapper.

Kind: static method of druxt

.slots() ⇒ ScopedSlots

Provides the scoped slots object for the Module render function.

A scoped slot is provided for each filter.

The default slot will render all filters.

Kind: static method of druxt
Returns: ScopedSlots - The Scoped slots object.
Example (DruxtViewsFiltersType.vue)

<template>
  <div>
    <slot name="nid" />
  </div>
</template>

ComponentOptions : Array.<array>

Provides the available component naming options for the Druxt Wrapper.

Kind: global typedef
Example

[
  'DruxtViewsFilters[Type][Langcode]',
  'DruxtViewsFilters[Type]',
  'DruxtViewsFilters[Default][Langcode]'
  'DruxtViewsFilters[Default]'
]

Example

[
  'DruxtViewsFiltersBasicEn',
  'DruxtViewsFiltersBasic',
  'DruxtViewsFiltersDefaultEn'
  'DruxtViewsFiltersDefault'
]

PropsData : object

Provides propsData for the DruxtWrapper.

Kind: global typedef

Example

{
  filters: [{
    admin_label: '',
    expose: {},
    exposed: true,
    ...
  }],
  options: {
    expose_sort_order: true,
    exposed_sorts_label: 'Sort by',
    reset_button: false,
    ...
  },
  type: 'basic',
  value: undefined,
}

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

Kind: global typedef

Example (DruxtViewsFiltersType.vue)

<template>
  <div v-if="default">
    <slot />
  </div>

  <div v-else>
    <slot name="type" />
  </div>
</template>