API Documentation

Druxt

druxt

Druxt

Utility component for rendering Druxt modules.

Example

<Druxt
  :module="module"
  :props-data="propsData"
  :wrapper="{
    component,
    propsData: {}
  }"
/>

.setModuleComponent()

Sets the module component and propsData.

Kind: instance method of Druxt


.props

Vue.js Props.

Kind: static property of Druxt


.inner : object

Inner element.

Kind: static property of props
Default: { component: 'div', propsData: {} }


.module : string

The DruxtJS module to render.

Kind: static property of props
Example (Using the DruxtJS Site module.)

<Druxt module="site" />

.propsData : object

Props data to bind to the specified DruxtJS module.

Kind: static property of props
Example (Using the DruxtJS Entity module to render a 'node--article' resource.)

<Druxt
  module="entity"
  :props-data="{
    mode: 'teaser',
    type: 'node--article',
    uuid
  }"
/>

.value : Array | Boolean | Date | Number | Object | String

The module value.

Kind: static property of props
Model:


.wrapper : object

Wrapper element.

Kind: static property of props
Default: { component: 'div', propsData: {} }


.data()

Vue.js Data object.

Kind: static method of Druxt
Properties

NameTypeDescription
componentsobjectsThe module and wrapper components settinsg.
modelobjectThe model object.