API Documentation

Components

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 targetted Druxt wrapper component for manual theming.

Read the docs


DruxtBlockRegion

The DruxtBlockRegion component renders visible blocks based on region and theme.

All blocks, including those not visible, are provided as slots for the Druxt Wrapper component.

Read the docs


Druxt

Utility component for rendering Druxt modules.

Read the docs


DruxtDebug

The DruxtDebug component can be used to render debug information that is visible only when Nuxt is run in development mode.

You can render your debug information through the default slot, or via the json prop to format your data, or a combination of the two.

Read the docs


DruxtModule

The DruxtModule component is used to make a Druxt module, simply import and extend the component to get started.

The component provides access to the Druxt Wrapper theming and fetch system via the druxt settings object.

Read the docs


DruxtWrapper

Placeholder component for the Druxt Wrapper themeing system.

Read the docs


DruxtBreadcrumb

The DruxtBreadcrumb component renders a list of breadcrumbs based on the active route.

Read the docs


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.

Read the docs


DruxtEntityForm

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

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

Read the docs


DruxtEntityFormButtons

Used by the DruxtEntityForm component to render Druxt Wrapper themeable buttons.

Read the docs


DruxtField

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

Read the docs


DruxtMenu

The DruxtMenu component renders a Drupal menu using either the default Drupal content menus, or the full menu via the JSON:API Menu Items module.

Read the docs


DruxtMenuItem

Used by the DruxtMenu component to render individual Druxt Wrapper themeable menu items.

Read the docs


DruxtRouter

The DruxtRouter component renders a Drupal decoupled route, or path, using the appropriate Druxt component.

For instance, using the path /node/1 would render a DruxtEntity component.

The Vue router path will be used if not path is defined.

Read the docs


DruxtSite

The DruxtSite component renders all available Drupal block regions and content, based on the specified theme.

While Drupal provides placement configuration for blocks, it does not provide any information on where each region should be placed.

All regions are provided as scoped slots for the Druxt Wrapper component.

Read the docs


DruxtView

The DruxtView component renders Drupal Views using configuration and results provided by the Drupal View and the JSON:API Views module.

The component renders slots for the View's headers, footers, entity results, exposed sorts and filters, and supports contextual filters.

Read the docs


DruxtViewsFilter

Used by the DruxtView component to render individual Druxt Wrapper themeable filter components.

Read the docs


DruxtViewsFilters

Used by the DruxtView component to render a collection of Druxt Wrapper themeable filters.

Read the docs


DruxtViewsPager

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

Read the docs


DruxtViewsSorts

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

Read the docs


Note: The contents of this file where automatically generated by the Druxt Docgen.