Registry / devops / gatsby-plugin-altair-graphql

gatsby-plugin-altair-graphql

library8.5.7jsnpmunverified

A Gatsby plugin that integrates Altair GraphQL client, a feature-rich GraphQL IDE, into your Gatsby site. Current stable version: 8.5.7. Updated as part of the Altair monorepo (releases ~monthly). Key differentiators: easy setup to embed Altair for development/testing, supports GraphQL introspection and schema download. Best for Gatsby developers needing an in-browser GraphQL explorer.

devops

npm install gatsby-plugin-altair-graphql

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · GATSBY-PLUGIN-ALTA

gatsby-plugin-altair-graphql

devopsjavascriptv8.5.7

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ module.exports = require('gatsby-plugin-altair-graphql')

✗ import gatsbyPluginAltair from 'gatsby-plugin-altair-graphql'

CJS-only; Gatsby plugin system expects module.exports, not ESM.

Configures the plugin in gatsby-config.js with optional endpoint and page path.

// gatsby-config.js module.exports = { plugins: [ { resolve: 'gatsby-plugin-altair-graphql', options: { endpointURL: process.env.GATSBY_GRAPHQL_ENDPOINT || 'http://localhost:8000/___graphql', altairDir: '__altair', pageTitle: 'Altair GraphQL', }, }, ], };

Debug

Known issues

gotchaMust be added as a Gatsby plugin in gatsby-config.js, not imported in pages.

fix

Add to plugins array in gatsby-config.js as shown in quickstart.

affects: all

breakingPlugin does not support ESM imports; use require() only.

fix

Use CJS require in gatsby-config.js.

affects: all

deprecatedaltairDir option default '/altair' deprecated in v5+; use '__altair' or custom.

fix

Explicitly set altairDir option to avoid path conflicts.

affects: >=5.0.0

Errors

Common errors & fixes

Cannot find module 'gatsby-plugin-altair-graphql'

Package not installed or mismatched version.

fix

npm install gatsby-plugin-altair-graphql@latest

Cannot read property 'endpointURL' of undefined

Options object missing when plugin resolves.

fix

Ensure options are passed as an object in gatsby-config.js.

Error: Gatsby plugin gatsby-plugin-altair-graphql is not compatible with your Gatsby version.

Gatsby version mismatch (e.g., Gatsby 4 vs 5).

fix

Check compatibility: npm view gatsby-plugin-altair-graphql peerDependencies

Upgrade

Version history

8.5.7latest on npm

Audit

Dependencies

altair-graphql-corerequiredCore Altair functionality

gatsbyoptionalPeer dependency for Gatsby plugins

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/altair-graphql/altair ↗

packagegatsby-plugin-altair-graphql ↗

homepagehttps://github.com/altair-graphql/altair#readme ↗