DruxtViewsPager

DruxtViewsPager

Used by the DruxtView component to render a Druxt Wrapper themeable pager.

• DruxtViewsPager
  • instance
    • .getQuery(link) ⇒ object
    • .getRoute(link) ⇒ object
    • .setPage(link)
    • .error(err, [context])
    • .getModuleComponents() ⇒ Components
    • .getModulePropsData(wrapperProps) ⇒ object
    • .getScopedSlots() ⇒ object
    • .getWrapperData(component) ⇒ WrapperData
  • static
    • .props
      • .count : integer
      • .options : object
      • .resource : object
      • .type : string
      • .value : integer
      • .langcode : string
      • .v-model : mixed
      • .wrapper : (boolean | object)
    • .methods
    • .druxt
      • .template
      • .componentOptions(context) ⇒ ComponentOptions
      • .propsData(context) ⇒ PropsData
      • .slots(h) ⇒ ScopedSlots
    • .data(vm)
    • .fetch()
    • .lang(vm) ⇒ string

.getQuery(link) ⇒ object

Get the query object from provided link.

Kind: instance method of DruxtViewsPager

.getRoute(link) ⇒ object

Get a Route object from provided link.

Kind: instance method of DruxtViewsPager

.setPage(link)

Set the model from provided link.

Kind: instance method of DruxtViewsPager

.error(err, [context])

Sets the component to render a DruxtDebug error message.

Kind: instance method of DruxtViewsPager

.getModuleComponents() ⇒ Components

Get list of module wrapper components.

Kind: instance method of DruxtViewsPager

.getModulePropsData(wrapperProps) ⇒ object

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

Kind: instance method of DruxtViewsPager

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 DruxtViewsPager

.getWrapperData(component) ⇒ WrapperData

Get wrapper component data.

Kind: instance method of DruxtViewsPager

.props

Kind: static property of DruxtViewsPager

• .props
  • .count : integer
  • .options : object
  • .resource : object
  • .type : string
  • .value : integer
  • .langcode : string
  • .v-model : mixed
  • .wrapper : (boolean | object)

.count : integer

The JSON:API Views results total count.

Kind: static property of props

.options : object

The Pager options.

Kind: static property of props

.resource : object

The JSON:API Views results resource.

Kind: static property of props

.type : string

The Pager type.

Kind: static property of props

.value : integer

The DruxtViewPager model value.

Kind: static property of props

.langcode : string

The resource langcode.

Kind: static property of props
Example

@lang vue
<DruxtViewsPager langcode="en" />

.v-model : mixed

The Vue.js v-model binding for the module.

Setting a value provides the module data directly, so the Drupal JSON:API fetch is skipped.

Kind: static property of props
Default:
Example

@lang vue
<template>
  <DruxtViewsPager v-model="model" />
</template>

<script>
export default {
  data: () => ({ model: { foo: 'bar' } })
}
</script>

.wrapper : (boolean | object)

The wrapper component configuration.

Used to set the wrapper component, class, style and propsData.

Kind: static property of props
Default: () => undefined
Example

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

.methods

Kind: static property of DruxtViewsPager

.druxt

DruxtModule settings

Kind: static property of DruxtViewsPager

• .druxt
  • .template
  • .componentOptions(context) ⇒ ComponentOptions
  • .propsData(context) ⇒ PropsData
  • .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 DruxtWrapper.

Kind: static method of druxt

.propsData(context) ⇒ PropsData

Provides propsData for the DruxtWrapper.

Kind: static method of druxt

.slots(h) ⇒ ScopedSlots

Provides the scoped slots object for the Module render function.

The default slot will render basic pagination based on the JSON:API links.

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

.data(vm)

Kind: static method of DruxtViewsPager

Properties

.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 DruxtViewsPager
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 DruxtViewsPager
Returns: string - The current language code.

ComponentOptions : Array.<array>

Provides the available component naming options for the Druxt Wrapper.

Kind: global typedef
Example

[
  'DruxtViewsPager[Type][Langcode]',
  'DruxtViewsPager[Type]',
  'DruxtViewsPager[Default][Langcode]',
  'DruxtViewsPager[Default]'
]

Example

[
  'DruxtViewsPagerFullEn',
  'DruxtViewsPagerFull',
  'DruxtViewsPagerDefaultEn',
  'DruxtViewsPagerDefault'
]

PropsData : object

Provides propsData for the DruxtWrapper.

Kind: global typedef

Example

{
  count: 20,
  options: {
    expose: {},
    id: 0,
    items_per_page: 10,
    ...
  },
  resource: {
    data: [],
    jsonapi: {},
    links: {},
    meta: {},
  },
  type: 'full',
  value: 0,
}

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

Kind: global typedef

Inherited type definitions

Inherited from DruxtModule: ComponentData, Components, WrapperData.