API Documentation

DruxtField

entity

Modules

DruxtField

Renders a Drupal Field using Drupals by field type and formatter settings.

Typedefs

ComponentOptions : Array.<array>

Provides the available naming options for the Wrapper component.

PropsData : object

Provides propsData for use in the Wrapper component.

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

DruxtField

Renders a Drupal Field using Drupals by field type and formatter settings.

Example

<DruxtField
  :schema="{
    id: 'field_summary',
    label: {
      position: 'above',
      text: 'Summary',
    },
    type: 'basic_string'
  }"
  value="A wholesome pasta bake is the ultimate comfort food. This delicious bake is super quick to prepare and an ideal midweek meal for all the family."
/>

.props

Kind: static property of DruxtField


.errors : Array.<object>

JSON:API errors.

Kind: static property of props


.relationship : boolean

true if this field is a JSON:API relationship.

Kind: static property of props
Default: false


.schema : object

Drupal Field schema object.

Kind: static property of props


.options

Deprecated

Kind: static property of props


.value : array | boolean | number | object | string

The Field value.

Kind: static property of props
Model:


.computed

Kind: static property of DruxtField


.data : array | boolean | number | object | string

The Field data.

Kind: static property of computed


.isBoolean : boolean

Field is Boolean?

Kind: static property of computed


.isDateTime : boolean

Field is DateTime?

Kind: static property of computed


.isFile : boolean

Field is File?

Kind: static property of computed


.isImage : boolean

Field is Image?

Kind: static property of computed


Field is Link?

Kind: static property of computed


.isMultiple : boolean

Field is multi-cardinality.

Kind: static property of computed


.isText : boolean

Field is Text?

Kind: static property of computed


.label : object

The Field label display settings.

Kind: static property of computed
Default: { position: 'hidden' }


.druxt

DruxtModule settings

Kind: static property of DruxtField


.componentOptions(context) ⇒ ComponentOptions

Provides the available component naming options for the Druxt Wrapper.

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.

A scoped slot per field item is provided, with support for:

  • File, Image, Link, Number, Text and other View fields.
  • Boolean, Date/Time, Text and other Form fields.
  • Entitiy references.

A scoped slot is provided for the label, as well as label-above and label-inline depending on the field schema.

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.
Example (DruxtFieldSchemaType.vue)

<template>
  <div>
    <slot name="label" />
    <slot name="field-0" />
  </div>
</template>

.data()

Kind: static method of DruxtField
Properties

NameTypeDescription
modelobjectThe model object.

ComponentOptions : Array.<array>

Provides the available naming options for the Wrapper component.

Kind: global typedef
Example

[
  'DruxtField[Type][Id][SchemaType]',
  'DruxtField[Type][Id]',
  'DruxtField[Type][SchemaType]',
  'DruxtField[Default][SchemaType]',
  'DruxtField[Type]',
  'DruxtField[Default]',
]

Example (Media field)

[
  'DruxtFieldEntityReferenceEntityViewFieldMediaImageView',
  'DruxtFieldEntityReferenceEntityViewFieldMediaImage',
  'DruxtFieldEntityReferenceEntityViewView',
  'DruxtFieldDefaultView',
  'DruxtFieldEntityReferenceEntityView',
  'DruxtFieldDefault',
]

PropsData : object

Provides propsData for use in the Wrapper component.

Kind: global typedef

ParamTypeDescription
errorsArray.<object>JSON:API errors.
relationshipbooleanField relationship status.
schemaobjectDrupal Field schema information.
valueobjectThe Field value.

Example

{
  errors: [],
  relationship: true,
  schema: {
    config: {},
    description: '',
    id: 'field_media_image',
    label: {},
    required: true,
    settings: {},
    thirdPartySettings: [],
    type: 'entity_reference_entity_view',
    weight: 4,
  },
  value: {
    data: {
      id: '71a90e86-55b6-40fe-b77d-552dca1bee77',
      type: 'media--image',
    },
    links: {},
  },
}

ScopedSlots : object

Provides scoped slots for use in the Wrapper component.

Kind: global typedef

ParamTypeDescription
field-#functionA slot per field item, e.g. field-0.
labelfunctionThe field label.
label-abovefunctionThe field label, if label position is 'above'.
label-inlinefunctionThe field label, if label position is 'inline'.
defaultfunctionThe appropriate label and fields.