OptionalaboutOptionalaccessOptionalaria-Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Optionalaria-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.
Optionalaria-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.
Optionalaria-Defines a string value that labels the current element, which is intended to be converted into Braille.
Optionalaria-Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
Optionalaria-Optionalaria-Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
Optionalaria-Defines the total number of columns in a table, grid, or treegrid.
Optionalaria-Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
Optionalaria-Defines a human readable text alternative of aria-colindex.
Optionalaria-Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
Optionalaria-Identifies the element (or elements) whose contents or presence are controlled by the current element.
Optionalaria-Indicates the element that represents the current item within a container or set of related elements.
Optionalaria-Identifies the element (or elements) that describes the object.
Optionalaria-Defines a string value that describes or annotates the current element.
Optionalaria-Identifies the element that provides a detailed, extended description for the object.
Optionalaria-Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Optionalaria-Indicates what functions can be performed when a dragged object is released on the drop target.
Optionalaria-Identifies the element that provides an error message for the object.
Optionalaria-Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Optionalaria-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.
Optionalaria-Indicates an element's "grabbed" state in a drag-and-drop operation.
Optionalaria-Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Optionalaria-Indicates whether the element is exposed to an accessibility API.
Optionalaria-Indicates the entered value does not conform to the format expected by the application.
Optionalaria-Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Optionalaria-Defines a string value that labels the current element.
Optionalaria-Identifies the element (or elements) that labels the current element.
Optionalaria-Defines the hierarchical level of an element within a structure.
Optionalaria-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.
Optionalaria-Indicates whether an element is modal when displayed.
Optionalaria-Indicates whether a text box accepts multiple lines of input or only a single line.
Optionalaria-Indicates that the user may select more than one item from the current selectable descendants.
Optionalaria-Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Optionalaria-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.
Optionalaria-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.
Optionalaria-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.
Optionalaria-Indicates the current "pressed" state of toggle buttons.
Optionalaria-Indicates that the element is not editable, but is otherwise operable.
Optionalaria-Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
Optionalaria-Indicates that user input is required on the element before a form may be submitted.
Optionalaria-Defines a human-readable, author-localized description for the role of an element.
Optionalaria-Defines the total number of rows in a table, grid, or treegrid.
Optionalaria-Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
Optionalaria-Defines a human readable text alternative of aria-rowindex.
Optionalaria-Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
Optionalaria-Indicates the current "selected" state of various widgets.
Optionalaria-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.
Optionalaria-Indicates if items in a table or grid are sorted in ascending or descending order.
Optionalaria-Defines the maximum allowed value for a range widget.
Optionalaria-Defines the minimum allowed value for a range widget.
Optionalaria-Defines the current value for a range widget.
Optionalaria-Defines the human readable text alternative of aria-valuenow for a range widget.
OptionalautoOptionalautoOptionalautoOptionalautoOptionalchildrenOptionalclassAdditional class names which will be appended to the container element.
OptionalcolorOptionalcontentOptionalcontentOptionalcontextOptionaldangerouslyThis prop can be used to skip validating the GraphQL schema. This applies
to both schemas fetched via introspection and schemas explicitly passed
via the schema prop.
IMPORTANT NOTE: Without validating the schema, GraphiQL and its components are vulnerable to numerous exploits and might break. Only use this prop if you have full control over the schema passed to GraphiQL.
OptionaldangerouslyOptionaldatatypeOptionaldefaultOptionaldefaultSet the default state for the editor tools.
false hides the editor toolstrue 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.OptionaldefaultHeaders to be set when opening a new tab.
OptionaldefaultThe initial content of the operation editor when loading GraphiQL and there is
no saved query in storage and no initialQuery prop.
This value is used only for the first tab. Additional tabs will open with an empty operation editor.
OptionaldefaultThis prop can be used to define the default set of tabs, with their queries, variables, and headers. It will be used as default only if there is no tab state persisted in storage.
OptionaldefaultOptionaldefaultOptionaldirOptionaldraggableOptionaleditorSets the color theme for the monaco editors.
OptionalenterOptionalexportpartsOptionalexternalWith this prop you can pass so-called "external" fragments that will be
included in the query document (depending on usage). You can either pass
the fragments using SDL (passing a string) or you can pass a list of
FragmentDefinitionNode objects.
A function which accepts GraphQL HTTP parameters and returns a Promise,
Observable or AsyncIterable that returns the GraphQL response in
parsed JSON format.
We suggest using the createGraphiQLFetcher utility from @graphiql/toolkit
to create these fetcher functions.
OptionalforcedforcedTheme 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.
OptionalgetA function to determine which field leafs are automatically added when
trying to execute a query with missing selection sets. It will be called
with the GraphQLType for which fields need to be added.
OptionalhiddenOptionalidOptionalinertOptionalinitialOptionalinitialOptionalinitialOptionalinlistOptionalinputHints at the type of data that might be entered by the user while editing the element or its contents
OptionalinputCan be used to set the equally named option for introspecting a GraphQL server.
OptionalintrospectionCan be used to set a custom operation name for the introspection query.
OptionalisSpecify that a standard HTML element should behave like a defined custom built-in element
OptionalisToggle if the headers' editor should be shown inside the editor tools.
OptionalitemOptionalitemOptionalitemOptionalitemOptionalitemOptionalkeyOptionallangOptionalmaxThe maximum number of executed operations to store.
OptionalnonceOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonInvoked when the current contents of the operation editor are copied to the clipboard.
The content that has been copied.
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonInvoked when the contents of the request headers editor change.
The new contents of the editor.
OptionalonInvoked when the operation name changes. Possible triggers are:
The operation name after it has been changed.
OptionalonInvoked when the contents of the operation editor change.
The new contents of the editor.
OptionaldocumentAST: DocumentNodeThe editor contents parsed into a GraphQL document.
OptionalonInvoked when the contents of the variables' editor change.
The new contents of the editor.
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonInvoked after a new GraphQL schema was built. This includes both fetching
the schema via introspection and passing the schema using the schema
prop.
The GraphQL schema that is now used for GraphiQL.
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonInvoked when the state of the tabs changes. Possible triggers are:
The tab state after it has been updated.
OptionalonOptionalonOptionalonOptionalonInvoked when the visibility state of any plugin changes.
The plugin object that is now visible. If no plugin
is visible, the function will be invoked with null.
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionaloperationThis prop sets the operation name that is passed with a GraphQL request.
OptionalpartOptionalpluginsThis prop accepts a list of plugins that will be shown in addition to the built-in ones (the doc explorer and the history).
OptionalpopoverOptionalpopoverOptionalpopoverOptionalprefixOptionalpropertyOptionalradioOptionalreferenceThe plugin which is used to display the reference documentation when selecting a type.
Pass null to remove plugin.
OptionalrelOptionalresourceOptionalresponseCustomize the tooltip when hovering over properties in the response editor.
OptionalresultsOptionalrevOptionalroleOptionalschemaExplicitly provide the GraphiQL schema that shall be used for GraphiQL. If this props is...
null, no introspection request will be triggered and
GraphiQL will run without a schema.undefined or not set at all, an introspection request will
be triggered. If this request succeeds, a GraphQL schema will be built
from the returned introspection data, it will be validated, and then
used for GraphiQL if it is valid. If this request fails, GraphiQL will
run without a schema.OptionalschemaCan be used to set the equally named option for introspecting a GraphQL server.
OptionalsecurityOptionalshouldThis prop toggles if the contents of the request headers editor are persisted in storage.
OptionalshowIndicates if settings for persisting headers should appear in the settings modal.
OptionalslotOptionalspellOptionalstorageProvide a custom storage API.
docs for details on the required interface.
OptionalstyleOptionalsuppressOptionalsuppressOptionaltabOptionaltitleOptionaltranslateOptionaltypeofOptionalunselectableOptionalvisibleThis prop can be used to set the visibility state of plugins. Every time
this prop changes, the visibility state will be overridden. Note that the
visibility state can change in between these updates, for example, by
calling the setVisiblePlugin function provided by the context.
OptionalvocabOptionalconfirmWhen 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).
The index of the tab that should be closed.
API docs for this live here:
https://graphiql-test.netlify.app/typedoc/modules/graphiql.html#graphiqlprops