Logo for jsDocs.io

graphiql

  • Version 3.8.3
  • Published
  • 14.4 MB
  • 1 dependency
  • MIT license

Install

npm i graphiql
yarn add graphiql
pnpm add graphiql

Overview

An graphical interactive in-browser GraphQL IDE.

Index

Functions

Type Aliases

Namespaces

Functions

function GraphiQL

GraphiQL: typeof GraphiQL;

    function GraphiQLInterface

    GraphiQLInterface: (props: GraphiQLInterfaceProps) => React.JSX.Element;

      Type Aliases

      type GraphiQLInterfaceProps

      type GraphiQLInterfaceProps = WriteableEditorProps &
          AddSuffix<Pick<UseQueryEditorArgs, 'onEdit'>, 'Query'> &
          Pick<UseQueryEditorArgs, 'onCopyQuery'> &
          AddSuffix<Pick<UseVariableEditorArgs, 'onEdit'>, 'Variables'> &
          AddSuffix<Pick<UseHeaderEditorArgs, 'onEdit'>, 'Headers'> &
          Pick<UseResponseEditorArgs, 'responseTooltip'> & {
              children?: ReactNode;
              defaultEditorToolsVisibility?: boolean | 'variables' | 'headers';
              isHeadersEditorEnabled?: boolean;
              toolbar?: GraphiQLToolbarConfig;
              showPersistHeadersSettings?: boolean;
              defaultTheme?: Theme;
              disableTabs?: boolean;
              forcedTheme?: (typeof THEMES)[number];
              className?: string;
              confirmCloseTab?(index: number): Promise<boolean> | boolean;
          };

        type GraphiQLProps

        type GraphiQLProps = Omit<GraphiQLProviderProps, 'children'> &
            GraphiQLInterfaceProps;

          Namespaces

          namespace GraphiQL

          namespace GraphiQL {}

            variable Footer

            var Footer: typeof GraphiQLFooter;
              var Logo: typeof GraphiQLLogo;

                variable Toolbar

                var Toolbar: typeof GraphiQLToolbar;

                  Package Files (2)

                  Dependencies (1)

                  Dev Dependencies (37)

                  Peer Dependencies (3)

                  Badge

                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/graphiql.

                  • Markdown
                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/graphiql)
                  • HTML
                    <a href="https://www.jsdocs.io/package/graphiql"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>