How to Use the Gatsby-image Component with Drupal and GraphQL

When transitioning from gatsby-source-drupal, powered by JSON:API, to gatsby-source-graphql, leveraging the capabilities of the GraphQL module, you may notice the immediate absence of automatic media-image field processing. This missing feature can be quite a setback for seamless image integration.
In this blog post, we'll unveil a clever technique using the createResolvers API that allows you to effortlessly fetch and display images from Drupal in your Gatsby project.

Customizing the GraphQL Schema

To complete this task, you must add the following code to your gatsby-node.js file.

const { createRemoteFileNode } = require(`gatsby-source-filesystem`)

exports.createResolvers = ({
  actions,
  getCache,
  createNodeId,
  createResolvers,
}) => {
  const { createNode } = actions
 
   createResolvers({
    Drupal_MediaImage: {
      gatsbyImageFile: {
        type: `File`,
        resolve(source) {
          return createRemoteFileNode({
            url: source.fieldMediaImage.url,
            getCache,
            createNode,
            createNodeId,
          })
        },
      },
    },
  })
}

Adding that code creates a new gatsbyImageFile field on the Drupal_MediaImage type, generating File nodes from every value on the source.fieldMediaImage.url field.

Adding a GraphQL Fragment to Query the Image

Since File nodes automatically have childImageSharp convenience fields available, you can then feed the images from Drupal into gatsby-image by simply querying:

export const MediaImage = graphql`
  fragment MediaImage on Drupal_MediaImage {
    fieldMediaImage {
      url
      alt
    }
    gatsbyImageFile {
      childImageSharp {
        fluid {
          originalName
          ...GatsbyImageSharpFluid
        }
      }
    }
  }

Wrapping Up

Efficiently integrating images from Drupal into your Gatsby project should be a breeze without the need for repetitive code snippets. By harnessing the gatsby-source-drupal-graphql plugin, a valuable extension of gatsby-source-graphql, you gain a powerful ally in connecting to Drupal and quickly consuming data. With enhanced developer experience (DX) and seamless decoupled implementation, this plugin streamlines your image-handling process, saving you valuable time and effort. As a result, elevate your Gatsby and Drupal workflow to new heights, ensuring stunning visuals that captivate your audience, and embrace the power of gatsby-source-drupal-graphql!

How to Use the Gatsby-image Component with Drupal and GraphQL

Customizing the GraphQL Schema

Adding a GraphQL Fragment to Query the Image

Wrapping Up

About the author

The (Non-Technical and Technical) History of Drupal Up to 2025

From Drupal Console to Drupal Decoupled: Contributing to Making Drupal Community Stronger

Take your project to the next level!