API Documentation

DruxtEntity

entity

Modules

DruxtEntity

The DruxtEntity component renders a Drupal Content Entity by JSON:API resource type, UUID, view mode and schema type.

Fields are rendered as DruxtField components, based on the Drupal display mode configuration.

Typedefs

ComponentOptions : Array.<array>

Provides the available naming options for the Wrapper component.

ModuleSettings : object

Provides settings for the Entity module, via the nuxt.config.js druxt.entity, the Wrapper component druxt object or the DruxtEntity component settings property.

PropsData : object

Provides property data for use in the Wrapper component.

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

DruxtEntity

The DruxtEntity component renders a Drupal Content Entity by JSON:API resource type, UUID, view mode and schema type.

Fields are rendered as DruxtField components, based on the Drupal display mode configuration.

Example

<DruxtEntity
  type="node--article"
  :uuid="uuid"
  mode="teaser"
/>

Example (DruxtEntity Wrapper component boilerplate)

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

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

Example (DruxtEntity with template injection)

<DruxtEntity type="" uuid="">
  <template #default="{ entity }">
    <!-- Do whatever you want here -->
    <DruxtDebug :json="entity" />
  </template>
</DruxtEntity>

.getQuery(settings) ⇒ boolean | object

Builds the query for the JSON:API request.

Kind: instance method of DruxtEntity

ParamTypeDescription
settingsModuleSettingsThe merged module and component settings object.

.isEmpty(value) ⇒ boolean

Checks if an Entity field is empty.

Kind: instance method of DruxtEntity

ParamTypeDescription
value*Field value.

.props

Kind: static property of DruxtEntity


.mode : string

Drupal display mode.

Kind: static property of props
Default: "default"


.settings : ModuleSettings

Module settings object.

Kind: static property of props
Default: {}


.schemaType : 'view' | 'form'

Drupal display schema type, 'view' or 'form'.

Kind: static property of props


.type : string

JSON:API resource type.

Kind: static property of props


.uuid : string

Entity UUID.

Kind: static property of props


.computed

Kind: static property of DruxtEntity


.entity ⇒ object

The Entity object.

Kind: static property of computed
Returns: object - .


.fields ⇒ object

Entity fields based on Display mode.

Kind: static property of computed


.druxt

DruxtModule settings

Kind: static property of DruxtEntity


.componentOptions(context) ⇒ ComponentOptions

Provides the available component naming options for the Druxt Wrapper.

Kind: static method of druxt

ParamTypeDescription
contextobjectThe module component ViewModel.

.fetchConfig()

Fetches the Druxt schema object.

Kind: static method of druxt


.fetchData()

Fetches the content entity JSON:API resource.

Kind: static method of druxt


.propsData(context) ⇒ PropsData

Provides propsData for the DruxtWrapper.

Kind: static method of druxt

ParamTypeDescription
contextobjectThe module component ViewModel.

.settings()

Component settings.

Kind: static method of druxt


.slots() ⇒ ScopedSlots

Provides the scoped slots object for the Module render function.

A scoped slot is provided for each field being rendered, as per the current display mode.

Additionally, the default slot will render all fields as per the

Kind: static method of druxt
Returns: ScopedSlots - The Scoped slots object.
Example (DruxtEntityResourceType.vue)

<template>
  <div>
    <slot name="content" />
    <slot :name="field_name" />
  </div>
</template>

.data()

Kind: static method of DruxtEntity
Properties

NameTypeDescription
modelobjectThe model object.
schemaobjectThe DruxtSchema object.

ComponentOptions : Array.<array>

Provides the available naming options for the Wrapper component.

Kind: global typedef
Example

[
  'DruxtEntity[ResourceType][DisplayMode][SchemaType][Langcode]',
  'DruxtEntity[ResourceType][DisplayMode][SchemaType]',
  'DruxtEntity[EntityType][DisplayMode][SchemaType][Langcode]',
  'DruxtEntity[EntityType][DisplayMode][SchemaType]',
  'DruxtEntity[ResourceType][DisplayMode][Langcode]',
  'DruxtEntity[ResourceType][DisplayMode]',
  'DruxtEntity[EntityType][DisplayMode][Langcode]',
  'DruxtEntity[EntityType][DisplayMode]',
  'DruxtEntity[ResourceType][Langcode]',
  'DruxtEntity[ResourceType]',
  'DruxtEntity[EntityType][Langcode]',
  'DruxtEntity[EntityType]',
  'DruxtEntity[DisplayMode][Langcode]',
  'DruxtEntity[DisplayMode]',
]

Example (Article Node (default))

[
  'DruxtEntityNodeArticleDefaultViewEn',
  'DruxtEntityNodeArticleDefaultView',
  'DruxtEntityNodeDefaultViewEn',
  'DruxtEntityNodeDefaultView',
  'DruxtEntityNodeArticleDefaultEn',
  'DruxtEntityNodeArticleDefault',
  'DruxtEntityNodeDefaultEn',
  'DruxtEntityNodeDefault',
  'DruxtEntityNodeArticleEn',
  'DruxtEntityNodeArticle',
  'DruxtEntityNodeEn',
  'DruxtEntityNode',
  'DruxtEntityDefaultEn',
  'DruxtEntityDefault',
]

ModuleSettings : object

Provides settings for the Entity module, via the nuxt.config.js druxt.entity, the Wrapper component druxt object or the DruxtEntity component settings property.

Kind: global typedef

ParamTypeDescription
queryobjectEntity Query settings:
query.fieldsArray.<string> | Array.<array>An array or arrays of fields to filter from the JSON:API Resources.
query.includeArray.<string>An array of relationships to include alongside the JSON:API Resource.
query.schemabooleanWhether to automatically detect fields to filter, per the Display mode.

Example (DruxtEntity Wrapper component)

<script>
export default {
  druxt: {
    query: {
      fields: [['title'], ['user--user', ['display_name']]],
      include: ['uid']
      schema: true,
    },
  }
}

Example (DruxtEntity component with settings)

<template>
  <DruxtEntity
    type="node--article"
    :uuid="uuid"
    :settings="{
      query: {
        fields: [['title'], ['user--user', ['display_name']]],
        include: ['uid']
        schema: true,
      }
    }"
  />
</template>

PropsData : object

Provides property data for use in the Wrapper component.

Kind: global typedef

ParamTypeDescription
entityobjectThe Drupal Entity JSON:API resource data.
fieldsobjectDrupal Entity Fields data.
schemaobjectDruxtJS Schema object.
valueobjectThe Entity value.

Example

{
  entity: {
    attributes: {},
    id: '43118086-cca5-4c62-b11e-f1d870050ebd',
    links: {},
    relationships: {},
    type: 'node--article',
  },
  fields: {
    body: {},
    field_media_image: {},
    field_tags: {},
  },
  schema: {
    config: {},
    fields: {},
    groups: {},
    id: 'node--article--default--view',
    resourceType: 'node--article',
  },
  value: {},
}

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

Kind: global typedef

ParamTypeDescription
*functionSlot per field.
defaultfunctionAll fields per Display mode.

Example (DruxtEntityResourceType.vue)

<template>
  <div>
    <slot name="content" />
    <slot :name="field_name" />
  </div>
</template>