graphiql icon indicating copy to clipboard operation
graphiql copied to clipboard

(draft) graphiql 2 next steps roadmap

Open acao opened this issue 2 years ago • 7 comments

I'm probably missing a lot of things here but just to get started. Please feel free to reorganize things as you please

2.0.x

  • [ ] replace webpack 4 with webpack 4 at least if not full vite/esbuild for @graphiql/react & graphiql
  • [ ] i18n
  • [ ] more a11y improvements

2.x.y

  • [ ] plugins prop API expansion - either -1. we move plugins prop => sidebarPlugins and mark plugins as deprecated - where other types of plugins use different props such as resultPanePlugins
      1. or we expand on our usage of the plugins prop array collection definition to specify alternative types of plugins, and upgrade the underlying @graphiql/react?
  • [ ] custom operation, variables, results tab pane plugin API?
  • [ ] sidebar network tab
  • [ ] sidebar code exporter
  • [ ] sidebar
  • [ ] better subscriptions results view (custom results serializer/ custom component plugin via tab pane plugins?)
  • [ ] yaml, markdown, and html results view plugins
  • [ ] query parser
  • [ ] docs site 📚🔮
    • [ ] doc site setup
    • [ ] how-tos
    • [ ] examples
    • [ ] api docs
  • [ ] easy vars?
  • [ ] renderGraphiQL, middlewares and simple client-only docker image

3.0.0

  • [ ] monaco-editor
  • ...

Todos

for this roadmap:

  • [ ] link relevant issues
  • [ ] create relevant discussions
  • [ ] create relevant tickets

acao avatar Aug 24 '22 20:08 acao

Was there also the intention to incorporate an explorer widget, to click on fields and add them to the query, similar to OneGraph/graphiql-explorer?

leoloso avatar Aug 29 '22 06:08 leoloso

@leoloso yes that will come in a later version for 2. see the graphiql explorer example if you want to enable the explorer plugin

Update: "later" as in later that same day 😆 thanks @thomasheyenbrock !

acao avatar Aug 29 '22 07:08 acao

@leoloso adding the explorer as a plugin will become even easier with https://github.com/graphql/graphiql/pull/2715

thomasheyenbrock avatar Aug 29 '22 10:08 thomasheyenbrock

Sounds awesome, thanks @thomasheyenbrock!

leoloso avatar Aug 29 '22 10:08 leoloso

I'd also be interested in having https://github.com/OneGraph/graphiql-code-exporter as a first-class citizen plugin 👍 If needed I can help with this.

LekoArts avatar Sep 05 '22 10:09 LekoArts

I'd also be interested in having https://github.com/OneGraph/graphiql-code-exporter as a first-class citizen plugin 👍

Same here, using it for a customer and without it I can not migrate to v2. Would even be even interested in contributing, but I need directions on this.

toxsick avatar Sep 05 '22 13:09 toxsick

I time-boxed some time on the code exporter: https://github.com/LekoArts/graphiql/tree/code-exporter

image

It's not working correctly at the moment (see screenshot with the error), feel free to send in PRs against https://github.com/graphql/graphiql/pull/2758

LekoArts avatar Sep 07 '22 10:09 LekoArts