Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GraphiQLProps

Hierarchy

  • GraphiQLInterfaceProps
  • {}
  • {}
    • GraphiQLProps

Index

Properties

Optional children

children: ReactNode

Optional className

className: undefined | string

Additional class names which will be appended to the container element.

Optional defaultEditorToolsVisibility

defaultEditorToolsVisibility: boolean | "variables" | "headers"

Set the default state for the editor tools.

  • false hides the editor tools
  • true shows the editor tools
  • 'variables' specifically shows the variables editor
  • 'headers' specifically shows the request headers editor By default, the editor tools are initially shown when at least one of the editors has contents.

Optional isHeadersEditorEnabled

isHeadersEditorEnabled: undefined | false | true

Toggle if the headers' editor should be shown inside the editor tools.

default

true

Methods

Optional confirmCloseTab

  • confirmCloseTab(index: number): Promise<boolean> | boolean
  • When the user clicks a close tab button, this function is invoked with the index of the tab that is about to be closed. It can return a promise that should resolve to true (meaning the tab may be closed) or false (meaning the tab may not be closed).

    Parameters

    • index: number

      The index of the tab that should be closed.

    Returns Promise<boolean> | boolean

Generated using TypeDoc