API Documentation

DruxtViewsPager

views

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.


Get the query object from provided link.

Kind: instance method of DruxtViewsPager

ParamTypeDescription
linkstringA url with querystring.

Get a Route object from provided link.

Kind: instance method of DruxtViewsPager

ParamTypeDescription
linkstringA url with querystring.

Set the model from provided link.

Kind: instance method of DruxtViewsPager

ParamTypeDescription
linkstringA url with querystring.

.props

Kind: static property of DruxtViewsPager


.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


.methods

Kind: static property of DruxtViewsPager


.druxt

DruxtModule settings

Kind: static property of DruxtViewsPager


.componentOptions(context) ⇒ ComponentOptions

Provides the available component naming options for the DruxtWrapper.

Kind: static method of druxt

ParamTypeDescription
contextobjectThe module component ViewModel.

.propsData(context) ⇒ PropsData

Provides propsData for the DruxtWrapper.

Kind: static method of druxt

ParamTypeDescription
contextobjectThe module component ViewModel.

.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]',
  'DruxtViewsPager[Default]'
]

Example

[
  'DruxtViewsPagerFull',
  'DruxtViewsPagerDefault'
]

PropsData : object

Provides propsData for the DruxtWrapper.

Kind: global typedef

ParamTypeDescription
countintegerThe JSON:API Views results total count.
optionsobjectThe Pager options.
resourceobjectThe JSON:API Views results resource.
typestringThe Pager type.
valueintegerThe 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

ParamTypeDescription
defaultfunctionA JSON:API resource links based pager.