Modules

DruxtViewsPager

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

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.

DruxtViewsPager

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

• DruxtViewsPager
  • instance
    • .getQuery(link) ⇒ object
    • .getRoute(link) ⇒ object
    • .setPage(link)
  • static
    • .props
      • .count : integer
      • .options : object
      • .resource : object
      • .type : string
      • .value : integer
      • .langcode
      • .v-model
      • .wrapper
    • .methods
    • .druxt
      • .template
      • .componentOptions(context) ⇒ ComponentOptions
      • .propsData(context) ⇒ PropsData
      • .slots() ⇒ ScopedSlots

.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

.props

Kind: static property of DruxtViewsPager

• .props
  • .count : integer
  • .options : object
  • .resource : object
  • .type : string
  • .value : integer
  • .langcode
  • .v-model
  • .wrapper

.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

The resource langcode.

Kind: static property of props
Example

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

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

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

.methods

Kind: static property of DruxtViewsPager

.druxt

DruxtModule settings

Kind: static property of DruxtViewsPager

• .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.

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

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

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