Altair: Is it possible to integrate GraphiQL Explorer or something very similar to Altair?

[FluorescentHallucinogen]

@imolorhe I really like Altair's Add queries and fragments from documentation feature.

But today I've just discovered GraphiQL Explorer plugin (https://github.com/OneGraph/graphiql-explorer).

Read the rationale in the "How OneGraph onboards users who are new to GraphQL" blog post.

IMO, it taking exploring and building GraphQL queries to the next level!

Is it possible to integrate GraphiQL Explorer or something very similar to Altair?

[welcome[bot]]

👋🏾Thanks for opening your first issue here! Be sure to follow the issue template! ✌🏾

[imolorhe]

@FluorescentHallucinogen Looks like a brilliant idea. It is definitely something that can be included in Altair. I'm only worried about the UI/UX bit of it (PS: I'm not a designer 😅) and how this can be placed alongside the currently existing functionalities without them appearing dissonant.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[FluorescentHallucinogen]

Here's my vision:

[imolorhe]

@FluorescentHallucinogen Isn't that the design of Playground's upcoming explorer? 😏

[FluorescentHallucinogen]

@imolorhe

Isn't that the design of Playground's upcoming explorer? :smirk:

You're partially right, this is a slightly modified by me version of Explorer tab from Playground v2 concept.

See https://github.com/OneGraph/graphiql-explorer/issues/10 for more info. :wink:

[imolorhe]

Okay alright. I am still figuring out the best way to integrate GraphiQL explorer, considering it is a React project. Still researching around potentially creating a web component from it, and using that within Altair. Also trying to figure out the best way to allow addition of features like this into any instance of Altair without adding it into the main Altair app.

[imolorhe]

Alternatively I would have to build it from scratch within Altair instead of using the one from OpenGraph, which isn't going to be ideal.

[FluorescentHallucinogen]

Fixed some things:

[FluorescentHallucinogen]

@imolorhe I've improved some things. See explanations in https://github.com/OneGraph/graphiql-explorer/issues/10#issuecomment-481835887. :wink:

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[imolorhe]

Closing this as resolved, considering the GraphiQL explorer is now in Altair beta and can be used today 🙂

To use the GraphiQL explorer plugin, you should do the following steps:

• Go to the Altair settings
• Enable experimental features in Altair (enableExperimental: true)
• Add altair-graphql-plugin-graphql-explorer to the plugin.list
• Save settings
• Restart Altair

[AntonioRedondo]

I really love this feature! Are you guys considering moving it out of beta and enable it by default? Seems to me like functionality basic enough so that it should be part of the core project.

[imolorhe]

Hey @AntonioRedondo,

Glad to hear that this feature has been very helpful ❤️. I also assume you've not had much bugs or issues while using it, which is good news. Unfortunately I'm not convinced the plugin architecture is ready to be removed from beta just yet. There's still only one plugin developed so far, which handles just one use case. There have been mentions of other potential plugins (#1089, #750) but none have been implemented just yet, so the plugin system isn't fully battle tested.

Also I wouldn't consider the GraphQL explorer to be a basic functionality, which is why it was implemented as a plugin so that anyone that wants to use it can easily enable it. Once the plugin system is out of beta, it would be possible to use any of the integrations to host Altair, and have plugins enabled by default for your users.