Registry / devops / altair-graphql-plugin

altair-graphql-plugin

library8.5.7jsnpmunverified

Plugin helper for the Altair GraphQL client, enabling custom extension development for Altair. Current stable version 8.5.7, actively maintained with regular releases. Provides a base class and utilities to create plugins that integrate seamlessly with Altair's UI and GraphQL functionality. Key differentiator: official plugin API for extending Altair, as opposed to hacking the client or writing separate browser extensions.

devops

npm install altair-graphql-plugin

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ALTAIR-GRAPHQL-PLU

altair-graphql-plugin

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.

AltairPlugin

✓ import { AltairPlugin } from 'altair-graphql-plugin'

✗ import AltairPlugin from 'altair-graphql-plugin'

Named export, not default. ESM/CJS compatible.

PluginDefinition

✓ import { PluginDefinition } from 'altair-graphql-plugin'

TypeScript interface for plugin configuration.

PluginSidebarEntry

✓ import { PluginSidebarEntry } from 'altair-graphql-plugin'

Used to define sidebar entries for the plugin.

Demonstrates creating a minimal Altair plugin that adds a sidebar entry.

import { AltairPlugin, PluginDefinition } from 'altair-graphql-plugin'; const myPlugin: PluginDefinition = { name: 'my-plugin', initialize(ctx) { ctx.addSidebarEntry({ title: 'My Plugin', component: () => <div>Hello from plugin!</div> }); } }; export default myPlugin;

Debug

Known issues

gotchaPlugin API is specific to the Altair GraphQL client. Ensure you are using a compatible Altair version.

fix

Check Altair's release notes for plugin compatibility.

affects: all

breakingRequires Node >= 12. Older versions of Node are unsupported.

fix

Upgrade Node to version 12 or higher.

affects: <12

Errors

Common errors & fixes

Cannot find module 'altair-graphql-plugin'

Package not installed or name incorrect.

fix

Run 'npm install altair-graphql-plugin' or 'yarn add altair-graphql-plugin'

'AltairPlugin' is not a constructor

Using default import instead of named import.

fix

Use 'import { AltairPlugin } from 'altair-graphql-plugin'

Upgrade

Version history

8.5.7latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

31 hits · last 30 days

node

OpenAI (training)

Resources

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

packagealtair-graphql-plugin ↗

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