Drupal Views components for Druxt with support for filters, pagination and sorting.

DruxtViewsPager

View source on GitHub

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

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(h) ⇒ ScopedSlots
- instance
  - .error(err, [context])
  - .getModuleComponents() ⇒ Components
  - .getModulePropsData(wrapperProps) ⇒ object
  - .getScopedSlots() ⇒ object
  - .getWrapperData(component) ⇒ WrapperData
- static
  - .data(vm)
  - .fetch()
  - .lang(vm) ⇒ string

.getQuery(link) ⇒ `object`

Get the query object from provided link.

Kind: instance method of DruxtViewsPager

Param	Type	Description
link	`string`	A url with querystring.

.getRoute(link) ⇒ `object`

Get a Route object from provided link.

Kind: instance method of DruxtViewsPager

Param	Type	Description
link	`string`	A url with querystring.

.setPage(link)

Set the model from provided link.

Kind: instance method of DruxtViewsPager

Param	Type	Description
link	`string`	A url with querystring.

.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: '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

Param	Type	Description
context	`object`	The module component ViewModel.
context.type	`string`	The Pager type.

.propsData(context) ⇒ `PropsData`

Provides propsData for the DruxtWrapper.

Kind: static method of druxt

Param	Type	Description
context	`object`	The module component ViewModel.
context.count	`boolean` \| `number`	The JSON:API Views results total count.
context.options	`object`	The Pager options.
context.resource	`object`	The JSON:API Views results resource.
context.type	`string`	The Pager type.
context.model	`number`	The DruxtViewsPager model value.

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

Param	Type	Description
h	`function`	The Vue createElement function.

.error(err, [context])

Sets the component to render a DruxtDebug error message.

Kind: instance method of DruxtViewsPager

Param	Type	Description
err	`object`	The error object.
[context]	`object`	Error context; carries the wrapper component data where the failure knows it.

.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

Param	Type	Description
wrapperProps	`object`	Props registered by the Wrapper component.

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

Param	Type	Description
component	`string`	The Wrapper component name.

.data(vm)

Kind: static method of DruxtViewsPager

Param	Type	Description
vm	`object`	The component ViewModel.
vm.value	`*`	The module component model value.

Properties

Name	Type	Description
component	`ComponentData`	The wrapper component and propsData to be rendered.
model	`*`	The module component model value.

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

Param	Type	Description
vm	`object`	The component ViewModel.
vm.langcode	`string`	The `langcode` prop.
vm.$route	`object`	The current route.

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

Param	Type	Description
count	`integer`	The JSON:API Views results total count.
options	`object`	The Pager options.
resource	`object`	The JSON:API Views results resource.
type	`string`	The Pager type.
value	`integer`	The DruxtViewPager model value.

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

Param	Type	Description
default	`function`	A JSON:API resource links based pager.

Components : `Array.<object>`

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

Kind: global typedef
Properties

Name	Type	Description
global	`boolean`	Component global registration state.
name	`string`	The component name.
parts	`Array.<string>`	The component naming parts.

Example

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

ComponentData : `object`

The Wrapper component and propsData to be rendered.

Kind: global typedef
Properties

Name	Type	Default	Description
$attrs	`object`		propsData not registered by the Wrapper component.
is	`string`	`"DruxtWrapper"`	The Wrapper component name.
options	`Array.<string>`		The Wrapper component options.
props	`object`		propsData registered by the Wrapper component.
propsData	`object`		The component propsData object.
settings	`object`		Druxt settings object provided by the Wrapper component.

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

Name	Type	Description
druxt	`object`	Druxt settings object for use by Druxt module.
props	`object`	Registered props oject.

Example

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