API Documentation

DruxtViewsSorts

views

Modules

DruxtViewsSorts

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

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.

DruxtViewsSorts

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

Example

<DruxtViewsSorts
  :options="{}"
  :sorts="[{}]"
  type="basic"
/>

.sortBy(sort) ⇒ object

Returns a merged Route object with the provided sort.

Kind: instance method of DruxtViewsSorts

ParamTypeDescription
sortstringThe sort ID.

.props

Kind: static property of DruxtViewsSorts


.options : object

The Exposed form options.

Kind: static property of props


.sorts : Array.<object>

The Exposed Sort objects.

Kind: static property of props


.type : string

The Exposed form type.

Kind: static property of props


.druxt

DruxtModule settings

Kind: static property of DruxtViewsSorts


.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 a list of sorts.

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

[
  'DruxtViewsSorts[Type]',
  'DruxtViewsSorts[Default]'
]

Example

[
  'DruxtViewsSortsBasic',
  'DruxtViewsSortsDefault'
]

PropsData : object

Provides propsData for the DruxtWrapper.

Kind: global typedef

ParamTypeDescription
optionsobjectThe Exposed form options.
sortsArray.<object>The Exposed Sort objects.
typestringThe Exposed form type.
valueintegerThe DruxtViewSorts model value.

Example

{
  options: {
    expose_sort_order: true,
    expose_sorts_label: 'Sort by',
    reset_button: false,
    ...
  },
  sorts: [{
    admin_label: '',
    expose: {},
    exposed: true,
    ...
  }],
  type: 'basic',
  value: undefined,
}

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

Kind: global typedef

ParamTypeDescription
defaultfunctionA list of sort links.