Merge pull request #95 from gingermusketeer/add-support-for-header-ed…

…itor Add support for the header editor
rmosolgo · Oct 15, 2021 · 6b34eb1 · 6b34eb1
2 parents 90f58db + 21d4c55
commit 6b34eb1
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git a/app/assets/javascripts/graphiql/rails/graphiql_show.js b/app/assets/javascripts/graphiql/rails/graphiql_show.js
@@ -47,10 +47,11 @@ document.addEventListener("DOMContentLoaded", function(event) {
 
   // Defines a GraphQL fetcher using the fetch API.
   var graphQLEndpoint = graphiqlContainer.dataset.graphqlEndpointPath;
-  function graphQLFetcher(graphQLParams) {
+  var providedHeaders = JSON.parse(graphiqlContainer.dataset.headers)
+  function graphQLFetcher(graphQLParams, options) {
     return fetch(graphQLEndpoint, {
       method: 'post',
-      headers: JSON.parse(graphiqlContainer.dataset.headers),
+      headers: {...providedHeaders, ...options.headers},
       body: JSON.stringify(graphQLParams),
       credentials: 'include',
     }).then(function(response) {
@@ -76,7 +77,7 @@ document.addEventListener("DOMContentLoaded", function(event) {
 
 
   // Render <GraphiQL /> into the body.
-  var elementProps = { fetcher: graphQLFetcher, defaultQuery: defaultQuery, };
+  var elementProps = { fetcher: graphQLFetcher, defaultQuery: defaultQuery, headerEditorEnabled: graphiqlContainer.dataset.headerEditorEnabled === 'true' };
 
   Object.assign(elementProps, { query: parameters.query, variables: parameters.variables })
   if (queryParams === 'true') {

diff --git a/app/views/graphiql/rails/editors/show.html.erb b/app/views/graphiql/rails/editors/show.html.erb
@@ -12,7 +12,8 @@
       initial_query: GraphiQL::Rails.config.initial_query,
       logo: GraphiQL::Rails.config.logo,
       headers: GraphiQL::Rails.config.resolve_headers(self),
-      query_params: GraphiQL::Rails.config.query_params
+      query_params: GraphiQL::Rails.config.query_params,
+      header_editor_enabled: GraphiQL::Rails.config.header_editor_enabled
     } %>
   </body>
 </html>
diff --git a/lib/graphiql/rails/config.rb b/lib/graphiql/rails/config.rb
@@ -7,7 +7,7 @@ class Config
       # @return [Hash<String => Proc>] Keys are headers to include in GraphQL requests, values are `->(view_context) { ... }` procs to determin values
       attr_accessor :headers
 
-      attr_accessor :query_params, :initial_query, :csrf, :title, :logo
+      attr_accessor :query_params, :initial_query, :csrf, :title, :logo, :header_editor_enabled
 
       DEFAULT_HEADERS = {
         'Content-Type' => ->(_) { 'application/json' },

diff --git a/readme.md b/readme.md
@@ -61,6 +61,7 @@ You can override `GraphiQL::Rails.config` values in an initializer (eg, `config/
 - `title` (string, default `nil`): if provided, it will be rendered in the page <title> tag
 - `logo` (string, default `nil`): if provided, it will be the text logo
 - `csrf` (boolean, default `true`): include `X-CSRF-Token` in GraphiQL's HTTP requests
+- `header_editor_enabled` (boolean, default `false`): if provided, the header editor will be rendered
 - `headers` (hash, `String => Proc`): procs to fetch header values for GraphiQL's HTTP requests, in the form `(view_context) -> { ... }`. For example: