Description

This plugin extends the Gatsby Sanity GraphQL schema to add a localFile field to the SanityImageAsset type. The field localFile returns a File type. This enables downloading remote images to local so you have the flexibility to deploy them to a different CDN (or even process them with gatsby-plugin-sharp if you need to). This plugin is inspired by the localFile field from Contentful.

Demo

This page downloads the profile picture using localFile. The picture is served via Firebase CDN.

Dependencies

This plugin depends on gatsby-source-sanity

How to install

npm i gatsby-source-sanity-transform-images --save

// in your gatsby-config.js
module.exports = {
  // ...
  plugins: [
    // ...
    "gatsby-source-sanity-transform-images"
  ]
  // ...
};

When do I use this plugin?

If you want to download assets for static distribution instead of using Sanity's CDN. This plugin downloads the Sanity Assets to the local filesystem.

Useful for reduced data usage in development or projects where you want the assets copied locally with builds for deploying without links to Sanity's CDN.

Examples of usage

query Example {
  allSanityImageAsset {
    nodes {
    # Direct URL to Sanity CDN for this asset
      url
      # Query for locally stored file(eg An image) - `File` node
      localFile(width: 500) {
          # Where the asset is copied to for distribution
          publicURL
          # Use `gatsby-image` to create fluid image resource
          childImageSharp {
            # max width is already 500 because of localFile(width: 500)
            fluid {
              src
          }
        }
      }
    }
  }
}

How to contribute

Thanks for your interest in contributing to this plugin! Pull Requests welcome for any level of improvement, from a small typo to a new section, help us make the project better.

How to run the tests

yarn test

Pull Requests

To submit a pull request, follow these steps

1. Fork and clone this repo
2. Create a branch for your changes
3. Install dependencies with yarn
4. Make changes locally
5. Make sure tests pass, otherwise update the tests
6. Commit your changes
7. Push your branch to origin
8. Open a pull request in this repository with a clear title and description and link to any relevant issues
9. Wait for a maintainer to review your PR