Modules

DruxtBlock

The DruxtBlock component is used to render a Drupal Block by UUID or Drupal's internal ID.

While the DruxtBlock component can't automatically render every Drupal block, it does provide the Block settings to a targeted Druxt wrapper component for manual theming.

Typedefs

ComponentOptions : Array.<array>

Provides the available naming options for the Wrapper component.

ModuleSettings : object

Provides settings for the Blocks module, via the nuxt.config.js druxt.blocks object.

PropsData : object

Provides propsData for use in the Wrapper component.

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.

DruxtBlock

The DruxtBlock component is used to render a Drupal Block by UUID or Drupal's internal ID.

While the DruxtBlock component can't automatically render every Drupal block, it does provide the Block settings to a targeted Druxt wrapper component for manual theming.

Example (Render a block using id)

<DruxtBlock id="umami_branding" />

Example (Render a block using uuid)

<DruxtBlock uuid="59104acd-88e1-43c3-bd5f-35800f206394" />

Example (DruxtBlock Wrapper component boilerplate)

<template>
  <DruxtDebug :json="block" />
</template>

<script>
import { DruxtBlocksBlockMixin } from 'druxt-blocks'
export default {
  mixins: [DruxtBlocksBlockMixin]
}

Example (DruxtBlock with template injection)

<DruxtBlock id="umami_branding">
  <template #default="{ block }">
    <!-- Do whatever you want here -->
    <DruxtDebug :json="block" />
  </template>
</DruxtBlock>

• DruxtBlock
  • static
    • .props
      • .id : string
      • .uuid : string
      • .langcode
      • .v-model
      • .wrapper
      • .block : object
    • .computed
      • .block ⇒ object
      • .settings() : object
    • .druxt
      • .template
      • .componentOptions(context) ⇒ ComponentOptions
      • .fetchConfig()
      • .propsData(context) ⇒ PropsData
      • .slots(h) ⇒ ScopedSlots
    • .data()
  • instance
    • .error(err, [context])
    • .getModuleComponents() ⇒ Components
    • .getModulePropsData(wrapperProps) ⇒ object
    • .getScopedSlots() ⇒ object
    • .getWrapperData(component) ⇒ WrapperData
  • static
    • .methods
    • .fetch()
    • .lang(vm) ⇒ string

.props

The DruxtBlock component requires either the UUID or internal ID property.

Kind: static property of DruxtBlock

• .props
  • .id : string
  • .uuid : string
  • .langcode
  • .v-model
  • .wrapper
  • .block : object

.id : string

The Blocks internal ID.

Kind: static property of props
Example

<DruxtBlock id="umami_branding" />

.uuid : string

The Block Entity UUID.

If used, the id prop will be ignored.

Kind: static property of props
Example

<DruxtBlock uuid="59104acd-88e1-43c3-bd5f-35800f206394" />

.langcode

The resource langcode.

Kind: static property of props
Example

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

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

<DruxtBlock
  :wrapper="{
    component: 'BCard',
    class: 'article-card',
    propsData: { noBody: true }
  }"
/>

.block : object

The Block JSON:API resource.

Kind: static property of props

.computed

Kind: static property of DruxtBlock

• .computed
  • .block ⇒ object
  • .settings() : object

.block ⇒ object

The Block entity data.

Kind: static property of computed

.settings() : object

Block settings.

Kind: static method of computed

.druxt

Druxt module configuration.

Kind: static property of DruxtBlock

• .druxt
  • .template
  • .componentOptions(context) ⇒ ComponentOptions
  • .fetchConfig()
  • .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

.fetchConfig()

Fetches the Block JSON:API resource by either UUID or ID.

Kind: static method of druxt

.propsData(context) ⇒ PropsData

Provides propsData for the DruxtWrapper.

Kind: static method of druxt

.slots(h) ⇒ ScopedSlots

Provides the scoped slots object for the Module render function.

A default slot is provided with debug information if Nuxt is in development mode.

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

.data()

Kind: static method of DruxtBlock
Properties

.error(err, [context])

Sets the component to render a DruxtDebug error message.

Kind: instance method of DruxtBlock

.getModuleComponents() ⇒ Components

Get list of module wrapper components.

Kind: instance method of DruxtBlock

.getModulePropsData(wrapperProps) ⇒ object

Get module propsData via modules druxt.propsData() callback.

Kind: instance method of DruxtBlock

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 DruxtBlock

.getWrapperData(component) ⇒ WrapperData

Get wrapper component data.

Kind: instance method of DruxtBlock

.methods

Kind: static property of DruxtBlock

.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 DruxtBlock
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 DruxtBlock
Returns: string - The current language code.

ComponentOptions : Array.<array>

Provides the available naming options for the Wrapper component.

Kind: global typedef
Example

[
  'DruxtBlock[Plugin][PluginId][Region][Theme][Langcode]',
  'DruxtBlock[Plugin][PluginId][Region][Theme]',
  'DruxtBlock[Plugin][PluginId][Theme][Langcode]',
  'DruxtBlock[Plugin][PluginId][Theme]',
  'DruxtBlock[Plugin][Region][Theme][Langcode]',
  'DruxtBlock[Plugin][Region][Theme]',
  'DruxtBlock[Plugin][Theme][Langcode]',
  'DruxtBlock[Plugin][Theme]',
  'DruxtBlock[Default][Langcode]',
  'DruxtBlock[Default]',
]

Example (Umami Branding block)

[
  'DruxtBlockSystemBrandingBlockHeaderUmamiEn',
  'DruxtBlockSystemBrandingBlockHeaderUmami',
  'DruxtBlockSystemBrandingBlockHeaderEn',
  'DruxtBlockSystemBrandingBlockHeader',
  'DruxtBlockSystemBrandingBlockUmamiEn',
  'DruxtBlockSystemBrandingBlockUmami',
  'DruxtBlockSystemBrandingBlockEn',
  'DruxtBlockSystemBrandingBlock',
  'DruxtBlockDefaultEn',
  'DruxtBlockDefault',
]

ModuleSettings : object

Provides settings for the Blocks module, via the nuxt.config.js druxt.blocks object.

Kind: global typedef

Example

{
  fields: [],
}

Example (nuxt.config.js)

export default {
  druxt: {
    blocks: {
      query: {
        fields: ['dependencies'],
      },
    },
  },
}

PropsData : object

Provides propsData for use in the Wrapper component.

Kind: global typedef

Example

{
  block: {
    attributes: {},
    id: '59104acd-88e1-43c3-bd5f-35800f206394',
    links: {},
    relationships: {},
    type: 'block--block',
  },
}

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

Kind: global typedef

Components : Array.<object>

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

Kind: global typedef
Properties

Example

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

ComponentData : object

The Wrapper component and propsData to be rendered.

Kind: global typedef
Properties

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

Example

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