GraphiQL API Documentation
    Preparing search index...

    Interface GraphiQLInterfaceProps

    interface GraphiQLInterfaceProps {
        about?: string;
        accessKey?: string;
        "aria-activedescendant"?: string;
        "aria-atomic"?: Booleanish;
        "aria-autocomplete"?: "inline" | "none" | "list" | "both";
        "aria-braillelabel"?: string;
        "aria-brailleroledescription"?: string;
        "aria-busy"?: Booleanish;
        "aria-checked"?: boolean | "true" | "false" | "mixed";
        "aria-colcount"?: number;
        "aria-colindex"?: number;
        "aria-colindextext"?: string;
        "aria-colspan"?: number;
        "aria-controls"?: string;
        "aria-current"?:
            | boolean
            | "true"
            | "time"
            | "false"
            | "page"
            | "step"
            | "location"
            | "date";
        "aria-describedby"?: string;
        "aria-description"?: string;
        "aria-details"?: string;
        "aria-disabled"?: Booleanish;
        "aria-dropeffect"?: "link"
        | "copy"
        | "none"
        | "execute"
        | "move"
        | "popup";
        "aria-errormessage"?: string;
        "aria-expanded"?: Booleanish;
        "aria-flowto"?: string;
        "aria-grabbed"?: Booleanish;
        "aria-haspopup"?:
            | boolean
            | "true"
            | "dialog"
            | "menu"
            | "false"
            | "grid"
            | "listbox"
            | "tree";
        "aria-hidden"?: Booleanish;
        "aria-invalid"?: boolean
        | "true"
        | "false"
        | "grammar"
        | "spelling";
        "aria-keyshortcuts"?: string;
        "aria-label"?: string;
        "aria-labelledby"?: string;
        "aria-level"?: number;
        "aria-live"?: "off" | "assertive" | "polite";
        "aria-modal"?: Booleanish;
        "aria-multiline"?: Booleanish;
        "aria-multiselectable"?: Booleanish;
        "aria-orientation"?: "horizontal" | "vertical";
        "aria-owns"?: string;
        "aria-placeholder"?: string;
        "aria-posinset"?: number;
        "aria-pressed"?: boolean | "true" | "false" | "mixed";
        "aria-readonly"?: Booleanish;
        "aria-relevant"?:
            | "text"
            | "additions"
            | "additions removals"
            | "additions text"
            | "all"
            | "removals"
            | "removals additions"
            | "removals text"
            | "text additions"
            | "text removals";
        "aria-required"?: Booleanish;
        "aria-roledescription"?: string;
        "aria-rowcount"?: number;
        "aria-rowindex"?: number;
        "aria-rowindextext"?: string;
        "aria-rowspan"?: number;
        "aria-selected"?: Booleanish;
        "aria-setsize"?: number;
        "aria-sort"?: "none"
        | "ascending"
        | "descending"
        | "other";
        "aria-valuemax"?: number;
        "aria-valuemin"?: number;
        "aria-valuenow"?: number;
        "aria-valuetext"?: string;
        autoCapitalize?:
            | string & {}
            | "off"
            | "none"
            | "on"
            | "sentences"
            | "words"
            | "characters";
        autoCorrect?: string;
        autoFocus?: boolean;
        autoSave?: string;
        children?: ReactNode;
        className?: string;
        color?: string;
        content?: string;
        contentEditable?: Booleanish
        | "inherit"
        | "plaintext-only";
        contextMenu?: string;
        dangerouslySetInnerHTML?: { __html: string | TrustedHTML };
        datatype?: string;
        defaultChecked?: boolean;
        defaultEditorToolsVisibility?: boolean | "headers" | "variables";
        defaultValue?: string | number | readonly string[];
        dir?: string;
        draggable?: Booleanish;
        enterKeyHint?:
            | "search"
            | "enter"
            | "done"
            | "go"
            | "next"
            | "previous"
            | "send";
        exportparts?: string;
        forcedTheme?: "system"
        | "light"
        | "dark";
        hidden?: boolean;
        id?: string;
        inert?: boolean;
        inlist?: any;
        inputMode?:
            | "search"
            | "text"
            | "none"
            | "tel"
            | "url"
            | "email"
            | "numeric"
            | "decimal";
        is?: string;
        isHeadersEditorEnabled?: boolean;
        itemID?: string;
        itemProp?: string;
        itemRef?: string;
        itemScope?: boolean;
        itemType?: string;
        key?: Key
        | null;
        lang?: string;
        nonce?: string;
        onAbort?: ReactEventHandler<HTMLDivElement>;
        onAbortCapture?: ReactEventHandler<HTMLDivElement>;
        onAnimationEnd?: AnimationEventHandler<HTMLDivElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLDivElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>;
        onAnimationStart?: AnimationEventHandler<HTMLDivElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>;
        onAuxClick?: MouseEventHandler<HTMLDivElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLDivElement>;
        onBeforeInput?: FormEventHandler<HTMLDivElement>;
        onBeforeInputCapture?: FormEventHandler<HTMLDivElement>;
        onBeforeToggle?: ToggleEventHandler<HTMLDivElement>;
        onBlur?: FocusEventHandler<HTMLDivElement>;
        onBlurCapture?: FocusEventHandler<HTMLDivElement>;
        onCanPlay?: ReactEventHandler<HTMLDivElement>;
        onCanPlayCapture?: ReactEventHandler<HTMLDivElement>;
        onCanPlayThrough?: ReactEventHandler<HTMLDivElement>;
        onCanPlayThroughCapture?: ReactEventHandler<HTMLDivElement>;
        onChange?: FormEventHandler<HTMLDivElement>;
        onChangeCapture?: FormEventHandler<HTMLDivElement>;
        onClick?: MouseEventHandler<HTMLDivElement>;
        onClickCapture?: MouseEventHandler<HTMLDivElement>;
        onCompositionEnd?: CompositionEventHandler<HTMLDivElement>;
        onCompositionEndCapture?: CompositionEventHandler<HTMLDivElement>;
        onCompositionStart?: CompositionEventHandler<HTMLDivElement>;
        onCompositionStartCapture?: CompositionEventHandler<HTMLDivElement>;
        onCompositionUpdate?: CompositionEventHandler<HTMLDivElement>;
        onCompositionUpdateCapture?: CompositionEventHandler<HTMLDivElement>;
        onContextMenu?: MouseEventHandler<HTMLDivElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLDivElement>;
        onCopy?: ClipboardEventHandler<HTMLDivElement>;
        onCopyCapture?: ClipboardEventHandler<HTMLDivElement>;
        onCut?: ClipboardEventHandler<HTMLDivElement>;
        onCutCapture?: ClipboardEventHandler<HTMLDivElement>;
        onDoubleClick?: MouseEventHandler<HTMLDivElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>;
        onDrag?: DragEventHandler<HTMLDivElement>;
        onDragCapture?: DragEventHandler<HTMLDivElement>;
        onDragEnd?: DragEventHandler<HTMLDivElement>;
        onDragEndCapture?: DragEventHandler<HTMLDivElement>;
        onDragEnter?: DragEventHandler<HTMLDivElement>;
        onDragEnterCapture?: DragEventHandler<HTMLDivElement>;
        onDragExit?: DragEventHandler<HTMLDivElement>;
        onDragExitCapture?: DragEventHandler<HTMLDivElement>;
        onDragLeave?: DragEventHandler<HTMLDivElement>;
        onDragLeaveCapture?: DragEventHandler<HTMLDivElement>;
        onDragOver?: DragEventHandler<HTMLDivElement>;
        onDragOverCapture?: DragEventHandler<HTMLDivElement>;
        onDragStart?: DragEventHandler<HTMLDivElement>;
        onDragStartCapture?: DragEventHandler<HTMLDivElement>;
        onDrop?: DragEventHandler<HTMLDivElement>;
        onDropCapture?: DragEventHandler<HTMLDivElement>;
        onDurationChange?: ReactEventHandler<HTMLDivElement>;
        onDurationChangeCapture?: ReactEventHandler<HTMLDivElement>;
        onEditHeaders?: (value: string) => void;
        onEditQuery?: (value: string, documentAST?: DocumentNode) => void;
        onEditVariables?: (value: string) => void;
        onEmptied?: ReactEventHandler<HTMLDivElement>;
        onEmptiedCapture?: ReactEventHandler<HTMLDivElement>;
        onEncrypted?: ReactEventHandler<HTMLDivElement>;
        onEncryptedCapture?: ReactEventHandler<HTMLDivElement>;
        onEnded?: ReactEventHandler<HTMLDivElement>;
        onEndedCapture?: ReactEventHandler<HTMLDivElement>;
        onError?: ReactEventHandler<HTMLDivElement>;
        onErrorCapture?: ReactEventHandler<HTMLDivElement>;
        onFocus?: FocusEventHandler<HTMLDivElement>;
        onFocusCapture?: FocusEventHandler<HTMLDivElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLDivElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>;
        onInput?: FormEventHandler<HTMLDivElement>;
        onInputCapture?: FormEventHandler<HTMLDivElement>;
        onInvalid?: FormEventHandler<HTMLDivElement>;
        onInvalidCapture?: FormEventHandler<HTMLDivElement>;
        onKeyDown?: KeyboardEventHandler<HTMLDivElement>;
        onKeyDownCapture?: KeyboardEventHandler<HTMLDivElement>;
        onKeyPress?: KeyboardEventHandler<HTMLDivElement>;
        onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>;
        onKeyUp?: KeyboardEventHandler<HTMLDivElement>;
        onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>;
        onLoad?: ReactEventHandler<HTMLDivElement>;
        onLoadCapture?: ReactEventHandler<HTMLDivElement>;
        onLoadedData?: ReactEventHandler<HTMLDivElement>;
        onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>;
        onLoadedMetadata?: ReactEventHandler<HTMLDivElement>;
        onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>;
        onLoadStart?: ReactEventHandler<HTMLDivElement>;
        onLoadStartCapture?: ReactEventHandler<HTMLDivElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLDivElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>;
        onMouseDown?: MouseEventHandler<HTMLDivElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLDivElement>;
        onMouseEnter?: MouseEventHandler<HTMLDivElement>;
        onMouseLeave?: MouseEventHandler<HTMLDivElement>;
        onMouseMove?: MouseEventHandler<HTMLDivElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>;
        onMouseOut?: MouseEventHandler<HTMLDivElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLDivElement>;
        onMouseOver?: MouseEventHandler<HTMLDivElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLDivElement>;
        onMouseUp?: MouseEventHandler<HTMLDivElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLDivElement>;
        onPaste?: ClipboardEventHandler<HTMLDivElement>;
        onPasteCapture?: ClipboardEventHandler<HTMLDivElement>;
        onPause?: ReactEventHandler<HTMLDivElement>;
        onPauseCapture?: ReactEventHandler<HTMLDivElement>;
        onPlay?: ReactEventHandler<HTMLDivElement>;
        onPlayCapture?: ReactEventHandler<HTMLDivElement>;
        onPlaying?: ReactEventHandler<HTMLDivElement>;
        onPlayingCapture?: ReactEventHandler<HTMLDivElement>;
        onPointerCancel?: PointerEventHandler<HTMLDivElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerDown?: PointerEventHandler<HTMLDivElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerEnter?: PointerEventHandler<HTMLDivElement>;
        onPointerLeave?: PointerEventHandler<HTMLDivElement>;
        onPointerMove?: PointerEventHandler<HTMLDivElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerOut?: PointerEventHandler<HTMLDivElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerOver?: PointerEventHandler<HTMLDivElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerUp?: PointerEventHandler<HTMLDivElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLDivElement>;
        onProgress?: ReactEventHandler<HTMLDivElement>;
        onProgressCapture?: ReactEventHandler<HTMLDivElement>;
        onRateChange?: ReactEventHandler<HTMLDivElement>;
        onRateChangeCapture?: ReactEventHandler<HTMLDivElement>;
        onReset?: FormEventHandler<HTMLDivElement>;
        onResetCapture?: FormEventHandler<HTMLDivElement>;
        onResize?: ReactEventHandler<HTMLDivElement>;
        onResizeCapture?: ReactEventHandler<HTMLDivElement>;
        onScroll?: UIEventHandler<HTMLDivElement>;
        onScrollCapture?: UIEventHandler<HTMLDivElement>;
        onScrollEnd?: UIEventHandler<HTMLDivElement>;
        onScrollEndCapture?: UIEventHandler<HTMLDivElement>;
        onSeeked?: ReactEventHandler<HTMLDivElement>;
        onSeekedCapture?: ReactEventHandler<HTMLDivElement>;
        onSeeking?: ReactEventHandler<HTMLDivElement>;
        onSeekingCapture?: ReactEventHandler<HTMLDivElement>;
        onSelect?: ReactEventHandler<HTMLDivElement>;
        onSelectCapture?: ReactEventHandler<HTMLDivElement>;
        onStalled?: ReactEventHandler<HTMLDivElement>;
        onStalledCapture?: ReactEventHandler<HTMLDivElement>;
        onSubmit?: FormEventHandler<HTMLDivElement>;
        onSubmitCapture?: FormEventHandler<HTMLDivElement>;
        onSuspend?: ReactEventHandler<HTMLDivElement>;
        onSuspendCapture?: ReactEventHandler<HTMLDivElement>;
        onTimeUpdate?: ReactEventHandler<HTMLDivElement>;
        onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>;
        onToggle?: ToggleEventHandler<HTMLDivElement>;
        onTouchCancel?: TouchEventHandler<HTMLDivElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>;
        onTouchEnd?: TouchEventHandler<HTMLDivElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLDivElement>;
        onTouchMove?: TouchEventHandler<HTMLDivElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>;
        onTouchStart?: TouchEventHandler<HTMLDivElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLDivElement>;
        onTransitionCancel?: TransitionEventHandler<HTMLDivElement>;
        onTransitionCancelCapture?: TransitionEventHandler<HTMLDivElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLDivElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>;
        onTransitionRun?: TransitionEventHandler<HTMLDivElement>;
        onTransitionRunCapture?: TransitionEventHandler<HTMLDivElement>;
        onTransitionStart?: TransitionEventHandler<HTMLDivElement>;
        onTransitionStartCapture?: TransitionEventHandler<HTMLDivElement>;
        onVolumeChange?: ReactEventHandler<HTMLDivElement>;
        onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>;
        onWaiting?: ReactEventHandler<HTMLDivElement>;
        onWaitingCapture?: ReactEventHandler<HTMLDivElement>;
        onWheel?: WheelEventHandler<HTMLDivElement>;
        onWheelCapture?: WheelEventHandler<HTMLDivElement>;
        part?: string;
        popover?: "" | "auto" | "manual";
        popoverTarget?: string;
        popoverTargetAction?: "toggle" | "show" | "hide";
        prefix?: string;
        property?: string;
        radioGroup?: string;
        rel?: string;
        resource?: string;
        responseTooltip?: ResponseTooltipType;
        results?: number;
        rev?: string;
        role?: AriaRole;
        security?: string;
        showPersistHeadersSettings?: boolean;
        slot?: string;
        spellCheck?: Booleanish;
        style?: CSSProperties;
        suppressContentEditableWarning?: boolean;
        suppressHydrationWarning?: boolean;
        tabIndex?: number;
        title?: string;
        translate?: "yes" | "no";
        typeof?: string;
        unselectable?: "off" | "on";
        vocab?: string;
        confirmCloseTab?(index: number): boolean | Promise<boolean>;
    }

    Hierarchy (View Summary)

    • EditorProps
    • AddSuffix<Pick<QueryEditorProps, "onEdit">, "Query">
    • AddSuffix<Pick<VariableEditorProps, "onEdit">, "Variables">
    • AddSuffix<Pick<HeaderEditorProps, "onEdit">, "Headers">
    • Pick<ResponseEditorProps, "responseTooltip">
    • Pick<
          ComponentPropsWithoutRef<typeof Sidebar>,
          "forcedTheme" | "showPersistHeadersSettings",
      >
    Index

    Properties

    about? accessKey? aria-activedescendant? aria-atomic? aria-autocomplete? aria-braillelabel? aria-brailleroledescription? aria-busy? aria-checked? aria-colcount? aria-colindex? aria-colindextext? aria-colspan? aria-controls? aria-current? aria-describedby? aria-description? aria-details? aria-disabled? aria-dropeffect? aria-errormessage? aria-expanded? aria-flowto? aria-grabbed? aria-haspopup? aria-hidden? aria-invalid? aria-keyshortcuts? aria-label? aria-labelledby? aria-level? aria-live? aria-modal? aria-multiline? aria-multiselectable? aria-orientation? aria-owns? aria-placeholder? aria-posinset? aria-pressed? aria-readonly? aria-relevant? aria-required? aria-roledescription? aria-rowcount? aria-rowindex? aria-rowindextext? aria-rowspan? aria-selected? aria-setsize? aria-sort? aria-valuemax? aria-valuemin? aria-valuenow? aria-valuetext? autoCapitalize? autoCorrect? autoFocus? autoSave? children? className? color? content? contentEditable? contextMenu? dangerouslySetInnerHTML? datatype? defaultChecked? defaultEditorToolsVisibility? defaultValue? dir? draggable? enterKeyHint? exportparts? forcedTheme? hidden? id? inert? inlist? inputMode? is? isHeadersEditorEnabled? itemID? itemProp? itemRef? itemScope? itemType? key? lang? nonce? onAbort? onAbortCapture? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onBeforeInput? onBeforeInputCapture? onBeforeToggle? onBlur? onBlurCapture? onCanPlay? onCanPlayCapture? onCanPlayThrough? onCanPlayThroughCapture? onChange? onChangeCapture? onClick? onClickCapture? onCompositionEnd? onCompositionEndCapture? onCompositionStart? onCompositionStartCapture? onCompositionUpdate? onCompositionUpdateCapture? onContextMenu? onContextMenuCapture? onCopy? onCopyCapture? onCut? onCutCapture? onDoubleClick? onDoubleClickCapture? onDrag? onDragCapture? onDragEnd? onDragEndCapture? onDragEnter? onDragEnterCapture? onDragExit? onDragExitCapture? onDragLeave? onDragLeaveCapture? onDragOver? onDragOverCapture? onDragStart? onDragStartCapture? onDrop? onDropCapture? onDurationChange? onDurationChangeCapture? onEditHeaders? onEditQuery? onEditVariables? onEmptied? onEmptiedCapture? onEncrypted? onEncryptedCapture? onEnded? onEndedCapture? onError? onErrorCapture? onFocus? onFocusCapture? onGotPointerCapture? onGotPointerCaptureCapture? onInput? onInputCapture? onInvalid? onInvalidCapture? onKeyDown? onKeyDownCapture? onKeyPress? onKeyPressCapture? onKeyUp? onKeyUpCapture? onLoad? onLoadCapture? onLoadedData? onLoadedDataCapture? onLoadedMetadata? onLoadedMetadataCapture? onLoadStart? onLoadStartCapture? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onPaste? onPasteCapture? onPause? onPauseCapture? onPlay? onPlayCapture? onPlaying? onPlayingCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerLeave? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onProgress? onProgressCapture? onRateChange? onRateChangeCapture? onReset? onResetCapture? onResize? onResizeCapture? onScroll? onScrollCapture? onScrollEnd? onScrollEndCapture? onSeeked? onSeekedCapture? onSeeking? onSeekingCapture? onSelect? onSelectCapture? onStalled? onStalledCapture? onSubmit? onSubmitCapture? onSuspend? onSuspendCapture? onTimeUpdate? onTimeUpdateCapture? onToggle? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionCancel? onTransitionCancelCapture? onTransitionEnd? onTransitionEndCapture? onTransitionRun? onTransitionRunCapture? onTransitionStart? onTransitionStartCapture? onVolumeChange? onVolumeChangeCapture? onWaiting? onWaitingCapture? onWheel? onWheelCapture? part? popover? popoverTarget? popoverTargetAction? prefix? property? radioGroup? rel? resource? responseTooltip? results? rev? role? security? showPersistHeadersSettings? slot? spellCheck? style? suppressContentEditableWarning? suppressHydrationWarning? tabIndex? title? translate? typeof? unselectable? vocab?

    Methods

    Properties

    about?: string
    accessKey?: string
    "aria-activedescendant"?: string

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    "aria-atomic"?: Booleanish

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    "aria-autocomplete"?: "inline" | "none" | "list" | "both"

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

    "aria-braillelabel"?: string

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    aria-label.

    "aria-brailleroledescription"?: string

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    aria-roledescription.

    "aria-busy"?: Booleanish
    "aria-checked"?: boolean | "true" | "false" | "mixed"

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    • aria-pressed
    • aria-selected.
    "aria-colcount"?: number

    Defines the total number of columns in a table, grid, or treegrid.

    aria-colindex.

    "aria-colindex"?: number

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    • aria-colcount
    • aria-colspan.
    "aria-colindextext"?: string

    Defines a human readable text alternative of aria-colindex.

    aria-rowindextext.

    "aria-colspan"?: number

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    • aria-colindex
    • aria-rowspan.
    "aria-controls"?: string

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    aria-owns.

    "aria-current"?:
        | boolean
        | "true"
        | "time"
        | "false"
        | "page"
        | "step"
        | "location"
        | "date"

    Indicates the element that represents the current item within a container or set of related elements.

    "aria-describedby"?: string

    Identifies the element (or elements) that describes the object.

    aria-labelledby

    "aria-description"?: string

    Defines a string value that describes or annotates the current element.

    related aria-describedby.

    "aria-details"?: string

    Identifies the element that provides a detailed, extended description for the object.

    aria-describedby.

    "aria-disabled"?: Booleanish

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    • aria-hidden
    • aria-readonly.
    "aria-dropeffect"?: "link" | "copy" | "none" | "execute" | "move" | "popup"

    Indicates what functions can be performed when a dragged object is released on the drop target.

    in ARIA 1.1

    "aria-errormessage"?: string

    Identifies the element that provides an error message for the object.

    • aria-invalid
    • aria-describedby.
    "aria-expanded"?: Booleanish

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    "aria-flowto"?: string

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

    "aria-grabbed"?: Booleanish

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    in ARIA 1.1

    "aria-haspopup"?:
        | boolean
        | "true"
        | "dialog"
        | "menu"
        | "false"
        | "grid"
        | "listbox"
        | "tree"

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    "aria-hidden"?: Booleanish

    Indicates whether the element is exposed to an accessibility API.

    aria-disabled.

    "aria-invalid"?: boolean | "true" | "false" | "grammar" | "spelling"

    Indicates the entered value does not conform to the format expected by the application.

    aria-errormessage.

    "aria-keyshortcuts"?: string

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    "aria-label"?: string

    Defines a string value that labels the current element.

    aria-labelledby.

    "aria-labelledby"?: string

    Identifies the element (or elements) that labels the current element.

    aria-describedby.

    "aria-level"?: number

    Defines the hierarchical level of an element within a structure.

    "aria-live"?: "off" | "assertive" | "polite"

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    "aria-modal"?: Booleanish

    Indicates whether an element is modal when displayed.

    "aria-multiline"?: Booleanish

    Indicates whether a text box accepts multiple lines of input or only a single line.

    "aria-multiselectable"?: Booleanish

    Indicates that the user may select more than one item from the current selectable descendants.

    "aria-orientation"?: "horizontal" | "vertical"

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    "aria-owns"?: string

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    aria-controls.

    "aria-placeholder"?: string

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

    "aria-posinset"?: number

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    aria-setsize.

    "aria-pressed"?: boolean | "true" | "false" | "mixed"

    Indicates the current "pressed" state of toggle buttons.

    • aria-checked
    • aria-selected.
    "aria-readonly"?: Booleanish

    Indicates that the element is not editable, but is otherwise operable.

    aria-disabled.

    "aria-relevant"?:
        | "text"
        | "additions"
        | "additions removals"
        | "additions text"
        | "all"
        | "removals"
        | "removals additions"
        | "removals text"
        | "text additions"
        | "text removals"

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    aria-atomic.

    "aria-required"?: Booleanish

    Indicates that user input is required on the element before a form may be submitted.

    "aria-roledescription"?: string

    Defines a human-readable, author-localized description for the role of an element.

    "aria-rowcount"?: number

    Defines the total number of rows in a table, grid, or treegrid.

    aria-rowindex.

    "aria-rowindex"?: number

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    • aria-rowcount
    • aria-rowspan.
    "aria-rowindextext"?: string

    Defines a human readable text alternative of aria-rowindex.

    aria-colindextext.

    "aria-rowspan"?: number

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    • aria-rowindex
    • aria-colspan.
    "aria-selected"?: Booleanish

    Indicates the current "selected" state of various widgets.

    • aria-checked
    • aria-pressed.
    "aria-setsize"?: number

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    aria-posinset.

    "aria-sort"?: "none" | "ascending" | "descending" | "other"

    Indicates if items in a table or grid are sorted in ascending or descending order.

    "aria-valuemax"?: number

    Defines the maximum allowed value for a range widget.

    "aria-valuemin"?: number

    Defines the minimum allowed value for a range widget.

    "aria-valuenow"?: number

    Defines the current value for a range widget.

    aria-valuetext.

    "aria-valuetext"?: string

    Defines the human readable text alternative of aria-valuenow for a range widget.

    autoCapitalize?:
        | string & {}
        | "off"
        | "none"
        | "on"
        | "sentences"
        | "words"
        | "characters"
    autoCorrect?: string
    autoFocus?: boolean
    autoSave?: string
    children?: ReactNode
    className?: string

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

    color?: string
    content?: string
    contentEditable?: Booleanish | "inherit" | "plaintext-only"
    contextMenu?: string
    dangerouslySetInnerHTML?: { __html: string | TrustedHTML }
    datatype?: string
    defaultChecked?: boolean
    defaultEditorToolsVisibility?: boolean | "headers" | "variables"

    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.
    defaultValue?: string | number | readonly string[]
    dir?: string
    draggable?: Booleanish
    enterKeyHint?: "search" | "enter" | "done" | "go" | "next" | "previous" | "send"
    exportparts?: string
    forcedTheme?: "system" | "light" | "dark"

    forcedTheme allows enforcement of a specific theme for GraphiQL. This is useful when you want to make sure that GraphiQL is always rendered with a specific theme.

    hidden?: boolean
    id?: string
    inert?: boolean
    inlist?: any
    inputMode?:
        | "search"
        | "text"
        | "none"
        | "tel"
        | "url"
        | "email"
        | "numeric"
        | "decimal"

    Hints at the type of data that might be entered by the user while editing the element or its contents

    is?: string

    Specify that a standard HTML element should behave like a defined custom built-in element

    isHeadersEditorEnabled?: boolean

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

    true
    
    itemID?: string
    itemProp?: string
    itemRef?: string
    itemScope?: boolean
    itemType?: string
    key?: Key | null
    lang?: string
    nonce?: string
    onAbort?: ReactEventHandler<HTMLDivElement>
    onAbortCapture?: ReactEventHandler<HTMLDivElement>
    onAnimationEnd?: AnimationEventHandler<HTMLDivElement>
    onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>
    onAnimationIteration?: AnimationEventHandler<HTMLDivElement>
    onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>
    onAnimationStart?: AnimationEventHandler<HTMLDivElement>
    onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>
    onAuxClick?: MouseEventHandler<HTMLDivElement>
    onAuxClickCapture?: MouseEventHandler<HTMLDivElement>
    onBeforeInput?: FormEventHandler<HTMLDivElement>
    onBeforeInputCapture?: FormEventHandler<HTMLDivElement>
    onBeforeToggle?: ToggleEventHandler<HTMLDivElement>
    onBlur?: FocusEventHandler<HTMLDivElement>
    onBlurCapture?: FocusEventHandler<HTMLDivElement>
    onCanPlay?: ReactEventHandler<HTMLDivElement>
    onCanPlayCapture?: ReactEventHandler<HTMLDivElement>
    onCanPlayThrough?: ReactEventHandler<HTMLDivElement>
    onCanPlayThroughCapture?: ReactEventHandler<HTMLDivElement>
    onChange?: FormEventHandler<HTMLDivElement>
    onChangeCapture?: FormEventHandler<HTMLDivElement>
    onClick?: MouseEventHandler<HTMLDivElement>
    onClickCapture?: MouseEventHandler<HTMLDivElement>
    onCompositionEnd?: CompositionEventHandler<HTMLDivElement>
    onCompositionEndCapture?: CompositionEventHandler<HTMLDivElement>
    onCompositionStart?: CompositionEventHandler<HTMLDivElement>
    onCompositionStartCapture?: CompositionEventHandler<HTMLDivElement>
    onCompositionUpdate?: CompositionEventHandler<HTMLDivElement>
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLDivElement>
    onContextMenu?: MouseEventHandler<HTMLDivElement>
    onContextMenuCapture?: MouseEventHandler<HTMLDivElement>
    onCopy?: ClipboardEventHandler<HTMLDivElement>
    onCopyCapture?: ClipboardEventHandler<HTMLDivElement>
    onCut?: ClipboardEventHandler<HTMLDivElement>
    onCutCapture?: ClipboardEventHandler<HTMLDivElement>
    onDoubleClick?: MouseEventHandler<HTMLDivElement>
    onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>
    onDrag?: DragEventHandler<HTMLDivElement>
    onDragCapture?: DragEventHandler<HTMLDivElement>
    onDragEnd?: DragEventHandler<HTMLDivElement>
    onDragEndCapture?: DragEventHandler<HTMLDivElement>
    onDragEnter?: DragEventHandler<HTMLDivElement>
    onDragEnterCapture?: DragEventHandler<HTMLDivElement>
    onDragExit?: DragEventHandler<HTMLDivElement>
    onDragExitCapture?: DragEventHandler<HTMLDivElement>
    onDragLeave?: DragEventHandler<HTMLDivElement>
    onDragLeaveCapture?: DragEventHandler<HTMLDivElement>
    onDragOver?: DragEventHandler<HTMLDivElement>
    onDragOverCapture?: DragEventHandler<HTMLDivElement>
    onDragStart?: DragEventHandler<HTMLDivElement>
    onDragStartCapture?: DragEventHandler<HTMLDivElement>
    onDrop?: DragEventHandler<HTMLDivElement>
    onDropCapture?: DragEventHandler<HTMLDivElement>
    onDurationChange?: ReactEventHandler<HTMLDivElement>
    onDurationChangeCapture?: ReactEventHandler<HTMLDivElement>
    onEditHeaders?: (value: string) => void

    Type Declaration

      • (value: string): void
      • Invoked when the contents of the request headers editor change.

        Parameters

        • value: string

          The new contents of the editor.

        Returns void

    onEditQuery?: (value: string, documentAST?: DocumentNode) => void

    Type Declaration

      • (value: string, documentAST?: DocumentNode): void
      • Invoked when the contents of the operation editor change.

        Parameters

        • value: string

          The new contents of the editor.

        • OptionaldocumentAST: DocumentNode

          The editor contents parsed into a GraphQL document.

        Returns void

    onEditVariables?: (value: string) => void

    Type Declaration

      • (value: string): void
      • Invoked when the contents of the variables' editor change.

        Parameters

        • value: string

          The new contents of the editor.

        Returns void

    onEmptied?: ReactEventHandler<HTMLDivElement>
    onEmptiedCapture?: ReactEventHandler<HTMLDivElement>
    onEncrypted?: ReactEventHandler<HTMLDivElement>
    onEncryptedCapture?: ReactEventHandler<HTMLDivElement>
    onEnded?: ReactEventHandler<HTMLDivElement>
    onEndedCapture?: ReactEventHandler<HTMLDivElement>
    onError?: ReactEventHandler<HTMLDivElement>
    onErrorCapture?: ReactEventHandler<HTMLDivElement>
    onFocus?: FocusEventHandler<HTMLDivElement>
    onFocusCapture?: FocusEventHandler<HTMLDivElement>
    onGotPointerCapture?: PointerEventHandler<HTMLDivElement>
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>
    onInput?: FormEventHandler<HTMLDivElement>
    onInputCapture?: FormEventHandler<HTMLDivElement>
    onInvalid?: FormEventHandler<HTMLDivElement>
    onInvalidCapture?: FormEventHandler<HTMLDivElement>
    onKeyDown?: KeyboardEventHandler<HTMLDivElement>
    onKeyDownCapture?: KeyboardEventHandler<HTMLDivElement>
    onKeyPress?: KeyboardEventHandler<HTMLDivElement>

    Use onKeyUp or onKeyDown instead

    onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>

    Use onKeyUpCapture or onKeyDownCapture instead

    onKeyUp?: KeyboardEventHandler<HTMLDivElement>
    onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>
    onLoad?: ReactEventHandler<HTMLDivElement>
    onLoadCapture?: ReactEventHandler<HTMLDivElement>
    onLoadedData?: ReactEventHandler<HTMLDivElement>
    onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>
    onLoadedMetadata?: ReactEventHandler<HTMLDivElement>
    onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>
    onLoadStart?: ReactEventHandler<HTMLDivElement>
    onLoadStartCapture?: ReactEventHandler<HTMLDivElement>
    onLostPointerCapture?: PointerEventHandler<HTMLDivElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>
    onMouseDown?: MouseEventHandler<HTMLDivElement>
    onMouseDownCapture?: MouseEventHandler<HTMLDivElement>
    onMouseEnter?: MouseEventHandler<HTMLDivElement>
    onMouseLeave?: MouseEventHandler<HTMLDivElement>
    onMouseMove?: MouseEventHandler<HTMLDivElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>
    onMouseOut?: MouseEventHandler<HTMLDivElement>
    onMouseOutCapture?: MouseEventHandler<HTMLDivElement>
    onMouseOver?: MouseEventHandler<HTMLDivElement>
    onMouseOverCapture?: MouseEventHandler<HTMLDivElement>
    onMouseUp?: MouseEventHandler<HTMLDivElement>
    onMouseUpCapture?: MouseEventHandler<HTMLDivElement>
    onPaste?: ClipboardEventHandler<HTMLDivElement>
    onPasteCapture?: ClipboardEventHandler<HTMLDivElement>
    onPause?: ReactEventHandler<HTMLDivElement>
    onPauseCapture?: ReactEventHandler<HTMLDivElement>
    onPlay?: ReactEventHandler<HTMLDivElement>
    onPlayCapture?: ReactEventHandler<HTMLDivElement>
    onPlaying?: ReactEventHandler<HTMLDivElement>
    onPlayingCapture?: ReactEventHandler<HTMLDivElement>
    onPointerCancel?: PointerEventHandler<HTMLDivElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>
    onPointerDown?: PointerEventHandler<HTMLDivElement>
    onPointerDownCapture?: PointerEventHandler<HTMLDivElement>
    onPointerEnter?: PointerEventHandler<HTMLDivElement>
    onPointerLeave?: PointerEventHandler<HTMLDivElement>
    onPointerMove?: PointerEventHandler<HTMLDivElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>
    onPointerOut?: PointerEventHandler<HTMLDivElement>
    onPointerOutCapture?: PointerEventHandler<HTMLDivElement>
    onPointerOver?: PointerEventHandler<HTMLDivElement>
    onPointerOverCapture?: PointerEventHandler<HTMLDivElement>
    onPointerUp?: PointerEventHandler<HTMLDivElement>
    onPointerUpCapture?: PointerEventHandler<HTMLDivElement>
    onProgress?: ReactEventHandler<HTMLDivElement>
    onProgressCapture?: ReactEventHandler<HTMLDivElement>
    onRateChange?: ReactEventHandler<HTMLDivElement>
    onRateChangeCapture?: ReactEventHandler<HTMLDivElement>
    onReset?: FormEventHandler<HTMLDivElement>
    onResetCapture?: FormEventHandler<HTMLDivElement>
    onResize?: ReactEventHandler<HTMLDivElement>
    onResizeCapture?: ReactEventHandler<HTMLDivElement>
    onScroll?: UIEventHandler<HTMLDivElement>
    onScrollCapture?: UIEventHandler<HTMLDivElement>
    onScrollEnd?: UIEventHandler<HTMLDivElement>
    onScrollEndCapture?: UIEventHandler<HTMLDivElement>
    onSeeked?: ReactEventHandler<HTMLDivElement>
    onSeekedCapture?: ReactEventHandler<HTMLDivElement>
    onSeeking?: ReactEventHandler<HTMLDivElement>
    onSeekingCapture?: ReactEventHandler<HTMLDivElement>
    onSelect?: ReactEventHandler<HTMLDivElement>
    onSelectCapture?: ReactEventHandler<HTMLDivElement>
    onStalled?: ReactEventHandler<HTMLDivElement>
    onStalledCapture?: ReactEventHandler<HTMLDivElement>
    onSubmit?: FormEventHandler<HTMLDivElement>
    onSubmitCapture?: FormEventHandler<HTMLDivElement>
    onSuspend?: ReactEventHandler<HTMLDivElement>
    onSuspendCapture?: ReactEventHandler<HTMLDivElement>
    onTimeUpdate?: ReactEventHandler<HTMLDivElement>
    onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>
    onToggle?: ToggleEventHandler<HTMLDivElement>
    onTouchCancel?: TouchEventHandler<HTMLDivElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>
    onTouchEnd?: TouchEventHandler<HTMLDivElement>
    onTouchEndCapture?: TouchEventHandler<HTMLDivElement>
    onTouchMove?: TouchEventHandler<HTMLDivElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>
    onTouchStart?: TouchEventHandler<HTMLDivElement>
    onTouchStartCapture?: TouchEventHandler<HTMLDivElement>
    onTransitionCancel?: TransitionEventHandler<HTMLDivElement>
    onTransitionCancelCapture?: TransitionEventHandler<HTMLDivElement>
    onTransitionEnd?: TransitionEventHandler<HTMLDivElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>
    onTransitionRun?: TransitionEventHandler<HTMLDivElement>
    onTransitionRunCapture?: TransitionEventHandler<HTMLDivElement>
    onTransitionStart?: TransitionEventHandler<HTMLDivElement>
    onTransitionStartCapture?: TransitionEventHandler<HTMLDivElement>
    onVolumeChange?: ReactEventHandler<HTMLDivElement>
    onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>
    onWaiting?: ReactEventHandler<HTMLDivElement>
    onWaitingCapture?: ReactEventHandler<HTMLDivElement>
    onWheel?: WheelEventHandler<HTMLDivElement>
    onWheelCapture?: WheelEventHandler<HTMLDivElement>
    part?: string
    popover?: "" | "auto" | "manual"
    popoverTarget?: string
    popoverTargetAction?: "toggle" | "show" | "hide"
    prefix?: string
    property?: string
    radioGroup?: string
    rel?: string
    resource?: string
    responseTooltip?: ResponseTooltipType

    Customize the tooltip when hovering over properties in the response editor.

    results?: number
    rev?: string
    role?: AriaRole
    security?: string
    showPersistHeadersSettings?: boolean

    Indicates if settings for persisting headers should appear in the settings modal.

    slot?: string
    spellCheck?: Booleanish
    style?: CSSProperties
    suppressContentEditableWarning?: boolean
    suppressHydrationWarning?: boolean
    tabIndex?: number
    title?: string
    translate?: "yes" | "no"
    typeof?: string
    unselectable?: "off" | "on"
    vocab?: string

    Methods

    • 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 boolean | Promise<boolean>