Modules

DruxtView

The DruxtView component renders Drupal Views using configuration and results provided by the Drupal View and the JSON:API Views module.

The component renders slots for the View's headers, footers, entity results, exposed sorts and filters, and supports contextual filters.

Typedefs

ComponentOptions : Array.<array>

Provides the available component naming options for the Druxt Wrapper.

ModuleSettings : object

Provides settings for the View module, via the nuxt.config.js druxt.views or the Wrapper component druxt object.

PropsData : object

Provides propsData for the DruxtWrapper.

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

Components : Array.<object>

The list of candidate Wrapper components, with naming parts and global registration state.

ComponentData : object

The Wrapper component and propsData to be rendered.

WrapperData : object

Druxt settings and registered props retrieved from the Wrapper component.

DruxtView

The DruxtView component renders Drupal Views using configuration and results provided by the Drupal View and the JSON:API Views module.

The component renders slots for the View's headers, footers, entity results, exposed sorts and filters, and supports contextual filters.

Example

<DruxtView display-id="block_1" view-id="promoted_items" />

Example (View with contextual filter)

<DruxtView
  :arguments="[entity.attributes.drupal_internal__nid]"
  display-id="block_1"
  view-id="articles_aside"
/>

Example (DruxtView Wrapper component boilerplate)

<template>
  <DruxtDebug :json="results" />
</template>

<script>
import { DruxtViewsViewMixin } from 'druxt-views'
export default {
  mixins: [DruxtViewsViewMixin]
}

Example (DruxtView with template injection)

<DruxtView>
  <template #default="{ results }">
    <!-- Do whatever you want here -->
    <DruxtDebug :json="results" />
  </template>
</DruxtView>

• DruxtView
  • instance
    • .getQuery(settings) ⇒ Query
    • .onFiltersUpdate()
  • static
    • .props
      • .arguments : array
      • .displayId : string
      • .settings : ModuleSettings
      • .type : string
      • .uuid : string
      • .viewId : string
      • .langcode
      • .v-model
      • .wrapper
      • .count : integer
      • .display : object
      • .mode : boolean | string
      • .pager : object
      • .results : Array.<object>
      • .view : object
    • .computed
      • .attachments_after : Array.<string>
      • .attachments_before : Array.<string>
      • .count : integer
      • .display : object
      • .filters : Array.<object>
      • .headers : Array.<object>
      • .mode : string
      • .pager : object
      • .results : Array.<object>
      • .showPager : boolean
      • .showSorts : boolean
      • .sorts : Array.<object>
    • .druxt
      • .template
      • .componentOptions(context) ⇒ ComponentOptions
      • .fetchConfig()
      • .fetchData(settings)
      • .propsData(vm) ⇒ PropsData
      • .settings(context, wrapperSettings) ⇒ object
      • .slots(h) ⇒ ScopedSlots
    • .data()
  • instance
    • .error(err, [context])
    • .getModuleComponents() ⇒ Components
    • .getModulePropsData(wrapperProps) ⇒ object
    • .getScopedSlots() ⇒ object
    • .getWrapperData(component) ⇒ WrapperData
  • static
    • .methods
    • .fetch()
    • .lang(vm) ⇒ string
    • .mixins : Array.<object>

.getQuery(settings) ⇒ Query

Builds the query for the JSON:API request.

Kind: instance method of DruxtView

.onFiltersUpdate()

Filters update event handler.

Kind: instance method of DruxtView

.props

Vue.js Properties.

Kind: static property of DruxtView

• .props
  • .arguments : array
  • .displayId : string
  • .settings : ModuleSettings
  • .type : string
  • .uuid : string
  • .viewId : string
  • .langcode
  • .v-model
  • .wrapper
  • .count : integer
  • .display : object
  • .mode : boolean | string
  • .pager : object
  • .results : Array.<object>
  • .view : object

.arguments : array

Views contextual filters.

Kind: static property of props
Default: []
Example

<DruxtView :arguments="[1, 2, 3]" display-id="block_1" view-id="articles_aside" />

.displayId : string

The View Display ID.

Kind: static property of props
Default: "default"
Example

<DruxtView display-id="page_1" view-id="frontpage" />

.settings : ModuleSettings

Module settings object.

Kind: static property of props
Default: {}

.type : string

JSON:API Resource type.

Kind: static property of props
Default: "view--view"

.uuid : string

The View UUID.

Kind: static property of props
Example

<DruxtView uuid="f6c38097-d534-4bfb-87d9-09526fe44e9c" />

.viewId : string

The View ID.

Kind: static property of props
Example

<DruxtView view-id="frontpage" />

.langcode

The resource langcode.

Kind: static property of props
Example

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

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

<DruxtView
  :wrapper="{
    component: 'BCard',
    class: 'article-card',
    propsData: { noBody: true }
  }"
/>

.count : integer

The JSON:API Views results total count.

Kind: static property of props

.display : object

The View display object.

Kind: static property of props

.mode : boolean | string

The Entity display mode.

Kind: static property of props

.pager : object

The View pager settings.

Kind: static property of props

.results : Array.<object>

The JSON:API Views results.

Kind: static property of props

.view : object

The JSON:API View resource.

Kind: static property of props

.computed

Kind: static property of DruxtView

• .computed
  • .attachments_after : Array.<string>
  • .attachments_before : Array.<string>
  • .count : integer
  • .display : object
  • .filters : Array.<object>
  • .headers : Array.<object>
  • .mode : string
  • .pager : object
  • .results : Array.<object>
  • .showPager : boolean
  • .showSorts : boolean
  • .sorts : Array.<object>

.attachments_after : Array.<string>

IDs of displays to be attached after the view.

Kind: static property of computed

.attachments_before : Array.<string>

IDs of displays to be attached before the view.

Kind: static property of computed

.count : integer

The total item count.

Kind: static property of computed

.display : object

The View Display object.

Kind: static property of computed

.filters : Array.<object>

Exposed filters.

Kind: static property of computed

.headers : Array.<object>

The View Headers data.

Kind: static property of computed

.mode : string

The View mode for the results entities.

Kind: static property of computed

.pager : object

The displays pager settings.

Kind: static property of computed

.results : Array.<object>

The JSON:API Views results.

Kind: static property of computed

.showPager : boolean

Whether a pager should be shown.

Kind: static property of computed

.showSorts : boolean

Whether Exposed sorts are available and should be displayed.

Kind: static property of computed

.sorts : Array.<object>

Exposed sorts.

Kind: static property of computed

.druxt

DruxtModule settings

Kind: static property of DruxtView

• .druxt
  • .template
  • .componentOptions(context) ⇒ ComponentOptions
  • .fetchConfig()
  • .fetchData(settings)
  • .propsData(vm) ⇒ PropsData
  • .settings(context, wrapperSettings) ⇒ object
  • .slots(h) ⇒ ScopedSlots

.template

Druxt development template tool configuration.

Kind: static property of druxt

.componentOptions(context) ⇒ ComponentOptions

Provides the available component naming options for the Druxt Wrapper.

Kind: static method of druxt

.fetchConfig()

Fetch View configuration resource.

Kind: static method of druxt

.fetchData(settings)

Fetch JSON:API Views results.

Kind: static method of druxt

.propsData(vm) ⇒ PropsData

Provides propsData for the DruxtWrapper.

Kind: static method of druxt

.settings(context, wrapperSettings) ⇒ object

Component settings.

Kind: static method of druxt
Returns: object - The merged module settings.

.slots(h) ⇒ ScopedSlots

Provides the scoped slots object for the Module render function.

• header
• filters
• sorts
• attachments_before
• results
• pager
• attachments_after
• default (all of the above)

Kind: static method of druxt
Returns: ScopedSlots - The Scoped slots object.

Example (DruxtViewViewId.vue)

<template>
  <div>
    <slot name="header" />
    <slot name="results" />
    <slot name="pager" />
  </div>
</template>

.data()

Kind: static method of DruxtView
Properties

.error(err, [context])

Sets the component to render a DruxtDebug error message.

Kind: instance method of DruxtView

.getModuleComponents() ⇒ Components

Get list of module wrapper components.

Kind: instance method of DruxtView

.getModulePropsData(wrapperProps) ⇒ object

Get module propsData via modules druxt.propsData() callback.

Kind: instance method of DruxtView

Example

{
  $attrs: { entity: {}, fields: {}, langcode: 'en', schema: {} },
  props: { value: {} },
  propsData: { entity: {}, fields: {}, langcode: 'en', schema: {}, value: {} },
}

.getScopedSlots() ⇒ object

Gets a Druxt modules scoped slots, and if there's no default slots, provides a develop mode debug default or passes through to a default template.

Kind: instance method of DruxtView

.getWrapperData(component) ⇒ WrapperData

Get wrapper component data.

Kind: instance method of DruxtView

.methods

Kind: static property of DruxtView

.fetch()

Loads the Druxt module data and applies a wrapper component as required.

Important: If your component has an existing fetch method, you must manually invoke the DruxtModule.fetch() hook.

Kind: static method of DruxtView
Example (Manually invoking DruxtModule.fetch().)

import DruxtModule from 'druxt/components/DruxtModule.vue'
export default {
  name: 'DruxtCustomModule',
  extends: DruxtModule,
  async fetch() {
    await DruxtModule.fetch.call(this)
  }
  druxt: {
    componentOptions: () => ([['Default']]),
    propsData: ({ model }) => ({ value: model }),
  }
}

.lang(vm) ⇒ string

The current language code: the langcode prop if set, otherwise the route's langcode metadata.

Used by Druxt modules to fetch the correct resource translation.

Kind: static method of DruxtView
Returns: string - The current language code.

.mixins : Array.<object>

Vue.js mixins.

Kind: static property of DruxtView
See: DruxtEntityContextMixin

ComponentOptions : Array.<array>

Provides the available component naming options for the Druxt Wrapper.

Kind: global typedef
Example

[
  'DruxtView[ViewId][DisplayId][Langcode]',
  'DruxtView[ViewId][DisplayId]',
  'DruxtView[ViewId][Langcode]',
  'DruxtView[ViewId]',
  'DruxtView[UUID][DisplayId][Langcode]',
  'DruxtView[UUID][DisplayId]',
  'DruxtView[UUID][Langcode]',
  'DruxtView[UUID]',
  'DruxtView[DisplayId][Langcode]',
  'DruxtView[DisplayId]',
]

Example (featured_articles (default))

[
  'DruxtViewFeaturedArticlesDefaultEn',
  'DruxtViewFeaturedArticlesDefault',
  'DruxtViewFeaturedArticlesEn',
  'DruxtViewFeaturedArticles',
  'DruxtView16f5d68e5bae4d7aa61c6b2bc3b6d3b6DefaultEn',
  'DruxtView16f5d68e5bae4d7aa61c6b2bc3b6d3b6Default',
  'DruxtView16f5d68e5bae4d7aa61c6b2bc3b6d3b6En',
  'DruxtView16f5d68e5bae4d7aa61c6b2bc3b6d3b6',
  'DruxtViewDefaultEn',
  'DruxtViewDefault',
]

ModuleSettings : object

Provides settings for the View module, via the nuxt.config.js druxt.views or the Wrapper component druxt object.

Kind: global typedef

Example (DruxtView Wrapper component)

<script>
export default {
  druxt: {
    query: {
      bypassCache: ({ $store }) => $store.$auth.loggedIn,
      bundleFilter: false,
      fields: [],
      resourceTypes: ['node--article'],
    },
  },
}

Example (DruxtView component with settings)

<template>
  <DruxtView
    display-id="block_1"
    view-id="promoted_items
    :settings="{
      query: {
        bypassCache: true,
        bundleFilter: false,
        fields: ['title']
        resourceTypes: [],
      }
    }"
  />
</template>

PropsData : object

Provides propsData for the DruxtWrapper.

Kind: global typedef

Example

{
  count: 8,
  display: {},
  mode: 'card',
  pager: {
    options: {},
    type: 'mini',
  },
  results: [],
  view: {},
}

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

Kind: global typedef

Example

{
  header: () => {},
  filters: () => {},
  sorts: () => {},
  attachments_before: () => {},
  results: () => {},
  pager: () => {},
  attachments_after: () => {},
  default: () => {},
}

Example (DruxtViewViewId.vue)

<template>
  <div>
    <slot name="header" />
    <slot name="results" />
    <slot name="pager" />
  </div>
</template>

Components : Array.<object>

The list of candidate Wrapper components, with naming parts and global registration state.

Kind: global typedef
Properties

Example

[{
  global: true,
  name: 'DruxtEntityNodeArticleDefault',
  parts: ['NodeArticle', 'Default'],
}]

ComponentData : object

The Wrapper component and propsData to be rendered.

Kind: global typedef
Properties

Example

{
  $attrs: { entity: {}, fields: {}, schema: {} },
  is: 'DruxtEntityNodeArticleDefault',
  options: [
    'DruxtEntityNodeArticleDefault',
    'DruxtEntityDefault',
  ],
  props: { value: {} },
  propsData: {
    entity: {},
    fields: {},
    schema: {},
    value: {},
  },
  settings: { query: {} },
}

WrapperData : object

Druxt settings and registered props retrieved from the Wrapper component.

Kind: global typedef
Properties

Example

{
  druxt: { query: { fields: ['path', 'title'] } },
  props: {
    value: {
      type: Object,
      default: () => ({}),
    }
  }
}