graphiql-with-extensions

0.14.3 • Public • Published

GraphiQL with extensions

This is a meta-package meant to bring together the most popular GraphiQL plugins and make them easy to flip on and off.

The original GraphiQL package is consumable as a single React component, even without JSX. This makes it very easy to embed just about anywhere you can put JavaScript that might not have a full modern build pipeline (e.g. Rails with a sprockets setup).

Usage is easy:

npm install --save graphiql-with-extensions
# or
yarn add graphiql-with-extensions
import React from 'react';
import ReactDOM from 'react-dom';
import GraphiQL from 'graphiql-with-extensions';
import fetch from 'isomorphic-fetch';
 
function graphQLFetcher(graphQLParams) {
  return fetch(window.location.origin + '/graphql', {
    method: 'post',
    headers: {'Content-Type': 'application/json'},
    body: JSON.stringify(graphQLParams),
  }).then(response => response.json());
}
 
ReactDOM.render(
  <GraphiQL
    fetcher={graphQLFetcher}
    // Some optional props
    // defaultQuery={''}
    // disableExplorer={false}
  />,
  document.body,
);

Included extensions

Rigth now we only include the latest version of OneGraph's GraphiQL Explorer plugin. Please open an issue if you'd like to see other plugins included.

License

graphiql-with-extensions is licensed under the MIT License.
graphiql is licensed under the MIT License.
Documentation is licensed under Creative Common License.

graphiql-with-extensions

Readme

Keywords

none

Package Sidebar

Install

npm i graphiql-with-extensions

Weekly Downloads

266

Version

0.14.3

License

SEE LICENSE IN LICENSE

Unpacked Size

3.16 MB

Total Files

8

Last publish

Collaborators

  • sgrove